File Manager

Editing File: /usr/local/cpanel/whostmgr/docroot/openapi/cpanel.openapi.html

<!DOCTYPE html>
<html>

<head>
  <meta charset="utf8" />
  <title>cPanel UAPI</title>
  
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <style>
    body {
      padding: 0;
      margin: 0;
    }
  </style>
  <script src="https://cdn.redocly.com/redoc/v2.2.0/bundles/redoc.standalone.js"></script><style data-styled="true" data-styled-version="6.1.13">.jgNMBI{width:calc(100% - 40%);padding:0 24px;}/*!sc*/
@media print,screen and (max-width: 75rem){.jgNMBI{width:100%;padding:24px 24px;}}/*!sc*/
.cREzDu{width:calc(100% - 40%);padding:0 24px;}/*!sc*/
@media print,screen and (max-width: 75rem){.cREzDu{width:100%;padding:0px 24px;}}/*!sc*/
data-styled.g4[id="sc-fAUdSK"]{content:"jgNMBI,cREzDu,"}/*!sc*/
.pDqvn{padding:24px 0;}/*!sc*/
.pDqvn:last-child{min-height:calc(100vh + 1px);}/*!sc*/
.pDqvn>.pDqvn:last-child{min-height:initial;}/*!sc*/
@media print,screen and (max-width: 75rem){.pDqvn{padding:0;}}/*!sc*/
.ceciOs{padding:24px 0;position:relative;}/*!sc*/
.ceciOs:last-child{min-height:calc(100vh + 1px);}/*!sc*/
.ceciOs>.ceciOs:last-child{min-height:initial;}/*!sc*/
@media print,screen and (max-width: 75rem){.ceciOs{padding:0;}}/*!sc*/
.ceciOs:not(:last-of-type):after{position:absolute;bottom:0;width:100%;display:block;content:'';border-bottom:1px solid rgba(0, 0, 0, 0.2);}/*!sc*/
data-styled.g5[id="sc-dntaoT"]{content:"pDqvn,ceciOs,"}/*!sc*/
.bhrdmz{width:40%;color:#ffffff;background-color:#263238;padding:0 24px;}/*!sc*/
@media print,screen and (max-width: 75rem){.bhrdmz{width:100%;padding:24px 24px;}}/*!sc*/
data-styled.g6[id="sc-ivxoEo"]{content:"bhrdmz,"}/*!sc*/
.oECKJ{background-color:#263238;}/*!sc*/
data-styled.g7[id="sc-ghWlax"]{content:"oECKJ,"}/*!sc*/
.dECWTf{display:flex;width:100%;padding:0;}/*!sc*/
@media print,screen and (max-width: 75rem){.dECWTf{flex-direction:column;}}/*!sc*/
data-styled.g8[id="sc-kLhKbu"]{content:"dECWTf,"}/*!sc*/
.itbxeC{font-family:Montserrat Medium,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#333333;}/*!sc*/
data-styled.g9[id="sc-ixGGxD"]{content:"itbxeC,"}/*!sc*/
.dEkAqG{font-family:Montserrat Medium,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;margin:0 0 20px;}/*!sc*/
data-styled.g10[id="sc-khLCKb"]{content:"dEkAqG,"}/*!sc*/
.zvQzH{color:#ffffff;}/*!sc*/
data-styled.g12[id="sc-keTIit"]{content:"zvQzH,"}/*!sc*/
.eJAAZj{border-bottom:1px solid rgba(38, 50, 56, 0.3);margin:1em 0 1em 0;color:rgba(38, 50, 56, 0.5);font-weight:normal;text-transform:uppercase;font-size:0.929em;line-height:20px;}/*!sc*/
data-styled.g13[id="sc-dpBQxM"]{content:"eJAAZj,"}/*!sc*/
.hbTOAm{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
.hbTOAm:before{content:'';width:15px;height:15px;background-size:contain;background-image:url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');opacity:0.5;visibility:hidden;display:inline-block;vertical-align:middle;}/*!sc*/
h1:hover>.hbTOAm::before,h2:hover>.hbTOAm::before,.hbTOAm:hover::before{visibility:visible;}/*!sc*/
data-styled.g14[id="sc-jwIPbr"]{content:"hbTOAm,"}/*!sc*/
.gkUOTk{height:18px;width:18px;min-width:18px;vertical-align:middle;float:right;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
.bEpxpV{height:1.3em;width:1.3em;min-width:1.3em;vertical-align:middle;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
.ibfcMM{height:1.5em;width:1.5em;min-width:1.5em;vertical-align:middle;float:left;transition:transform 0.2s ease-out;transform:rotateZ(0);}/*!sc*/
.ibfcMM polygon{fill:#85B655;}/*!sc*/
.ccTkAM{height:18px;width:18px;min-width:18px;vertical-align:middle;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
.fmmJjS{height:20px;width:20px;min-width:20px;vertical-align:middle;float:right;transition:transform 0.2s ease-out;transform:rotateZ(0);}/*!sc*/
.fmmJjS polygon{fill:white;}/*!sc*/
data-styled.g15[id="sc-cHqXqK"]{content:"gkUOTk,bEpxpV,ibfcMM,ccTkAM,fmmJjS,"}/*!sc*/
.jmDXKf{display:inline-block;padding:2px 8px;margin:0;background-color:#ffa500;color:#ffffff;font-size:13px;vertical-align:middle;line-height:1.6;border-radius:4px;font-weight:600;font-size:12px;}/*!sc*/
.jmDXKf +span[type]{margin-left:4px;}/*!sc*/
data-styled.g16[id="sc-jtQUzJ"]{content:"jmDXKf,"}/*!sc*/
.dEkioI{border-left:1px solid #808080;box-sizing:border-box;position:relative;padding:10px 10px 10px 0;}/*!sc*/
@media screen and (max-width: 50rem){.dEkioI{display:block;overflow:hidden;}}/*!sc*/
tr:first-of-type>.dEkioI,tr.last>.dEkioI{border-left-width:0;background-position:top left;background-repeat:no-repeat;background-size:1px 100%;}/*!sc*/
tr:first-of-type>.dEkioI{background-image:linear-gradient(
      to bottom,
      transparent 0%,
      transparent 22px,
      #808080 22px,
      #808080 100%
    );}/*!sc*/
tr.last>.dEkioI{background-image:linear-gradient(
      to bottom,
      #808080 0%,
      #808080 22px,
      transparent 22px,
      transparent 100%
    );}/*!sc*/
tr.last+tr>.dEkioI{border-left-color:transparent;}/*!sc*/
tr.last:first-child>.dEkioI{background:none;border-left-color:transparent;}/*!sc*/
data-styled.g18[id="sc-ovuCP"]{content:"dEkioI,"}/*!sc*/
.iQpMVv{vertical-align:top;line-height:20px;white-space:nowrap;font-size:13px;font-family:Courier,monospace;}/*!sc*/
.iQpMVv.deprecated{text-decoration:line-through;color:#707070;}/*!sc*/
data-styled.g20[id="sc-eauhAA"]{content:"iQpMVv,"}/*!sc*/
.dYBdBR{border-bottom:1px solid #9fb4be;padding:10px 0;width:75%;box-sizing:border-box;}/*!sc*/
tr.expanded .dYBdBR{border-bottom:none;}/*!sc*/
@media screen and (max-width: 50rem){.dYBdBR{padding:0 20px;border-bottom:none;border-left:1px solid #808080;}tr.last>.dYBdBR{border-left:none;}}/*!sc*/
data-styled.g21[id="sc-fFoeYl"]{content:"dYBdBR,"}/*!sc*/
.eDMLOa{color:#808080;font-family:Courier,monospace;margin-right:10px;}/*!sc*/
.eDMLOa::before{content:'';display:inline-block;vertical-align:middle;width:10px;height:1px;background:#808080;}/*!sc*/
.eDMLOa::after{content:'';display:inline-block;vertical-align:middle;width:1px;background:#808080;height:7px;}/*!sc*/
data-styled.g22[id="sc-gQaihK"]{content:"eDMLOa,"}/*!sc*/
.hNmabw{border-collapse:separate;border-radius:3px;font-size:16px;border-spacing:0;width:100%;}/*!sc*/
.hNmabw >tr{vertical-align:middle;}/*!sc*/
@media screen and (max-width: 50rem){.hNmabw{display:block;}.hNmabw >tr,.hNmabw >tbody>tr{display:block;}}/*!sc*/
@media screen and (max-width: 50rem) and (-ms-high-contrast:none){.hNmabw td{float:left;width:100%;}}/*!sc*/
.hNmabw .sc-iuUfFv,.hNmabw .sc-iuUfFv .sc-iuUfFv .sc-iuUfFv,.hNmabw .sc-iuUfFv .sc-iuUfFv .sc-iuUfFv .sc-iuUfFv .sc-iuUfFv{margin:1em;margin-right:0;background:#fafafa;}/*!sc*/
.hNmabw .sc-iuUfFv .sc-iuUfFv,.hNmabw .sc-iuUfFv .sc-iuUfFv .sc-iuUfFv .sc-iuUfFv,.hNmabw .sc-iuUfFv .sc-iuUfFv .sc-iuUfFv .sc-iuUfFv .sc-iuUfFv .sc-iuUfFv{background:#ffffff;}/*!sc*/
data-styled.g24[id="sc-dprtRQ"]{content:"hNmabw,"}/*!sc*/
.jsZdmN >ul{list-style:none;padding:0;margin:0;margin:0 -5px;}/*!sc*/
.jsZdmN >ul >li{padding:5px 10px;display:inline-block;background-color:#11171a;border-bottom:1px solid rgba(0, 0, 0, 0.5);cursor:pointer;text-align:center;outline:none;color:#808080;margin:0 3px 3px 3px;border:1px solid #07090b;border-radius:5px;min-width:60px;font-size:0.9em;font-weight:bold;}/*!sc*/
.jsZdmN >ul >li.react-tabs__tab--selected{color:#333333;background:#ffffff;}/*!sc*/
.jsZdmN >ul >li.react-tabs__tab--selected:focus{outline:auto;}/*!sc*/
.jsZdmN >ul >li:only-child{flex:none;min-width:100px;}/*!sc*/
.jsZdmN >ul >li.tab-success{color:#85B655;}/*!sc*/
.jsZdmN >ul >li.tab-redirect{color:#ffa500;}/*!sc*/
.jsZdmN >ul >li.tab-info{color:#87ceeb;}/*!sc*/
.jsZdmN >ul >li.tab-error{color:#d41f1c;}/*!sc*/
.jsZdmN >.react-tabs__tab-panel{background:#11171a;}/*!sc*/
.jsZdmN >.react-tabs__tab-panel>div,.jsZdmN >.react-tabs__tab-panel>pre{padding:12px;margin:0;}/*!sc*/
.jsZdmN >.react-tabs__tab-panel>div>pre{padding:0;}/*!sc*/
data-styled.g30[id="sc-bMTdWJ"]{content:"jsZdmN,"}/*!sc*/
.drsioI code[class*='language-'],.drsioI pre[class*='language-']{text-shadow:0 -0.1em 0.2em black;text-align:left;white-space:pre;word-spacing:normal;word-break:normal;word-wrap:normal;line-height:1.5;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-hyphens:none;-moz-hyphens:none;-ms-hyphens:none;hyphens:none;}/*!sc*/
@media print{.drsioI code[class*='language-'],.drsioI pre[class*='language-']{text-shadow:none;}}/*!sc*/
.drsioI pre[class*='language-']{padding:1em;margin:0.5em 0;overflow:auto;}/*!sc*/
.drsioI .token.comment,.drsioI .token.prolog,.drsioI .token.doctype,.drsioI .token.cdata{color:hsl(30, 20%, 50%);}/*!sc*/
.drsioI .token.punctuation{opacity:0.7;}/*!sc*/
.drsioI .namespace{opacity:0.7;}/*!sc*/
.drsioI .token.property,.drsioI .token.tag,.drsioI .token.number,.drsioI .token.constant,.drsioI .token.symbol{color:#4a8bb3;}/*!sc*/
.drsioI .token.boolean{color:#e64441;}/*!sc*/
.drsioI .token.selector,.drsioI .token.attr-name,.drsioI .token.string,.drsioI .token.char,.drsioI .token.builtin,.drsioI .token.inserted{color:#a0fbaa;}/*!sc*/
.drsioI .token.selector+a,.drsioI .token.attr-name+a,.drsioI .token.string+a,.drsioI .token.char+a,.drsioI .token.builtin+a,.drsioI .token.inserted+a,.drsioI .token.selector+a:visited,.drsioI .token.attr-name+a:visited,.drsioI .token.string+a:visited,.drsioI .token.char+a:visited,.drsioI .token.builtin+a:visited,.drsioI .token.inserted+a:visited{color:#4ed2ba;text-decoration:underline;}/*!sc*/
.drsioI .token.property.string{color:white;}/*!sc*/
.drsioI .token.operator,.drsioI .token.entity,.drsioI .token.url,.drsioI .token.variable{color:hsl(40, 90%, 60%);}/*!sc*/
.drsioI .token.atrule,.drsioI .token.attr-value,.drsioI .token.keyword{color:hsl(350, 40%, 70%);}/*!sc*/
.drsioI .token.regex,.drsioI .token.important{color:#e90;}/*!sc*/
.drsioI .token.important,.drsioI .token.bold{font-weight:bold;}/*!sc*/
.drsioI .token.italic{font-style:italic;}/*!sc*/
.drsioI .token.entity{cursor:help;}/*!sc*/
.drsioI .token.deleted{color:red;}/*!sc*/
data-styled.g32[id="sc-epnzzT"]{content:"drsioI,"}/*!sc*/
.hSmBqZ{opacity:0.7;transition:opacity 0.3s ease;text-align:right;}/*!sc*/
.hSmBqZ:focus-within{opacity:1;}/*!sc*/
.hSmBqZ >button{background-color:transparent;border:0;color:inherit;padding:2px 10px;font-family:Open Sans Light,open sans,sans-serif;font-size:16px;line-height:1.5em;cursor:pointer;outline:0;}/*!sc*/
.hSmBqZ >button :hover,.hSmBqZ >button :focus{background:rgba(255, 255, 255, 0.1);}/*!sc*/
data-styled.g33[id="sc-uYFMi"]{content:"hSmBqZ,"}/*!sc*/
.jdzthf:hover .sc-uYFMi{opacity:1;}/*!sc*/
data-styled.g34[id="sc-bbQqnZ"]{content:"jdzthf,"}/*!sc*/
.geKqvs{font-family:Courier,monospace;font-size:13px;overflow-x:auto;margin:0;white-space:pre;}/*!sc*/
data-styled.g35[id="sc-iwXfZk"]{content:"geKqvs,"}/*!sc*/
.JXohG{position:absolute;pointer-events:none;z-index:1;top:50%;-webkit-transform:translateY(-50%);-ms-transform:translateY(-50%);transform:translateY(-50%);right:8px;margin:auto;text-align:center;}/*!sc*/
.JXohG polyline{color:white;}/*!sc*/
data-styled.g38[id="sc-kZrBCu"]{content:"JXohG,"}/*!sc*/
.jsRqjj{box-sizing:border-box;min-width:100px;outline:none;display:inline-block;border-radius:2px;border:1px solid rgba(38, 50, 56, 0.5);vertical-align:bottom;padding:2px 0px 2px 6px;position:relative;width:auto;background:white;color:#263238;font-family:Montserrat Medium,sans-serif;font-size:0.929em;line-height:1.5em;cursor:pointer;transition:border 0.25s ease,color 0.25s ease,box-shadow 0.25s ease;}/*!sc*/
.jsRqjj label{box-sizing:border-box;min-width:100px;outline:none;display:inline-block;font-family:Montserrat Medium,sans-serif;color:#333333;vertical-align:bottom;width:auto;text-transform:none;padding:0 22px 0 4px;font-size:0.929em;line-height:1.5em;font-family:inherit;text-overflow:ellipsis;overflow:hidden;white-space:nowrap;}/*!sc*/
.jsRqjj .dropdown-select{position:absolute;top:0;left:0;width:100%;height:100%;opacity:0;border:none;appearance:none;cursor:pointer;color:#333333;line-height:inherit;font-family:inherit;}/*!sc*/
.jsRqjj:hover,.jsRqjj:focus-within{border:1px solid black;color:black;box-shadow:0px 0px 0px 1px black;}/*!sc*/
data-styled.g39[id="sc-diYFot"]{content:"jsRqjj,"}/*!sc*/
.khtVmz{margin-left:10px;text-transform:none;font-size:0.929em;color:black;}/*!sc*/
data-styled.g41[id="sc-dhCplO"]{content:"khtVmz,"}/*!sc*/
.fPWJlx{font-family:Open Sans Light,open sans,sans-serif;font-weight:400;line-height:1.5em;}/*!sc*/
.fPWJlx p:last-child{margin-bottom:0;}/*!sc*/
.fPWJlx h1{font-family:Montserrat Medium,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:black;margin-top:0;}/*!sc*/
.fPWJlx h2{font-family:Montserrat Medium,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;}/*!sc*/
.fPWJlx code{color:#e53935;background-color:rgba(38, 50, 56, 0.05);font-family:Courier,monospace;border-radius:2px;border:1px solid rgba(38, 50, 56, 0.1);padding:0 3px;font-size:13px;font-weight:400;word-break:break-word;}/*!sc*/
.fPWJlx pre{font-family:Courier,monospace;white-space:pre;background-color:#11171a;color:white;padding:12px;overflow-x:auto;line-height:normal;border-radius:0;border:1px solid rgba(38, 50, 56, 0.1);}/*!sc*/
.fPWJlx pre code{background-color:transparent;color:white;padding:0;}/*!sc*/
.fPWJlx pre code:before,.fPWJlx pre code:after{content:none;}/*!sc*/
.fPWJlx blockquote{margin:0;margin-bottom:1em;padding:0 15px;color:#777;border-left:4px solid #ddd;}/*!sc*/
.fPWJlx img{max-width:100%;box-sizing:content-box;}/*!sc*/
.fPWJlx ul,.fPWJlx ol{padding-left:2em;margin:0;margin-bottom:1em;}/*!sc*/
.fPWJlx ul ul,.fPWJlx ol ul,.fPWJlx ul ol,.fPWJlx ol ol{margin-bottom:0;margin-top:0;}/*!sc*/
.fPWJlx table{display:block;width:100%;overflow:auto;word-break:normal;word-break:keep-all;border-collapse:collapse;border-spacing:0;margin-top:1.5em;margin-bottom:1.5em;}/*!sc*/
.fPWJlx table tr{background-color:#fff;border-top:1px solid #ccc;}/*!sc*/
.fPWJlx table tr:nth-child(2n){background-color:#fafafa;}/*!sc*/
.fPWJlx table th,.fPWJlx table td{padding:6px 13px;border:1px solid #ddd;}/*!sc*/
.fPWJlx table th{text-align:left;font-weight:bold;}/*!sc*/
.fPWJlx .share-link{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
.fPWJlx .share-link:before{content:'';width:15px;height:15px;background-size:contain;background-image:url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');opacity:0.5;visibility:hidden;display:inline-block;vertical-align:middle;}/*!sc*/
.fPWJlx h1:hover>.share-link::before,.fPWJlx h2:hover>.share-link::before,.fPWJlx .share-link:hover::before{visibility:visible;}/*!sc*/
.fPWJlx a{text-decoration:auto;color:black;}/*!sc*/
.fPWJlx a:visited{color:black;}/*!sc*/
.fPWJlx a:hover{color:#333;text-decoration:auto;}/*!sc*/
.liva-Dz{font-family:Open Sans Light,open sans,sans-serif;font-weight:400;line-height:1.5em;}/*!sc*/
.liva-Dz p:last-child{margin-bottom:0;}/*!sc*/
.liva-Dz p:first-child{margin-top:0;}/*!sc*/
.liva-Dz p:last-child{margin-bottom:0;}/*!sc*/
.liva-Dz h1{font-family:Montserrat Medium,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:black;margin-top:0;}/*!sc*/
.liva-Dz h2{font-family:Montserrat Medium,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;}/*!sc*/
.liva-Dz code{color:#e53935;background-color:rgba(38, 50, 56, 0.05);font-family:Courier,monospace;border-radius:2px;border:1px solid rgba(38, 50, 56, 0.1);padding:0 3px;font-size:13px;font-weight:400;word-break:break-word;}/*!sc*/
.liva-Dz pre{font-family:Courier,monospace;white-space:pre;background-color:#11171a;color:white;padding:12px;overflow-x:auto;line-height:normal;border-radius:0;border:1px solid rgba(38, 50, 56, 0.1);}/*!sc*/
.liva-Dz pre code{background-color:transparent;color:white;padding:0;}/*!sc*/
.liva-Dz pre code:before,.liva-Dz pre code:after{content:none;}/*!sc*/
.liva-Dz blockquote{margin:0;margin-bottom:1em;padding:0 15px;color:#777;border-left:4px solid #ddd;}/*!sc*/
.liva-Dz img{max-width:100%;box-sizing:content-box;}/*!sc*/
.liva-Dz ul,.liva-Dz ol{padding-left:2em;margin:0;margin-bottom:1em;}/*!sc*/
.liva-Dz ul ul,.liva-Dz ol ul,.liva-Dz ul ol,.liva-Dz ol ol{margin-bottom:0;margin-top:0;}/*!sc*/
.liva-Dz table{display:block;width:100%;overflow:auto;word-break:normal;word-break:keep-all;border-collapse:collapse;border-spacing:0;margin-top:1.5em;margin-bottom:1.5em;}/*!sc*/
.liva-Dz table tr{background-color:#fff;border-top:1px solid #ccc;}/*!sc*/
.liva-Dz table tr:nth-child(2n){background-color:#fafafa;}/*!sc*/
.liva-Dz table th,.liva-Dz table td{padding:6px 13px;border:1px solid #ddd;}/*!sc*/
.liva-Dz table th{text-align:left;font-weight:bold;}/*!sc*/
.liva-Dz .share-link{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
.liva-Dz .share-link:before{content:'';width:15px;height:15px;background-size:contain;background-image:url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');opacity:0.5;visibility:hidden;display:inline-block;vertical-align:middle;}/*!sc*/
.liva-Dz h1:hover>.share-link::before,.liva-Dz h2:hover>.share-link::before,.liva-Dz .share-link:hover::before{visibility:visible;}/*!sc*/
.liva-Dz a{text-decoration:auto;color:black;}/*!sc*/
.liva-Dz a:visited{color:black;}/*!sc*/
.liva-Dz a:hover{color:#333;text-decoration:auto;}/*!sc*/
data-styled.g42[id="sc-eMwmJz"]{content:"fPWJlx,liva-Dz,"}/*!sc*/
.jtjIAv{display:inline;}/*!sc*/
data-styled.g43[id="sc-drVZOg"]{content:"jtjIAv,"}/*!sc*/
.ezdXRP{position:relative;}/*!sc*/
data-styled.g44[id="sc-eWPXlR"]{content:"ezdXRP,"}/*!sc*/
.mMhCU:hover>.sc-uYFMi{opacity:1;}/*!sc*/
data-styled.g49[id="sc-eDHQDy"]{content:"mMhCU,"}/*!sc*/
.iyEpFV{font-family:Courier,monospace;font-size:13px;white-space:pre;contain:content;overflow-x:auto;}/*!sc*/
.iyEpFV .redoc-json code>.collapser{display:none;pointer-events:none;}/*!sc*/
.iyEpFV .callback-function{color:gray;}/*!sc*/
.iyEpFV .collapser:after{content:'-';cursor:pointer;}/*!sc*/
.iyEpFV .collapsed>.collapser:after{content:'+';cursor:pointer;}/*!sc*/
.iyEpFV .ellipsis:after{content:' … ';}/*!sc*/
.iyEpFV .collapsible{margin-left:2em;}/*!sc*/
.iyEpFV .hoverable{padding-top:1px;padding-bottom:1px;padding-left:2px;padding-right:2px;border-radius:2px;}/*!sc*/
.iyEpFV .hovered{background-color:rgba(235, 238, 249, 1);}/*!sc*/
.iyEpFV .collapser{background-color:transparent;border:0;color:#fff;font-family:Courier,monospace;font-size:13px;padding-right:6px;padding-left:6px;padding-top:0;padding-bottom:0;display:flex;align-items:center;justify-content:center;width:15px;height:15px;position:absolute;top:4px;left:-1.5em;cursor:default;user-select:none;-webkit-user-select:none;padding:2px;}/*!sc*/
.iyEpFV .collapser:focus{outline-color:#fff;outline-style:dotted;outline-width:1px;}/*!sc*/
.iyEpFV ul{list-style-type:none;padding:0px;margin:0px 0px 0px 26px;}/*!sc*/
.iyEpFV li{position:relative;display:block;}/*!sc*/
.iyEpFV .hoverable{display:inline-block;}/*!sc*/
.iyEpFV .selected{outline-style:solid;outline-width:1px;outline-style:dotted;}/*!sc*/
.iyEpFV .collapsed>.collapsible{display:none;}/*!sc*/
.iyEpFV .ellipsis{display:none;}/*!sc*/
.iyEpFV .collapsed>.ellipsis{display:inherit;}/*!sc*/
data-styled.g50[id="sc-giBObj"]{content:"iyEpFV,"}/*!sc*/
.bOGonZ{padding:0.9em;background-color:rgba(38,50,56,0.4);margin:0 0 10px 0;display:block;font-family:Montserrat Medium,sans-serif;font-size:0.929em;line-height:1.5em;}/*!sc*/
data-styled.g51[id="sc-UblHX"]{content:"bOGonZ,"}/*!sc*/
.kjhUaT{font-family:Montserrat Medium,sans-serif;font-size:12px;position:absolute;z-index:1;top:-11px;left:12px;font-weight:600;color:rgba(255,255,255,0.7);}/*!sc*/
data-styled.g52[id="sc-fufdwm"]{content:"kjhUaT,"}/*!sc*/
.dIDLbO{position:relative;}/*!sc*/
data-styled.g53[id="sc-Rjrgp"]{content:"dIDLbO,"}/*!sc*/
.esCYIP{margin:0 0 10px 0;display:block;background-color:rgba(38,50,56,0.4);border:none;padding:0.9em 1.6em 0.9em 0.9em;box-shadow:none;}/*!sc*/
.esCYIP label{color:#ffffff;text-overflow:ellipsis;white-space:nowrap;overflow:hidden;font-size:1em;text-transform:none;border:none;}/*!sc*/
.esCYIP:hover,.esCYIP:focus-within{border:none;box-shadow:none;background-color:rgba(38,50,56,0.7);}/*!sc*/
data-styled.g54[id="sc-frniUE"]{content:"esCYIP,"}/*!sc*/
.kqHNPM{margin-top:15px;}/*!sc*/
data-styled.g56[id="sc-FFETS"]{content:"kqHNPM,"}/*!sc*/
.wPtbb.deprecated span.property-name{text-decoration:line-through;color:#707070;}/*!sc*/
.wPtbb button{background-color:transparent;border:0;outline:0;font-size:13px;font-family:Courier,monospace;cursor:pointer;padding:0;color:#333333;}/*!sc*/
.wPtbb button:focus{font-weight:600;}/*!sc*/
.wPtbb .sc-cHqXqK{height:1.1em;width:1.1em;}/*!sc*/
.wPtbb .sc-cHqXqK polygon{fill:#b3b3b3;}/*!sc*/
data-styled.g57[id="sc-hsfCcR"]{content:"wPtbb,"}/*!sc*/
.hPAOR{vertical-align:middle;font-size:13px;line-height:20px;}/*!sc*/
data-styled.g58[id="sc-CNKsk"]{content:"hPAOR,"}/*!sc*/
.gjyOxn{color:rgba(179,179,179,0.9);}/*!sc*/
data-styled.g59[id="sc-cqgMZH"]{content:"gjyOxn,"}/*!sc*/
.jHGfFh{color:#b3b3b3;}/*!sc*/
data-styled.g60[id="sc-gQkENW"]{content:"jHGfFh,"}/*!sc*/
.feFoaC{color:#d41f1c;font-size:0.9em;font-weight:normal;margin-left:20px;line-height:1;}/*!sc*/
data-styled.g62[id="sc-hGZxvd"]{content:"feFoaC,"}/*!sc*/
.jSTDDl{border-radius:2px;word-break:break-word;background-color:rgba(51,51,51,0.05);color:rgba(51,51,51,0.9);padding:0 3px;border:1px solid rgba(51,51,51,0.1);font-family:Courier,monospace;}/*!sc*/
+{margin-left:0;}/*!sc*/
data-styled.g66[id="sc-cSzYSJ"]{content:"jSTDDl,"}/*!sc*/
.dSZMEh{border-radius:2px;background-color:rgba(128,128,128,0.05);color:rgba(0,0,0,0.9);margin:0 3px;padding:0 3px;border:1px solid rgba(0,0,0,0.1);}/*!sc*/
+{margin-left:0;}/*!sc*/
data-styled.g68[id="sc-fIfZzT"]{content:"dSZMEh,"}/*!sc*/
.gfjLjc{margin:1em 0;}/*!sc*/
.gfjLjc a{text-decoration:auto;color:black;}/*!sc*/
.gfjLjc a:visited{color:black;}/*!sc*/
.gfjLjc a:hover{color:#333;text-decoration:auto;}/*!sc*/
data-styled.g70[id="sc-jdeYMN"]{content:"gfjLjc,"}/*!sc*/
.bJXdVn{margin-top:1em;list-style-position:outside;}/*!sc*/
data-styled.g73[id="sc-gqYRWL"]{content:"bJXdVn,"}/*!sc*/
.kpFoWb{margin:0 5px;vertical-align:text-top;}/*!sc*/
data-styled.g74[id="sc-cwJYja"]{content:"kpFoWb,"}/*!sc*/
.eEDpaQ:after{content:' and ';font-weight:normal;}/*!sc*/
.eEDpaQ:last-child:after{content:none;}/*!sc*/
.eEDpaQ a{text-decoration:auto;color:black;}/*!sc*/
.eEDpaQ a:visited{color:black;}/*!sc*/
.eEDpaQ a:hover{color:#333;text-decoration:auto;}/*!sc*/
data-styled.g80[id="sc-bqvdXA"]{content:"eEDpaQ,"}/*!sc*/
.gezKts{white-space:nowrap;}/*!sc*/
.gezKts:after{content:' or ';white-space:pre;}/*!sc*/
.gezKts:last-child:after,.gezKts:only-child:after{content:none;}/*!sc*/
.gezKts a{text-decoration:auto;color:black;}/*!sc*/
.gezKts a:visited{color:black;}/*!sc*/
.gezKts a:hover{color:#333;text-decoration:auto;}/*!sc*/
data-styled.g81[id="sc-irPVuy"]{content:"gezKts,"}/*!sc*/
.jXOga-d{flex:1 1 auto;cursor:pointer;}/*!sc*/
data-styled.g82[id="sc-jWJSSj"]{content:"jXOga-d,"}/*!sc*/
.gQOXJB{width:75%;text-overflow:ellipsis;border-radius:4px;overflow:hidden;}/*!sc*/
@media screen and (max-width: 50rem){.gQOXJB{margin-top:10px;}}/*!sc*/
data-styled.g83[id="sc-iCjFWQ"]{content:"gQOXJB,"}/*!sc*/
.ffSXYc{display:inline-block;margin:0;}/*!sc*/
data-styled.g84[id="sc-khdDuB"]{content:"ffSXYc,"}/*!sc*/
.dyzdIR{width:100%;display:flex;margin:1em 0;flex-direction:row;}/*!sc*/
@media screen and (max-width: 50rem){.dyzdIR{flex-direction:column;}}/*!sc*/
data-styled.g85[id="sc-hGNhLO"]{content:"dyzdIR,"}/*!sc*/
.dZsYqS{margin-top:0;margin-bottom:0.5em;}/*!sc*/
data-styled.g91[id="sc-geoRQH"]{content:"dZsYqS,"}/*!sc*/
.bcPxPq::before{content:'|';display:inline-block;opacity:0.5;width:15px;text-align:center;}/*!sc*/
.bcPxPq:last-child::after{display:none;}/*!sc*/
data-styled.g93[id="sc-gbwXoZ"]{content:"bcPxPq,"}/*!sc*/
.gmEXff{overflow:hidden;}/*!sc*/
data-styled.g94[id="sc-kBAPdo"]{content:"gmEXff,"}/*!sc*/
.eeVPfW{display:flex;flex-wrap:wrap;margin-left:-15px;}/*!sc*/
data-styled.g95[id="sc-ftmehX"]{content:"eeVPfW,"}/*!sc*/
.klJCEr{max-height:260px;max-width:260px;padding:10px;width:100%;display:block;}/*!sc*/
data-styled.g96[id="sc-jTpVWm"]{content:"klJCEr,"}/*!sc*/
.dzdmjb{text-align:center;}/*!sc*/
data-styled.g97[id="sc-fqujGp"]{content:"dzdmjb,"}/*!sc*/
.iYFQel{display:inline-block;}/*!sc*/
data-styled.g98[id="sc-jQybuE"]{content:"iYFQel,"}/*!sc*/
.gjWqYY{width:9ex;display:inline-block;height:13px;line-height:13px;background-color:#333;border-radius:3px;background-repeat:no-repeat;background-position:6px 4px;font-size:7px;font-family:Verdana,sans-serif;color:white;text-transform:uppercase;text-align:center;font-weight:bold;vertical-align:middle;margin-right:6px;margin-top:2px;}/*!sc*/
.gjWqYY.get{background-color:#85B655;}/*!sc*/
.gjWqYY.post{background-color:#179BD7;}/*!sc*/
.gjWqYY.put{background-color:#95507c;}/*!sc*/
.gjWqYY.options{background-color:#947014;}/*!sc*/
.gjWqYY.patch{background-color:#bf581d;}/*!sc*/
.gjWqYY.delete{background-color:#cc3333;}/*!sc*/
.gjWqYY.basic{background-color:#707070;}/*!sc*/
.gjWqYY.link{background-color:#07818F;}/*!sc*/
.gjWqYY.head{background-color:#A23DAD;}/*!sc*/
.gjWqYY.hook{background-color:black;}/*!sc*/
.gjWqYY.schema{background-color:#707070;}/*!sc*/
data-styled.g99[id="sc-erSfwj"]{content:"gjWqYY,"}/*!sc*/
.dXwhdL{margin:0;padding:0;}/*!sc*/
.dXwhdL:first-child{padding-bottom:32px;}/*!sc*/
.sc-iRVXky .sc-iRVXky{font-size:0.929em;}/*!sc*/
.kUyAbS{margin:0;padding:0;display:none;}/*!sc*/
.kUyAbS:first-child{padding-bottom:32px;}/*!sc*/
.sc-iRVXky .sc-iRVXky{font-size:0.929em;}/*!sc*/
data-styled.g100[id="sc-iRVXky"]{content:"dXwhdL,kUyAbS,"}/*!sc*/
.ghRwPP{list-style:none inside none;overflow:hidden;text-overflow:ellipsis;padding:0;margin-top:15px;}/*!sc*/
.gSwPLF{list-style:none inside none;overflow:hidden;text-overflow:ellipsis;padding:0;}/*!sc*/
data-styled.g101[id="sc-ljhlHD"]{content:"ghRwPP,gSwPLF,"}/*!sc*/
.dyrMKZ{cursor:pointer;color:#333333;margin:0;padding:12.5px 12px;display:flex;justify-content:space-between;font-family:Montserrat Medium,sans-serif;opacity:0.7;text-transform:uppercase;font-size:0.8em;padding-bottom:0;cursor:default;background-color:#fafafa;}/*!sc*/
.dyrMKZ .sc-cHqXqK{height:1.5em;width:1.5em;}/*!sc*/
.dyrMKZ .sc-cHqXqK polygon{fill:#333333;}/*!sc*/
.blqVXy{cursor:pointer;color:#333333;margin:0;padding:12.5px 12px;display:flex;justify-content:space-between;font-family:Montserrat Medium,sans-serif;font-size:0.929em;text-transform:none;background-color:#fafafa;}/*!sc*/
.blqVXy:hover{color:black;background-color:#e1e1e1;}/*!sc*/
.blqVXy .sc-cHqXqK{height:1.5em;width:1.5em;}/*!sc*/
.blqVXy .sc-cHqXqK polygon{fill:#333333;}/*!sc*/
.fzIOJo{cursor:pointer;color:#333333;margin:0;padding:12.5px 12px;display:flex;justify-content:space-between;font-family:Montserrat Medium,sans-serif;background-color:#fafafa;}/*!sc*/
.fzIOJo:hover{color:black;background-color:#ededed;}/*!sc*/
.fzIOJo .sc-cHqXqK{height:1.5em;width:1.5em;}/*!sc*/
.fzIOJo .sc-cHqXqK polygon{fill:#333333;}/*!sc*/
.iVGbgR{cursor:pointer;color:#333333;margin:0;padding:12.5px 12px;display:flex;justify-content:space-between;font-family:Montserrat Medium,sans-serif;background-color:#fafafa;text-decoration:line-through;color:#707070;}/*!sc*/
.iVGbgR:hover{color:black;background-color:#ededed;}/*!sc*/
.iVGbgR .sc-cHqXqK{height:1.5em;width:1.5em;}/*!sc*/
.iVGbgR .sc-cHqXqK polygon{fill:#333333;}/*!sc*/
data-styled.g102[id="sc-bAEjGW"]{content:"dyrMKZ,blqVXy,fzIOJo,iVGbgR,"}/*!sc*/
.bBONey{display:inline-block;vertical-align:middle;width:calc(100% - 38px);overflow:hidden;text-overflow:ellipsis;}/*!sc*/
data-styled.g103[id="sc-enMaOJ"]{content:"bBONey,"}/*!sc*/
.gFEWWY{font-size:0.8em;margin-top:6px;text-align:center;position:fixed;width:260px;bottom:0;background:#fafafa;}/*!sc*/
.gFEWWY a,.gFEWWY a:visited,.gFEWWY a:hover{color:#333333!important;padding:3px 0;border-top:1px solid #e1e1e1;text-decoration:none;display:flex;align-items:center;justify-content:center;}/*!sc*/
.gFEWWY img{width:15px;margin-right:5px;}/*!sc*/
@media screen and (max-width: 50rem){.gFEWWY{width:100%;}}/*!sc*/
data-styled.g104[id="sc-fUEImY"]{content:"gFEWWY,"}/*!sc*/
.dWZoid{cursor:pointer;position:relative;margin-bottom:5px;}/*!sc*/
data-styled.g110[id="sc-duWCru"]{content:"dWZoid,"}/*!sc*/
.iqHzp{font-family:Courier,monospace;margin-left:10px;flex:1;overflow-x:hidden;text-overflow:ellipsis;}/*!sc*/
data-styled.g111[id="sc-etPtWW"]{content:"iqHzp,"}/*!sc*/
.ebcgbH{outline:0;color:inherit;width:100%;text-align:left;cursor:pointer;padding:10px 30px 10px 20px;border-radius:4px 4px 0 0;background-color:#11171a;display:flex;white-space:nowrap;align-items:center;border:1px solid transparent;border-bottom:0;transition:border-color 0.25s ease;}/*!sc*/
.ebcgbH ..sc-etPtWW{color:#ffffff;}/*!sc*/
.ebcgbH:focus{box-shadow:inset 0 2px 2px rgba(0, 0, 0, 0.45),0 2px 0 rgba(128, 128, 128, 0.25);}/*!sc*/
data-styled.g112[id="sc-iPHsxv"]{content:"ebcgbH,"}/*!sc*/
.idEIJX{font-size:0.929em;line-height:20px;background-color:#85B655;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat Medium,sans-serif;margin:0;}/*!sc*/
.dCeVuA{font-size:0.929em;line-height:20px;background-color:#179BD7;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat Medium,sans-serif;margin:0;}/*!sc*/
data-styled.g113[id="sc-txhaY"]{content:"idEIJX,dCeVuA,"}/*!sc*/
.ddApzj{position:absolute;width:100%;z-index:100;background:#fafafa;color:#263238;box-sizing:border-box;box-shadow:0 0 6px rgba(0, 0, 0, 0.33);overflow:hidden;border-bottom-left-radius:4px;border-bottom-right-radius:4px;transition:all 0.25s ease;visibility:hidden;transform:translateY(-50%) scaleY(0);}/*!sc*/
data-styled.g114[id="sc-ePpfBx"]{content:"ddApzj,"}/*!sc*/
.evaCJX{padding:10px;}/*!sc*/
data-styled.g115[id="sc-dwGkES"]{content:"evaCJX,"}/*!sc*/
.huWsJW{padding:5px;border:1px solid #ccc;background:#fff;word-break:break-all;color:black;}/*!sc*/
.huWsJW >span{color:#333333;}/*!sc*/
data-styled.g116[id="sc-hSyjfr"]{content:"huWsJW,"}/*!sc*/
.fRACBr{text-transform:lowercase;margin-left:0;line-height:1.5em;}/*!sc*/
data-styled.g117[id="sc-kLJHhQ"]{content:"fRACBr,"}/*!sc*/
.cfrHSm{display:block;border:0;width:100%;text-align:left;padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;cursor:pointer;color:#85B655;background-color:rgba(133,182,85,0.07);}/*!sc*/
.cfrHSm:focus{outline:auto #85B655;}/*!sc*/
data-styled.g119[id="sc-gohMHu"]{content:"cfrHSm,"}/*!sc*/
.fIJIfR{padding:10px;}/*!sc*/
data-styled.g120[id="sc-kJZLhT"]{content:"fIJIfR,"}/*!sc*/
.beMorW{vertical-align:top;}/*!sc*/
data-styled.g122[id="sc-bKXUjo"]{content:"beMorW,"}/*!sc*/
.dheqgt{font-size:1.3em;padding:0.2em 0;margin:3em 0 1.1em;color:#333333;font-weight:normal;}/*!sc*/
data-styled.g123[id="sc-edsqmr"]{content:"dheqgt,"}/*!sc*/
.dGPqXf{margin-bottom:18px;}/*!sc*/
data-styled.g128[id="sc-fantwC"]{content:"dGPqXf,"}/*!sc*/
.bYBGWl{user-select:none;width:20px;height:20px;align-self:center;display:flex;flex-direction:column;color:black;}/*!sc*/
data-styled.g129[id="sc-bLmarx"]{content:"bYBGWl,"}/*!sc*/
.jmYWik{width:260px;background-color:#fafafa;overflow:hidden;display:flex;flex-direction:column;backface-visibility:hidden;height:100vh;position:sticky;position:-webkit-sticky;top:0;}/*!sc*/
@media screen and (max-width: 50rem){.jmYWik{position:fixed;z-index:20;width:100%;background:#fafafa;display:none;}}/*!sc*/
@media print{.jmYWik{display:none;}}/*!sc*/
data-styled.g130[id="sc-dFqmTM"]{content:"jmYWik,"}/*!sc*/
.duEPxr{outline:none;user-select:none;background-color:#f2f2f2;color:black;display:none;cursor:pointer;position:fixed;right:20px;z-index:100;border-radius:50%;box-shadow:0 0 20px rgba(0, 0, 0, 0.3);bottom:44px;width:60px;height:60px;padding:0 20px;}/*!sc*/
@media screen and (max-width: 50rem){.duEPxr{display:flex;}}/*!sc*/
.duEPxr svg{color:#0065FB;}/*!sc*/
@media print{.duEPxr{display:none;}}/*!sc*/
data-styled.g131[id="sc-eqXzvo"]{content:"duEPxr,"}/*!sc*/
.kcLXjB{font-family:Open Sans Light,open sans,sans-serif;font-size:16px;font-weight:400;line-height:1.5em;color:#333333;display:flex;position:relative;text-align:left;-webkit-font-smoothing:antialiased;font-smoothing:antialiased;text-rendering:optimizeSpeed!important;tap-highlight-color:rgba(0, 0, 0, 0);text-size-adjust:100%;}/*!sc*/
.kcLXjB *{box-sizing:border-box;-webkit-tap-highlight-color:rgba(255, 255, 255, 0);}/*!sc*/
data-styled.g132[id="sc-iMPxVN"]{content:"kcLXjB,"}/*!sc*/
.knmTbM{z-index:1;position:relative;overflow:hidden;width:calc(100% - 260px);contain:layout;}/*!sc*/
@media print,screen and (max-width: 50rem){.knmTbM{width:100%;}}/*!sc*/
data-styled.g133[id="sc-jdwyG"]{content:"knmTbM,"}/*!sc*/
.ifLiBE{background:#263238;position:absolute;top:0;bottom:0;right:0;width:calc((100% - 260px) * 0.4);}/*!sc*/
@media print,screen and (max-width: 75rem){.ifLiBE{display:none;}}/*!sc*/
data-styled.g134[id="sc-eEVuZf"]{content:"ifLiBE,"}/*!sc*/
.cqdCbT{padding:5px 0;}/*!sc*/
data-styled.g135[id="sc-dtOqdk"]{content:"cqdCbT,"}/*!sc*/
.eZjnos{width:calc(100% - 24px);box-sizing:border-box;margin:0 12px;padding:5px 6px 5px 12px;border:0;border-bottom:1px solid #e1e1e1;font-family:Open Sans Light,open sans,sans-serif;font-weight:bold;font-size:13px;color:#333333;background-color:transparent;outline:none;}/*!sc*/
data-styled.g136[id="sc-hPGoDJ"]{content:"eZjnos,"}/*!sc*/
.cIMWaL{position:absolute;left:12px;height:1.8em;width:0.9em;}/*!sc*/
.cIMWaL path{fill:#333333;}/*!sc*/
data-styled.g137[id="sc-kBpWFy"]{content:"cIMWaL,"}/*!sc*/
</style>
  <link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
</head>

<body>
  
      <div id="redoc"><div class="sc-iMPxVN kcLXjB redoc-wrap"><div class="sc-dFqmTM jmYWik menu-content" style="top:0px;height:calc(100vh - 0px)"><div class="sc-fqujGp dzdmjb"><a href="https://cpanel.net/support/" class="sc-jQybuE iYFQel"><img src="images/docs-api-full.png" alt="WebPros International, LLC" class="sc-jTpVWm klJCEr"/></a></div><div role="search" class="sc-dtOqdk cqdCbT"><svg class="sc-kBpWFy cIMWaL search-icon" version="1.1" viewBox="0 0 1000 1000" x="0px" xmlns="http://www.w3.org/2000/svg" y="0px"><path d="M968.2,849.4L667.3,549c83.9-136.5,66.7-317.4-51.7-435.6C477.1-25,252.5-25,113.9,113.4c-138.5,138.3-138.5,362.6,0,501C219.2,730.1,413.2,743,547.6,666.5l301.9,301.4c43.6,43.6,76.9,14.9,104.2-12.4C981,928.3,1011.8,893,968.2,849.4z M524.5,522c-88.9,88.7-233,88.7-321.8,0c-88.9-88.7-88.9-232.6,0-321.3c88.9-88.7,233-88.7,321.8,0C613.4,289.4,613.4,433.3,524.5,522z"></path></svg><input placeholder="Search..." aria-label="Search" type="text" class="sc-hPGoDJ eZjnos search-input" value=""/></div><div style="overflow:auto;overscroll-behavior:contain;-ms-overflow-style:-ms-autohiding-scrollbar"><ul role="menu" class="sc-iRVXky dXwhdL"><li tabindex="0" depth="0" data-item-id="group/API-Development-Tools" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="API Development Tools" class="sc-enMaOJ bBONey">API Development Tools</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/API-Token-Management" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="API Token Management" class="sc-enMaOJ bBONey">API Token Management</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/API-Token-Management/operation/create_full_access" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create cPanel API token</span></label></li><li tabindex="0" depth="2" data-item-id="tag/API-Token-Management/operation/Tokens-list" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return cPanel API tokens</span></label></li><li tabindex="0" depth="2" data-item-id="tag/API-Token-Management/operation/rename" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update cPanel API token&#x27;s name</span></label></li><li tabindex="0" depth="2" data-item-id="tag/API-Token-Management/operation/revoke" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Remove cPanel API token</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Batch" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Batch" class="sc-enMaOJ bBONey">Batch</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Batch/operation/strict" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Run multiple UAPI functions in order</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/SSE-Task-Management" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="SSE Task Management" class="sc-enMaOJ bBONey">SSE Task Management</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/SSE-Task-Management/operation/UserTasks::delete" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Remove item from task queue</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SSE-Task-Management/operation/retrieve" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return task queue information</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/URL-Parsing" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="URL Parsing" class="sc-enMaOJ bBONey">URL Parsing</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/URL-Parsing/operation/fetch_url" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return integrated application URL</span></label></li><li tabindex="0" depth="2" data-item-id="tag/URL-Parsing/operation/firstfile_relative_uri" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return session relative URI</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/Authentication" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="Authentication" class="sc-enMaOJ bBONey">Authentication</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/External-Authentication" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="External Authentication" class="sc-enMaOJ bBONey">External Authentication</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/External-Authentication/operation/add_authn_link" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Add external authentication link</span></label></li><li tabindex="0" depth="2" data-item-id="tag/External-Authentication/operation/configured_modules" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return server&#x27;s external authentication providers</span></label></li><li tabindex="0" depth="2" data-item-id="tag/External-Authentication/operation/has_external_auth_modules_configured" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return external authentication user status</span></label></li><li tabindex="0" depth="2" data-item-id="tag/External-Authentication/operation/remove_authn_link" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Remove external authentication link</span></label></li><li tabindex="0" depth="2" data-item-id="tag/External-Authentication/operation/get_authn_links" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return external authentication links</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Two-Factor-Settings" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Two-Factor Settings" class="sc-enMaOJ bBONey">Two-Factor Settings</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Two-Factor-Settings/operation/generate_user_configuration" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create 2FA authentication code</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Two-Factor-Settings/operation/get_team_user_configuration" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return team user 2FA config</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Two-Factor-Settings/operation/get_user_configuration" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return cPanel account 2FA config</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Two-Factor-Settings/operation/set_user_configuration" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Save 2FA config</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Two-Factor-Settings/operation/remove_user_configuration" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Remove 2FA config</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/Block-Ip-Addresses" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="Block Ip Addresses" class="sc-enMaOJ bBONey">Block Ip Addresses</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Block-IP" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Block IP" class="sc-enMaOJ bBONey">Block IP</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Block-IP/operation/blockip-add-ip" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Add IP address to cPanel account&#x27;s block list</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Block-IP/operation/blockip-remove-ip" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Remove IP address from cPanel account&#x27;s block list</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/Commerce-Integration" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="Commerce Integration" class="sc-enMaOJ bBONey">Commerce Integration</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Market-Integration" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Market Integration" class="sc-enMaOJ bBONey">Market Integration</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Market-Integration/operation/Market-get_all_products" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return provider&#x27;s available products</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Market-Integration/operation/create_shopping_cart" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create shopping cart</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Market-Integration/operation/get_login_url" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return provider&#x27;s login URL</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Market-Integration/operation/Market-get_providers_list" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return enabled providers</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Market-Integration/operation/set_status_of_pending_queue_items" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update status of items in pending queue</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Market-Integration/operation/set_url_after_checkout" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update URL after checkout</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Market-Integration/operation/validate_login_token" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Validate login token</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/SSL-Certificates" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="SSL Certificates" class="sc-enMaOJ bBONey">SSL Certificates</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/SSL-Certificates/operation/cancel_pending_ssl_certificate" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete an order</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SSL-Certificates/operation/get_certificate_status_details" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return provider&#x27;s SSL certificate request status</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SSL-Certificates/operation/get_pending_ssl_certificates" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return provider&#x27;s pending SSL certificates</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SSL-Certificates/operation/get_ssl_certificate_if_available" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return provider&#x27;s available SSL certificates</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SSL-Certificates/operation/Market-get_provider_specific_dcv_constraints" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return provider&#x27;s DCV filename requirements</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SSL-Certificates/operation/request_ssl_certificates" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Request SSL certificate order</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SSL-Certificates/operation/process_ssl_pending_queue" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Start processing pending queue&#x27;s SSL certificates</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/Contact-Information" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="Contact Information" class="sc-enMaOJ bBONey">Contact Information</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Contact-Information" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Contact Information" class="sc-enMaOJ bBONey">Contact Information</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Contact-Information/operation/contactinformation-unset_email_addresses" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Unset contact email addresses</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Contact-Information/operation/contactinformation-set_email_addresses" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Set contact email address(es)</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Contact-Information/operation/is_enabled" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return whether contact option is enabled</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/cPanel-Account" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="cPanel Account" class="sc-enMaOJ bBONey">cPanel Account</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Account-Enhancements" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Account Enhancements" class="sc-enMaOJ bBONey">Account Enhancements</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Account-Enhancements/operation/AccountEnhancements-list" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return all cPanel account&#x27;s Account Enhancements</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Enhancements/operation/AccountEnhancements-has-enhancement" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Validate Account Enhancement assignment</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Account-Information" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Account Information" class="sc-enMaOJ bBONey">Account Information</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Account-Information/operation/list_accounts" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return reseller&#x27;s cPanel accounts</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Account-Information/operation/Variables-get_user_information" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return cPanel account&#x27;s configuration settings</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Account-Management" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Account Management" class="sc-enMaOJ bBONey">Account Management</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Account-Management/operation/change_password" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update cPanel account password</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/AuditLog" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="AuditLog" class="sc-enMaOJ bBONey">AuditLog</span></label></li><li tabindex="0" depth="1" data-item-id="tag/Contact-Information" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Contact Information" class="sc-enMaOJ bBONey">Contact Information</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Contact-Information/operation/contactinformation-unset_email_addresses" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Unset contact email addresses</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Contact-Information/operation/contactinformation-set_email_addresses" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Set contact email address(es)</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Contact-Information/operation/is_enabled" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return whether contact option is enabled</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/cPanel-Features" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="cPanel Features" class="sc-enMaOJ bBONey">cPanel Features</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/cPanel-Features/operation/has_feature" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Validate cPanel account&#x27;s feature access</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Features/operation/list_features" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return cPanel account&#x27;s features</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Features/operation/get_feature_metadata" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return cPanel account&#x27;s features&#x27; metadata</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Disk-Quotas" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Disk Quotas" class="sc-enMaOJ bBONey">Disk Quotas</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Disk-Quotas/operation/get_local_quota_info" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return local disk quota information</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Disk-Quotas/operation/get_quota_info" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return disk quota information</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Personalization" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Personalization" class="sc-enMaOJ bBONey">Personalization</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Personalization/operation/Personalization::get" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="post" class="sc-erSfwj gjWqYY operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Retrieve NVData data from file</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Personalization/operation/Personalization-set" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="post" class="sc-erSfwj gjWqYY operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Save NVData data to file</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Resource-Usage-and-Statistics" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Resource Usage and Statistics" class="sc-enMaOJ bBONey">Resource Usage and Statistics</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Resource-Usage-and-Statistics/operation/get_usages" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return resource usage and custom statistics</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Resource-Usage-and-Statistics/operation/get_stats" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return cPanel account statistics</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Subaccount-Management" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Subaccount Management" class="sc-enMaOJ bBONey">Subaccount Management</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Subaccount-Management/operation/UserManager::create_user" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create Subaccount</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Subaccount-Management/operation/UserManager::delete_user" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete Subaccount</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Subaccount-Management/operation/check_account_conflicts" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return Subaccounts and service accounts conflicts</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Subaccount-Management/operation/dismiss_merge" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Remove service account link request</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Subaccount-Management/operation/lookup_service_account" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return service account&#x27;s information</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Subaccount-Management/operation/edit_user" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update Subaccount settings</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Subaccount-Management/operation/lookup_user" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return Subaccount&#x27;s information</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Subaccount-Management/operation/unlink_service_account" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Unregister service account from Subaccount</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Subaccount-Management/operation/merge_service_account" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Register service account to Subaccount</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Subaccount-Management/operation/UserManager-list_users" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return cPanel account&#x27;s Subaccounts</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Team-Roles" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Team Roles" class="sc-enMaOJ bBONey">Team Roles</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Team-Roles/operation/list_feature_descriptions" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">List all role feature descriptions</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Team-Users" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Team Users" class="sc-enMaOJ bBONey">Team Users</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Team-Users/operation/cancel_expire" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Stop a team user from expiring</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Team-Users/operation/reinstate_team_user" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Reinstate a team user</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Team-Users/operation/set_expire" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Set a team user to expire</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Team-Users/operation/add_roles" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Add roles to a team user</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Team-Users/operation/password_reset_request" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Sends a password reset request link to team user.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Team-Users/operation/set_team_user_contact_email" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Set a contact email address for a team user</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Team-Users/operation/set_team_user_password" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Set password for a team user</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Team-Users/operation/remove_roles" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Remove roles from a team user</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Team-Users/operation/add_team_user" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Add a team user</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Team-Users/operation/list_team" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">List Team Users</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Team-Users/operation/suspend_team_user" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Suspend a team user</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Team-Users/operation/edit_team_user" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Edit a team user</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Team-Users/operation/set_team_user_notes" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Set notes for a team user</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Team-Users/operation/Team::set_locale" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Set locale for a team user</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Team-Users/operation/get_team_users_with_roles_count" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Get number of team users with roles</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Team-Users/operation/set_roles" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Set roles for a team user</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Team-Users/operation/remove_team_user" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Remove a team user</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/cPanel-Account-Backups" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="cPanel Account Backups" class="sc-enMaOJ bBONey">cPanel Account Backups</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Backup" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Backup" class="sc-enMaOJ bBONey">Backup</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Backup/operation/fullbackup_to_scp_with_password" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Back up cPanel account via SCP with password</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Backup/operation/fullbackup_to_ftp" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Back up cPanel account via FTP</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Backup/operation/fullbackup_to_homedir" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Back up cPanel account to home directory</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Backup/operation/fullbackup_to_scp_with_key" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Back up cPanel account via SCP with SSH key</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Backup/operation/list_backups" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return backup files</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/File-Restoration" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="File Restoration" class="sc-enMaOJ bBONey">File Restoration</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/File-Restoration/operation/directory_listing" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return backups in home directory</span></label></li><li tabindex="0" depth="2" data-item-id="tag/File-Restoration/operation/get_users" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return cPanel accounts with backup metadata</span></label></li><li tabindex="0" depth="2" data-item-id="tag/File-Restoration/operation/query_file_info" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return backup storage locations</span></label></li><li tabindex="0" depth="2" data-item-id="tag/File-Restoration/operation/restore_file" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Restore file or directory</span></label></li><li tabindex="0" depth="2" data-item-id="tag/File-Restoration/operation/restore_databases" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="post" class="sc-erSfwj gjWqYY operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Restore databases</span></label></li><li tabindex="0" depth="2" data-item-id="tag/File-Restoration/operation/restore_email_forwarders" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="post" class="sc-erSfwj gjWqYY operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Restore email forwarders</span></label></li><li tabindex="0" depth="2" data-item-id="tag/File-Restoration/operation/restore_email_filters" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="post" class="sc-erSfwj gjWqYY operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Restore email filters</span></label></li><li tabindex="0" depth="2" data-item-id="tag/File-Restoration/operation/restore_files" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="post" class="sc-erSfwj gjWqYY operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Restore files</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/cPanel-Theme-Management" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="cPanel Theme Management" class="sc-enMaOJ bBONey">cPanel Theme Management</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Application-Information" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Application Information" class="sc-enMaOJ bBONey">Application Information</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Application-Information/operation/get_applications" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return multiple apps&#x27; info from dynamicui.conf</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Application-Information/operation/get_available_applications" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return current user&#x27;s cPanel application details</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Application-Information/operation/get_information_for_applications" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return app&#x27;s info from sitemap.json</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Application-Information/operation/get_application_information" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return single app&#x27;s info from dynamicui.conf</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Brand-Management" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Brand Management" class="sc-enMaOJ bBONey">Brand Management</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Brand-Management/operation/get_dom" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return cPanel theme header and footer HTML</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Browser-Cache-Management" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Browser Cache Management" class="sc-enMaOJ bBONey">Browser Cache Management</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Browser-Cache-Management/operation/update" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create web browser cached file override ID</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Browser-Cache-Management/operation/CacheBuster-read" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return web browser cached file override ID</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Language" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Language" class="sc-enMaOJ bBONey">Language</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Language/operation/set_locale" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update cPanel account locale</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Language/operation/list_locales" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return available locales</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Language/operation/get_attributes" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return current locale settings</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Theme-Settings" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Theme Settings" class="sc-enMaOJ bBONey">Theme Settings</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Theme-Settings/operation/get_theme_base" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW iVGbgR -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return current theme</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Theme-Settings/operation/Themes::update" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update current theme</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Theme-Settings/operation/Themes::list" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return available themes</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/Directory-Management" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="Directory Management" class="sc-enMaOJ bBONey">Directory Management</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Directory-Indexes" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Directory Indexes" class="sc-enMaOJ bBONey">Directory Indexes</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Directory-Indexes/operation/get_indexing" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return directory indexing settings</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Directory-Indexes/operation/DirectoryIndexes-list_directories" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return subdirectories directory indexing settings</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Directory-Indexes/operation/set_indexing" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update directory indexing settings</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Directory-Privacy" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Directory Privacy" class="sc-enMaOJ bBONey">Directory Privacy</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Directory-Privacy/operation/is_directory_protected" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return whether directory uses password protection</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Directory-Privacy/operation/DirectoryPrivacy::list_users" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return authorized users for protected directory</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Directory-Privacy/operation/DirectoryPrivacy-list_directories" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return privacy status of subdirectories</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Directory-Privacy/operation/configure_directory_protection" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Enable or disable protected directory</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Directory-Privacy/operation/delete_user" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete authorized user for protected directory</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Directory-Privacy/operation/add_user" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Add authorized user for protected directory</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Directory-Protection" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Directory Protection" class="sc-enMaOJ bBONey">Directory Protection</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Directory-Protection/operation/DirectoryProtection-list_directories" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return Directory Protection settings</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/DNS" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="DNS" class="sc-enMaOJ bBONey">DNS</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/DNS" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="DNS" class="sc-enMaOJ bBONey">DNS</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/DNS/operation/ensure_domains_reside_only_locally" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return whether domains only resolve locally</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS/operation/DNS::is_alias_available" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return `ALIAS` DNS record availability &amp; resolver</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS/operation/dns-lookup" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return domain&#x27;s DNS information</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS/operation/dns-parse_zone" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return a parsed DNS zone</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS/operation/dns-mass_edit_zone" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update a DNS zone</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS/operation/DNS-swap_ip_in_zones" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update IP addresses in zone files</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS/operation/has_local_authority" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return whether local DNS server is authoritative</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/DNS-Information" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="DNS Information" class="sc-enMaOJ bBONey">DNS Information</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/DNS-Information/operation/ensure_domains_reside_only_locally" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return whether domains only resolve locally</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS-Information/operation/DNS::is_alias_available" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return `ALIAS` DNS record availability &amp; resolver</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS-Information/operation/dns-lookup" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return domain&#x27;s DNS information</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS-Information/operation/dns-parse_zone" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return a parsed DNS zone</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS-Information/operation/dns-mass_edit_zone" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update a DNS zone</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS-Information/operation/has_local_authority" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return whether local DNS server is authoritative</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/DNS-Security" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="DNS Security" class="sc-enMaOJ bBONey">DNS Security</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/DNS-Security/operation/unset_nsec3" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update domain to use NSEC</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS-Security/operation/export_zone_key" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Export DNSSEC security key</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS-Security/operation/enable_dnssec" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Enable DNSSEC</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS-Security/operation/import_zone_key" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Add DNSSEC security key</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS-Security/operation/export_zone_dnskey" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Export DNSKEY record value</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS-Security/operation/fetch_ds_records" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return domain&#x27;s DS records</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS-Security/operation/remove_zone_key" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Remove DNSSEC security key</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS-Security/operation/deactivate_zone_key" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Disable DNSSEC security key</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS-Security/operation/disable_dnssec" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Disable DNSSEC</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS-Security/operation/add_zone_key" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create DNSSEC security key</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS-Security/operation/set_nsec3" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update domain to use NSEC3</span></label></li><li tabindex="0" depth="2" data-item-id="tag/DNS-Security/operation/activate_zone_key" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Enable DNSSEC security key</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Dynamic-DNS" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Dynamic DNS" class="sc-enMaOJ bBONey">Dynamic DNS</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Dynamic-DNS/operation/dynamicdns-create" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create Dynamic DNS domain</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Dynamic-DNS/operation/dynamicdns-list" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return Dynamic DNS domains</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Dynamic-DNS/operation/dynamicdns-delete" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete Dynamic DNS domain</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Dynamic-DNS/operation/dynamicdns-recreate" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update Dynamic DNS domain ID</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Dynamic-DNS/operation/dynamicdns-set_description" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update Dynamic DNS domain description</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Email-DNS-Settings" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Email DNS Settings" class="sc-enMaOJ bBONey">Email DNS Settings</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Email-DNS-Settings/operation/add_mx" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create mail exchanger record</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-DNS-Settings/operation/change_mx" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update mail exchanger record</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-DNS-Settings/operation/delete_mx" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete mail exchanger record</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-DNS-Settings/operation/EmailAuth::apply_dmarc" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Apply DMARC records to domains.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-DNS-Settings/operation/EmailAuth::remove_dmarc" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Remove DMARC record from domain(s)</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-DNS-Settings/operation/EmailAuth::validate_current_dmarcs" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Validate domains&#x27; DMARC records</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-DNS-Settings/operation/list_mxs" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return mail exchanger records</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-DNS-Settings/operation/enable_dkim" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Enable domains&#x27; DKIM records</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-DNS-Settings/operation/ensure_dkim_keys_exist" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Validate domains&#x27; DKIM private keys</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-DNS-Settings/operation/fetch_dkim_private_keys" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return domains&#x27; DKIM private keys</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-DNS-Settings/operation/install_dkim_private_keys" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Add domains&#x27; DKIM record keys</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-DNS-Settings/operation/install_spf_records" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Add domains&#x27; SPF records</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-DNS-Settings/operation/validate_current_dkims" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Validate domains&#x27; DKIM records</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-DNS-Settings/operation/validate_current_ptrs" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Validate domains&#x27; PTR records</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-DNS-Settings/operation/disable_dkim" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Remove domains&#x27; DKIM records</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-DNS-Settings/operation/validate_current_spfs" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Validate domains&#x27; SPF records</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/Domain-Management" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="Domain Management" class="sc-enMaOJ bBONey">Domain Management</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Direct-Link-Protection-(Hotlink)" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Direct Link Protection (Hotlink)" class="sc-enMaOJ bBONey">Direct Link Protection (Hotlink)</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Direct-Link-Protection-(Hotlink)/operation/delete_hotlink" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Disable hotlink protection</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Direct-Link-Protection-(Hotlink)/operation/add_hotlink" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Enable hotlink protection</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Direct-Link-Protection-(Hotlink)/operation/list_hotlinks" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return domains with hotlink protection</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Domain-Information" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Domain Information" class="sc-enMaOJ bBONey">Domain Information</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Domain-Information/operation/domains_data" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return all domains&#x27; hosting configuration</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Domain-Information/operation/list_domains" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return cPanel account&#x27;s domains</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Domain-Information/operation/single_domain_data" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return domain&#x27;s hosting configuration</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Domain-Information/operation/main_domain_builtin_subdomain_aliases" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return built-in subdomain aliases</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Domain-Redirection" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Domain Redirection" class="sc-enMaOJ bBONey">Domain Redirection</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Domain-Redirection/operation/add_redirect" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Add redirect to domain</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Domain-Redirection/operation/delete_redirect" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Remove redirect from domain</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Domain-Redirection/operation/get_redirect" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return redirect URL for domain</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Domain-Redirection/operation/list_redirects" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return .htaccess files&#x27; redirects</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/SubDomain" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="SubDomain" class="sc-enMaOJ bBONey">SubDomain</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/SubDomain/operation/addsubdomain" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create subdomain</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Virtual-Host-Information" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Virtual Host Information" class="sc-enMaOJ bBONey">Virtual Host Information</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Virtual-Host-Information/operation/WebVhosts::list_domains" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return virtual host names for domains</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Virtual-Host-Information/operation/list_ssl_capable_domains" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return domains that allow SSL certificate purchase</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/Email" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="Email" class="sc-enMaOJ bBONey">Email</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Email-Accounts" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Email Accounts" class="sc-enMaOJ bBONey">Email Accounts</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/account_name" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return current user&#x27;s account name</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/browse_mailbox" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return mail directory&#x27;s subdirectories and files</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/add_pop" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create email address</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/count_auto_responders" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return cPanel account&#x27;s autoresponders total</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/count_pops" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return cPanel account&#x27;s email account total</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/delete_held_messages" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete email account&#x27;s outgoing messages</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/edit_pop_quota" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update email account&#x27;s quota</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/dispatch_client_settings" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Send email client settings to an email address</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/hold_outgoing" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Stop email account&#x27;s outgoing mail</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/get_auto_responder" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return email account&#x27;s autoresponder information</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/get_client_settings" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return email account&#x27;s client settings</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/get_default_email_quota" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return email account&#x27;s default email quota</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/get_disk_usage" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return email account&#x27;s disk usage</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/get_default_email_quota_mib" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return email account&#x27;s default email quota in MiB</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/get_main_account_disk_usage" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return primary email account&#x27;s disk usage</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/get_held_message_count" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return email account&#x27;s outgoing message count</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/get_main_account_disk_usage_bytes" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return primary email account&#x27;s disk usage in bytes</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/get_max_email_quota" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return email account&#x27;s max quota size</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/get_max_email_quota_mib" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return email account&#x27;s max quota size in MiB</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/get_pop_quota" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return email account&#x27;s quota</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/get_webmail_settings" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return email account&#x27;s Webmail settings</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/list_auto_responders" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return domain&#x27;s autoresponders</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/list_default_address" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return domain&#x27;s default email address</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/list_mail_domains" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return cPanel account&#x27;s mail domains</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/list_pops" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return email accounts</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/list_pops_with_disk" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return email accounts with disk information</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/passwd_pop" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update email account password</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/release_outgoing" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Start email account outgoing mail</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/set_default_address" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create default email address</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/trace_delivery" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Run email delivery route trace</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/verify_password" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Validate email account password</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/delete_auto_responder" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete email account&#x27;s autoresponder</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/delete_pop" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete email address</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/add_auto_responder" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create email account&#x27;s autoresponder</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/CSVImport::doimport" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Import email accounts from CSV file</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/set_manual_mx_redirects" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Add manual MX redirection</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/unset_manual_mx_redirects" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Remove manual MX redirection</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Accounts/operation/email-terminate_mailbox_sessions" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Stop cPanel account IMAP and POP3 connections</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Email-Filtering" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Email Filtering" class="sc-enMaOJ bBONey">Email Filtering</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Email-Filtering/operation/count_filters" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return cPanel account&#x27;s email filters total</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Filtering/operation/disable_filter" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Disable email filter for email account</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Filtering/operation/enable_filter" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Enable email filter for email account</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Filtering/operation/get_filter" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return email filter&#x27;s information</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Filtering/operation/list_filters" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return account-level email filters</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Filtering/operation/list_filters_backups" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return domains with domain-level email filters</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Filtering/operation/list_system_filter_info" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return system-level email filter file information</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Filtering/operation/reorder_filters" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update email address&#x27;s email filter order</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Filtering/operation/store_filter" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create email filter</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Filtering/operation/trace_filter" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Run test for main domain email filters</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Filtering/operation/delete_filter" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete email account&#x27;s email filter</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Email-Forwarding" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Email Forwarding" class="sc-enMaOJ bBONey">Email Forwarding</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Email-Forwarding/operation/add_domain_forwarder" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create domain-level forwarder</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Forwarding/operation/add_forwarder" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create email account forwarder</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Forwarding/operation/delete_domain_forwarder" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete domain-level forwarder</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Forwarding/operation/count_forwarders" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return cPanel account&#x27;s mail forwarder total</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Forwarding/operation/delete_forwarder" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete email account&#x27;s email forwarder</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Forwarding/operation/list_domain_forwarders" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return domain-level forwarders</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Forwarding/operation/list_forwarders" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return domain&#x27;s forwarders</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Forwarding/operation/list_forwarders_backups" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return domains with domain-level forwarders</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Email-Server-Information" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Email Server Information" class="sc-enMaOJ bBONey">Email Server Information</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Email-Server-Information/operation/check_fastmail" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return BlackBerry FastMail support status</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Server-Information/operation/disable_mailbox_autocreate" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Disable cPanel account mailbox autocreation</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Server-Information/operation/enable_mailbox_autocreate" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Enable cPanel account mailbox autocreation</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Server-Information/operation/fetch_charmaps" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return server&#x27;s supported character encodings</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Server-Information/operation/fts_rescan_mailbox" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Start IMAP Full-Text Search scan for email account</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Server-Information/operation/get_charsets" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return mail server&#x27;s supported character encodings</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Server-Information/operation/get_mailbox_autocreate" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return cPanel account&#x27;s mailbox autocreate status</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Server-Information/operation/has_plaintext_authentication" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return whether plaintext authentication is enabled</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Server-Information/operation/set_always_accept" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update Mail Exchanger type</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Server-Information/operation/stats_db_status" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return eximstats SQLite database status</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Email-Suspensions" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Email Suspensions" class="sc-enMaOJ bBONey">Email Suspensions</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Email-Suspensions/operation/suspend_incoming" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Suspend email account incoming (SMTP) mail</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Suspensions/operation/suspend_login" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Suspend email account login</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Suspensions/operation/unsuspend_login" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Unsuspend email account login</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Suspensions/operation/suspend_outgoing" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Suspend email account outgoing mail</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Suspensions/operation/unsuspend_incoming" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Unsuspend email account incoming mail</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Email-Suspensions/operation/unsuspend_outgoing" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Unsuspend email account outgoing mail</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Mail-Server-Information" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Mail Server Information" class="sc-enMaOJ bBONey">Mail Server Information</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Mail-Server-Information/operation/get_exim_ports_ssl" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return outgoing mail (SMTP) SSL-secured port</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mail-Server-Information/operation/get_exim_ports" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return outgoing (SMTP) mail port</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Mailbox-Management" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Mailbox Management" class="sc-enMaOJ bBONey">Mailbox Management</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Mailbox-Management/operation/get_mailbox_status_list" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return cPanel account&#x27;s mailbox status</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mailbox-Management/operation/expunge_mailbox_messages" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete selected messages in mailbox</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mailbox-Management/operation/expunge_messages_for_mailbox_guid" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete selected messages in mailbox by GUID</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mailbox-Management/operation/has_utf8_mailbox_names" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return if cPanel account&#x27;s mailboxes use UTF-8</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mailbox-Management/operation/set_utf8_mailbox_names" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Enable or disable Webmail mailbox UTF-8 encoding</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Mailing-Lists" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Mailing Lists" class="sc-enMaOJ bBONey">Mailing Lists</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Mailing-Lists/operation/add_mailman_delegates" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Add administrators to mailing list</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mailing-Lists/operation/count_lists" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return cPanel account&#x27;s mailing list total</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mailing-Lists/operation/export_lists" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Export cPanel account&#x27;s Mailman mailing lists to a file</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mailing-Lists/operation/delete_list" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete mailing list</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mailing-Lists/operation/generate_mailman_otp" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create one-time password for a mailing list</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mailing-Lists/operation/get_lists_total_disk_usage" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return cPanel account&#x27;s mailing list disk usage</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mailing-Lists/operation/get_mailman_delegates" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return mailing list administrators</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mailing-Lists/operation/passwd_list" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update mailing list password</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mailing-Lists/operation/has_delegated_mailman_lists" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return email account&#x27;s mailing list privileges</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mailing-Lists/operation/list_lists" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return cPanel account&#x27;s mailing lists</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mailing-Lists/operation/remove_mailman_delegates" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Remove account mailing list admin privileges</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mailing-Lists/operation/set_list_privacy_options" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update mailing list privacy options</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mailing-Lists/operation/add_list" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create mailing list</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Signing-and-Encryption-(GnuPG-Keys)" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Signing and Encryption (GnuPG Keys)" class="sc-enMaOJ bBONey">Signing and Encryption (GnuPG Keys)</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Signing-and-Encryption-(GnuPG-Keys)/operation/delete_keypair" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete GnuPG key pair</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Signing-and-Encryption-(GnuPG-Keys)/operation/export_public_key" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Export GnuPG public key</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Signing-and-Encryption-(GnuPG-Keys)/operation/export_secret_key" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Export GnuPG secret key</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Signing-and-Encryption-(GnuPG-Keys)/operation/import_key" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Import GnuPG key</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Signing-and-Encryption-(GnuPG-Keys)/operation/list_public_keys" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return current user&#x27;s GnuPG public keys</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Signing-and-Encryption-(GnuPG-Keys)/operation/list_secret_keys" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return current user&#x27;s GnuPG secret keys</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Signing-and-Encryption-(GnuPG-Keys)/operation/generate_key" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create GnuPG key</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Spam-Filtering-(Greylisting)" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Spam Filtering (Greylisting)" class="sc-enMaOJ bBONey">Spam Filtering (Greylisting)</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Spam-Filtering-(Greylisting)/operation/has_greylisting_enabled" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return whether Greylisting is enabled</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Filtering-(Greylisting)/operation/cPGreyList-enable_all_domains" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Enable Greylisting for all domains</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Filtering-(Greylisting)/operation/cPGreyList-disable_all_domains" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Disable Greylisting for all domains</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Filtering-(Greylisting)/operation/cPGreyList-disable_domains" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Disable Greylisting for specified domains</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Filtering-(Greylisting)/operation/cPGreyList::list_domains" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return Greylisting status for domains</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Filtering-(Greylisting)/operation/cPGreyList-enable_domains" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Enable Greylisting for specified domains</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Spam-Management" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Spam Management" class="sc-enMaOJ bBONey">Spam Management</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Spam-Management/operation/disable_spam_assassin" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Disable Apache SpamAssassin for cPanel account</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Management/operation/disable_spam_autodelete" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Disable spam box filtering auto-delete</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Management/operation/disable_spam_box" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Disable spam box filtering for cPanel account</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Management/operation/enable_spam_box" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Enable spam box filtering for cPanel account</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Management/operation/enable_spam_assassin" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Enable Apache SpamAssassin for cPanel account</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Management/operation/get_spam_settings" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return email account Apache SpamAssassin settings</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Management/operation/clear_spam_box" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete spam box contents</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Management/operation/get_symbolic_test_names" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return SpamAssassin™ symbolic test scores</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Management/operation/update_user_preference" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update SpamAssassin™ settings</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Management/operation/get_user_preferences" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return SpamAssassin™ settings</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Management/operation/add_spam_filter" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update minimum spam score threshold value</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Spam-Prevention-(BoxTrapper)" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Spam Prevention (BoxTrapper)" class="sc-enMaOJ bBONey">Spam Prevention (BoxTrapper)</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Spam-Prevention-(BoxTrapper)/operation/set_status" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Enable or disable BoxTrapper for email account</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Prevention-(BoxTrapper)/operation/blacklist_messages" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Add email address to BoxTrapper blocked senders</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Prevention-(BoxTrapper)/operation/deliver_messages" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Send messages in the BoxTrapper queue</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::get_blocklist" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return account BoxTrapper blocklist rules</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::get_ignorelist" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return account BoxTrapper ignorelist rules</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Prevention-(BoxTrapper)/operation/get_message" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return message&#x27;s top 200 lines in BoxTrapper queue</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Prevention-(BoxTrapper)/operation/get_email_template" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return specified BoxTrapper email template</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Prevention-(BoxTrapper)/operation/ignore_messages" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Add email account to Exim ignore list</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Prevention-(BoxTrapper)/operation/reset_email_template" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Restore default BoxTrapper email message template</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::set_ignorelist" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update account BoxTrapper ignorelist</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Prevention-(BoxTrapper)/operation/save_email_template" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Save BoxTrapper message template contents</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Prevention-(BoxTrapper)/operation/list_queued_messages" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return email account&#x27;s BoxTrapper queued messages</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::set_blocklist" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update account BoxTrapper blocklist</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Prevention-(BoxTrapper)/operation/whitelist_messages" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Add email address to BoxTrapper allowed senders</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::get_allowlist" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return account BoxTrapper allowlist rules</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Prevention-(BoxTrapper)/operation/get_configuration" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return email account&#x27;s BoxTrapper configuration</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Prevention-(BoxTrapper)/operation/get_forwarders" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return all BoxTrapper forwarders</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Prevention-(BoxTrapper)/operation/get_log" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return BoxTrapper log file and contents</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Prevention-(BoxTrapper)/operation/get_status" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return whether email account uses BoxTrapper</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Prevention-(BoxTrapper)/operation/delete_messages" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete messages in the BoxTrapper queue</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Prevention-(BoxTrapper)/operation/list_email_templates" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return BoxTrapper email templates</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Prevention-(BoxTrapper)/operation/save_configuration" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update email account&#x27;s BoxTrapper configuration</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Prevention-(BoxTrapper)/operation/set_forwarders" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Add email address to BoxTrapper forwarders</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::set_allowlist" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update account BoxTrapper allowlist</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Spam-Prevention-(BoxTrapper)/operation/process_messages" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Run a specific BoxTrapper action for a message</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Webmail-Applications" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Webmail Applications" class="sc-enMaOJ bBONey">Webmail Applications</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Webmail-Applications/operation/list_webmail_apps" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return available webmail clients</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Webmail-Sessions" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Webmail Sessions" class="sc-enMaOJ bBONey">Webmail Sessions</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Webmail-Sessions/operation/create_webmail_session_for_mail_user_check_password" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create Webmail session with credentials</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Webmail-Sessions/operation/create_webmail_session_for_self" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create Webmail session for current user</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Webmail-Sessions/operation/create_webmail_session_for_mail_user" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create Webmail session</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Webmail-Sessions/operation/create_temp_user" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create user session with existing session</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/Files" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="Files" class="sc-enMaOJ bBONey">Files</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/FTP-Accounts" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="FTP Accounts" class="sc-enMaOJ bBONey">FTP Accounts</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/FTP-Accounts/operation/add_ftp" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create FTP account</span></label></li><li tabindex="0" depth="2" data-item-id="tag/FTP-Accounts/operation/delete_ftp" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete FTP account</span></label></li><li tabindex="0" depth="2" data-item-id="tag/FTP-Accounts/operation/ftp_exists" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return whether an FTP account exists</span></label></li><li tabindex="0" depth="2" data-item-id="tag/FTP-Accounts/operation/get_quota" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return FTP account&#x27;s quota</span></label></li><li tabindex="0" depth="2" data-item-id="tag/FTP-Accounts/operation/get_welcome_message" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return FTP account&#x27;s welcome message</span></label></li><li tabindex="0" depth="2" data-item-id="tag/FTP-Accounts/operation/list_ftp_with_disk" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return FTP accounts and disk usage</span></label></li><li tabindex="0" depth="2" data-item-id="tag/FTP-Accounts/operation/passwd" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update FTP account&#x27;s password</span></label></li><li tabindex="0" depth="2" data-item-id="tag/FTP-Accounts/operation/set_homedir" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update FTP account&#x27;s home directory</span></label></li><li tabindex="0" depth="2" data-item-id="tag/FTP-Accounts/operation/set_quota" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update FTP account&#x27;s quota</span></label></li><li tabindex="0" depth="2" data-item-id="tag/FTP-Accounts/operation/list_ftp" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return FTP accounts</span></label></li><li tabindex="0" depth="2" data-item-id="tag/FTP-Accounts/operation/set_welcome_message" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update FTP welcome message</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/FTP-Server-Settings" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="FTP Server Settings" class="sc-enMaOJ bBONey">FTP Server Settings</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/FTP-Server-Settings/operation/allows_anonymous_ftp" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return if anonymous FTP connections allowed</span></label></li><li tabindex="0" depth="2" data-item-id="tag/FTP-Server-Settings/operation/allows_anonymous_ftp_incoming" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return if anonymous FTP transfers allowed</span></label></li><li tabindex="0" depth="2" data-item-id="tag/FTP-Server-Settings/operation/get_ftp_daemon_info" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return FTP server&#x27;s information</span></label></li><li tabindex="0" depth="2" data-item-id="tag/FTP-Server-Settings/operation/get_port" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return FTP server&#x27;s port</span></label></li><li tabindex="0" depth="2" data-item-id="tag/FTP-Server-Settings/operation/kill_session" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Stop FTP session</span></label></li><li tabindex="0" depth="2" data-item-id="tag/FTP-Server-Settings/operation/list_sessions" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return FTP server&#x27;s active sessions</span></label></li><li tabindex="0" depth="2" data-item-id="tag/FTP-Server-Settings/operation/set_anonymous_ftp" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Enable or disable anonymous FTP logins</span></label></li><li tabindex="0" depth="2" data-item-id="tag/FTP-Server-Settings/operation/server_name" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return whether server uses ProFTPD or Pure-FTPd</span></label></li><li tabindex="0" depth="2" data-item-id="tag/FTP-Server-Settings/operation/set_anonymous_ftp_incoming" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Enable or disable anonymous incoming FTP transfers</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Image-Tools" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Image Tools" class="sc-enMaOJ bBONey">Image Tools</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Image-Tools/operation/convert_file" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create image with new format</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Image-Tools/operation/create_thumbnails" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create image thumbnails</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Image-Tools/operation/get_dimensions" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return image dimensions</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Image-Tools/operation/resize_image" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Save resized image</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Manage-Files" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Manage Files" class="sc-enMaOJ bBONey">Manage Files</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Manage-Files/operation/autocompletedir" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return autocomplete file and directory names</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Manage-Files/operation/empty_trash" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete .trash folder content</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Manage-Files/operation/get_file_content" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return file content</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Manage-Files/operation/get_file_information" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return file or directory information</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Manage-Files/operation/transcode" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update buffer encoding</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Manage-Files/operation/list_files" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return directory content</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Manage-Files/operation/save_file_content" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Save file</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Manage-Files/operation/upload_files" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Upload files</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/WebDisk-Settings" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="WebDisk Settings" class="sc-enMaOJ bBONey">WebDisk Settings</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/WebDisk-Settings/operation/WebDisk::delete_user" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete Web Disk account</span></label></li><li tabindex="0" depth="2" data-item-id="tag/WebDisk-Settings/operation/WebDisk::set_password" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update Web Disk account password</span></label></li><li tabindex="0" depth="2" data-item-id="tag/WebDisk-Settings/operation/WebDisk::set_homedir" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update Web Disk home directory location</span></label></li><li tabindex="0" depth="2" data-item-id="tag/WebDisk-Settings/operation/set_permissions" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update Web Disk home directory permissions</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/GIT-Management" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="GIT Management" class="sc-enMaOJ bBONey">GIT Management</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Deployment-Settings" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Deployment Settings" class="sc-enMaOJ bBONey">Deployment Settings</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Deployment-Settings/operation/VersionControlDeployment::create" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create Git deployment task</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Deployment-Settings/operation/delete" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete Git deployment task</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Deployment-Settings/operation/VersionControlDeployment::retrieve" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return Git deployment task status</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Repository-Management" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Repository Management" class="sc-enMaOJ bBONey">Repository Management</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Repository-Management/operation/VersionControl::create" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create Git repository</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Repository-Management/operation/VersionControl::update" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update Git repository settings</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Repository-Management/operation/VersionControl::delete" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete Git repository</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Repository-Management/operation/VersionControl::retrieve" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return Git repositories</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/MySQL-and-MariaDB" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="MySQL and MariaDB" class="sc-enMaOJ bBONey">MySQL and MariaDB</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Database-Information" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Database Information" class="sc-enMaOJ bBONey">Database Information</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Database-Information/operation/get_server_information" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return MySQL server host information and version</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Database-Information/operation/locate_server" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return MySQL server host information</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Database-Management" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Database Management" class="sc-enMaOJ bBONey">Database Management</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Database-Management/operation/Mysql-update_privileges" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update MySQL® privileges</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Database-Management/operation/Mysql-check_database" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Validate MySQL database integrity</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Database-Management/operation/create_database" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create MySQL database</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Database-Management/operation/dump_database_schema" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return MySQL database schema</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Database-Management/operation/delete_database" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete MySQL database</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Database-Management/operation/list_databases" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return MySQL databases</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Database-Management/operation/Mysql-rename_database" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update MySQL database name</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Database-Management/operation/repair_database" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Repair MySQL database tables</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Database-Management/operation/setup_db_and_user" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create a randomly named MySQL username/database set.</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Remote-Databases" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Remote Databases" class="sc-enMaOJ bBONey">Remote Databases</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Remote-Databases/operation/Mysql-add_host_note" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Add remote MySQL host note</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Remote-Databases/operation/add_host" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Enable remote MySQL host access</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Remote-Databases/operation/get_host_notes" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return remote MySQL host notes</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Remote-Databases/operation/delete_host" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Disable remote MySQL host access</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/User-Management" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="User Management" class="sc-enMaOJ bBONey">User Management</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/User-Management/operation/Mysql-create_user" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create MySQL user</span></label></li><li tabindex="0" depth="2" data-item-id="tag/User-Management/operation/Mysql::delete_user" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete MySQL user</span></label></li><li tabindex="0" depth="2" data-item-id="tag/User-Management/operation/get_restrictions" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return MySQL name length restrictions</span></label></li><li tabindex="0" depth="2" data-item-id="tag/User-Management/operation/list_routines" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return MySQL user routines</span></label></li><li tabindex="0" depth="2" data-item-id="tag/User-Management/operation/Mysql-list_users" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return MySQL users</span></label></li><li tabindex="0" depth="2" data-item-id="tag/User-Management/operation/rename_user" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update MySQL username</span></label></li><li tabindex="0" depth="2" data-item-id="tag/User-Management/operation/Mysql-get_privileges_on_database" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return MySQL user privileges</span></label></li><li tabindex="0" depth="2" data-item-id="tag/User-Management/operation/revoke_access_to_database" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Remove MySQL user privileges</span></label></li><li tabindex="0" depth="2" data-item-id="tag/User-Management/operation/set_privileges_on_database" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update MySQL user privileges</span></label></li><li tabindex="0" depth="2" data-item-id="tag/User-Management/operation/Mysql-set_password" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update MySQL user password</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/Notifications" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="Notifications" class="sc-enMaOJ bBONey">Notifications</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Pushbullet" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Pushbullet" class="sc-enMaOJ bBONey">Pushbullet</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Pushbullet/operation/send_test_message" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Validate Pushbullet token</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/NVData" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="NVData" class="sc-enMaOJ bBONey">NVData</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/NVData" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="NVData" class="sc-enMaOJ bBONey">NVData</span></label></li></ul></li><li tabindex="0" depth="0" data-item-id="group/Optional-Applications" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="Optional Applications" class="sc-enMaOJ bBONey">Optional Applications</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Antivirus-Protection-(ClamAV)" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Antivirus Protection (ClamAV)" class="sc-enMaOJ bBONey">Antivirus Protection (ClamAV)</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Antivirus-Protection-(ClamAV)/operation/ClamScanner::get_scan_paths" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return virus scan types</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Antivirus-Protection-(ClamAV)/operation/ClamScanner::start_scan" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Start virus scan</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Antivirus-Protection-(ClamAV)/operation/ClamScanner::list_infected_files" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return infected file list</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Antivirus-Protection-(ClamAV)/operation/ClamScanner::get_scan_status" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Request virus scan status</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Antivirus-Protection-(ClamAV)/operation/disinfect_files" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="post" class="sc-erSfwj gjWqYY operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Start disinfecting files with viruses</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Antivirus-Protection-(ClamAV)/operation/ClamScanner::check_disinfection_status" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Request disinfection process status</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Calendar-and-Contacts-(DAV)" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Calendar and Contacts (DAV)" class="sc-enMaOJ bBONey">Calendar and Contacts (DAV)</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Calendar-and-Contacts-(DAV)/operation/enable_shared_global_addressbook" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Enable global address book</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Calendar-and-Contacts-(DAV)/operation/has_shared_global_addressbook" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return whether global address book is enabled</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Calendar-and-Contacts-(DAV)/operation/disable_shared_global_addressbook" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Disable global address book</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Calendar-and-Contacts-(DAV)/operation/get_calendar_contacts_config" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return CalDAV and CardDAV connection information</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Calendar-and-Contacts-(DAV)/operation/is_dav_service_enabled" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return whether DAV is enabled</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Calendar-and-Contacts-(DAV)/operation/is_horde_enabled" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return whether Horde is enabled</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_add_delegate" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Share a calendar</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_list_delegates" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">List calendar sharing.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_list_users" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update calendar sharing</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_manage_collection" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Perform an operation on a calendar, task list or address book.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_remove_delegate" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Remove a share.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_update_delegate" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update calendar sharing.</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Calendar-and-Contacts-Server" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Calendar and Contacts Server" class="sc-enMaOJ bBONey">Calendar and Contacts Server</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Calendar-and-Contacts-Server/operation/remove_delegate" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Remove calendar delegation</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Calendar-and-Contacts-Server/operation/list_users" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">List cPanel account&#x27;s calendar users</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Calendar-and-Contacts-Server/operation/update_delegate" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update calendar delegation</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Calendar-and-Contacts-Server/operation/add_delegate" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Add calendar delegation</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Calendar-and-Contacts-Server/operation/list_delegates" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">List cPanel account&#x27;s calendar delegates</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/cPanel-Addons-(cPAddons)" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="cPanel Addons (cPAddons)" class="sc-enMaOJ bBONey">cPanel Addons (cPAddons)</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/cPanel-Addons-(cPAddons)/operation/get_available_addons" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return available cPAddons</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Addons-(cPAddons)/operation/get_instance_settings" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return deployed cPAddons instance&#x27;s settings</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Addons-(cPAddons)/operation/list_addon_instances" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return deployed cPAddons instances</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/WordPress-Manager-Backups" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="WordPress Manager Backups" class="sc-enMaOJ bBONey">WordPress Manager Backups</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/WordPress-Manager-Backups/operation/cancel" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Stop WordPress site backup</span></label></li><li tabindex="0" depth="2" data-item-id="tag/WordPress-Manager-Backups/operation/any_running" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return all WordPress sites&#x27; backup status</span></label></li><li tabindex="0" depth="2" data-item-id="tag/WordPress-Manager-Backups/operation/cleanup" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete WordPress backup temporary files</span></label></li><li tabindex="0" depth="2" data-item-id="tag/WordPress-Manager-Backups/operation/get_available_backups" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return WordPress site backups</span></label></li><li tabindex="0" depth="2" data-item-id="tag/WordPress-Manager-Backups/operation/is_running" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return WordPress site backup status</span></label></li><li tabindex="0" depth="2" data-item-id="tag/WordPress-Manager-Backups/operation/start" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Backup WordPress site</span></label></li><li tabindex="0" depth="2" data-item-id="tag/WordPress-Manager-Backups/operation/WordPressRestore-start" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Restore WordPress site</span></label></li><li tabindex="0" depth="2" data-item-id="tag/WordPress-Manager-Backups/operation/WordPressRestore::any_running" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return WordPress site restore status</span></label></li><li tabindex="0" depth="2" data-item-id="tag/WordPress-Manager-Backups/operation/WordPressRestore-cleanup" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete restored WordPress site&#x27;s temporary files</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/WordPress-Manager-Settings" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="WordPress Manager Settings" class="sc-enMaOJ bBONey">WordPress Manager Settings</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/WordPress-Manager-Settings/operation/change_admin_password" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update WordPress site admin password</span></label></li><li tabindex="0" depth="2" data-item-id="tag/WordPress-Manager-Settings/operation/cleanup_scan" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Remove scan log after completed scan</span></label></li><li tabindex="0" depth="2" data-item-id="tag/WordPress-Manager-Settings/operation/configure_autoupdate" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update WordPress site automatic update settings</span></label></li><li tabindex="0" depth="2" data-item-id="tag/WordPress-Manager-Settings/operation/get_api_version" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return WordPress Manager plugin version</span></label></li><li tabindex="0" depth="2" data-item-id="tag/WordPress-Manager-Settings/operation/get_instances" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return WordPress sites</span></label></li><li tabindex="0" depth="2" data-item-id="tag/WordPress-Manager-Settings/operation/get_latest_wordpress_version_from_wordpress_org" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return latest wordpress.org updates</span></label></li><li tabindex="0" depth="2" data-item-id="tag/WordPress-Manager-Settings/operation/get_instance_by_id" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return WordPress site settings</span></label></li><li tabindex="0" depth="2" data-item-id="tag/WordPress-Manager-Settings/operation/get_scan_results" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return WordPress site scan results</span></label></li><li tabindex="0" depth="2" data-item-id="tag/WordPress-Manager-Settings/operation/is_installable_addon_available" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Verify WordPress cPAddon availability</span></label></li><li tabindex="0" depth="2" data-item-id="tag/WordPress-Manager-Settings/operation/WordPressInstanceManager-start_scan" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Start WordPress sites scan</span></label></li><li tabindex="0" depth="2" data-item-id="tag/WordPress-Manager-Settings/operation/cancel_scan" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Stop WordPress site scan</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/PostgreSQL" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="PostgreSQL" class="sc-enMaOJ bBONey">PostgreSQL</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/PostgreSQL-Database-Management" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="PostgreSQL Database Management" class="sc-enMaOJ bBONey">PostgreSQL Database Management</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/PostgreSQL-Database-Management/operation/Postgresql::create_database" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create PostgreSQL database</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PostgreSQL-Database-Management/operation/Postgresql::get_restrictions" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return PostgreSQL name length restrictions</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PostgreSQL-Database-Management/operation/Postgresql::delete_database" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete PostgreSQL database</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PostgreSQL-Database-Management/operation/Postgresql-list_databases" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return PostgreSQL databases</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PostgreSQL-Database-Management/operation/rename_database" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update PostgreSQL database name</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/PostgreSQL-User-Management" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="PostgreSQL User Management" class="sc-enMaOJ bBONey">PostgreSQL User Management</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/PostgreSQL-User-Management/operation/Postgresql-update_privileges" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update PostgreSQL® privileges</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PostgreSQL-User-Management/operation/create_user" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create PostgreSQL user</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PostgreSQL-User-Management/operation/Postgresql::delete_user" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete PostgreSQL user</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PostgreSQL-User-Management/operation/grant_all_privileges" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Enable all user privileges on PostgreSQL database</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PostgreSQL-User-Management/operation/Postgresql::list_users" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return PostgreSQL users</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PostgreSQL-User-Management/operation/rename_user_no_password" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update PostgreSQL username without password</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PostgreSQL-User-Management/operation/revoke_all_privileges" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Remove PostgreSQL user privileges</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PostgreSQL-User-Management/operation/set_password" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update PostgreSQL user password</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PostgreSQL-User-Management/operation/Postgresql::rename_user" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update PostgreSQL username</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/Retrieve-bandwidth-information" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="Retrieve bandwidth information" class="sc-enMaOJ bBONey">Retrieve bandwidth information</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Bandwidth" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Bandwidth" class="sc-enMaOJ bBONey">Bandwidth</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Bandwidth/operation/get_enabled_protocols" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return services monitored in bandwidth data</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Bandwidth/operation/query" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return cPanel account&#x27;s bandwidth usage report</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Bandwidth/operation/get_retention_periods" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return bandwidth retention period</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/Security" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="Security" class="sc-enMaOJ bBONey">Security</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Known-SSH-Hosts-Management" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Known SSH Hosts Management" class="sc-enMaOJ bBONey">Known SSH Hosts Management</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Known-SSH-Hosts-Management/operation/create" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create host</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Known-SSH-Hosts-Management/operation/KnownHosts::delete" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete host</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Known-SSH-Hosts-Management/operation/KnownHosts::update" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update host in the known_hosts file</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Known-SSH-Hosts-Management/operation/verify" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Validate host</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Login-Information" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Login Information" class="sc-enMaOJ bBONey">Login Information</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Login-Information/operation/get_last_or_current_logged_in_ip" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return last authenticated login IP address</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Login-Information/operation/get_session_information" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return web server&#x27;s hostname</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/Server-Information" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="Server Information" class="sc-enMaOJ bBONey">Server Information</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/cPanel-Server-Information" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="cPanel Server Information" class="sc-enMaOJ bBONey">cPanel Server Information</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/cPanel-Server-Information/operation/get_information" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return service and device status</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Server-Information/operation/Variables-get_server_information" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return server&#x27;s configuration settings</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Notifications" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Notifications" class="sc-enMaOJ bBONey">Notifications</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Notifications/operation/get_notifications_count" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return server notifications total</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Password-Strength" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Password Strength" class="sc-enMaOJ bBONey">Password Strength</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Password-Strength/operation/get_required_strength" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return minimum required password strength</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/SSH" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="SSH" class="sc-enMaOJ bBONey">SSH</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/SSH/operation/SSH-get_port" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return SSH port</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/ServiceProxy" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="ServiceProxy" class="sc-enMaOJ bBONey">ServiceProxy</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/ServiceProxy" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="ServiceProxy" class="sc-enMaOJ bBONey">ServiceProxy</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/ServiceProxy/operation/serviceproxy-get_service_proxy_backends" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return a cPanel account’s service proxying setup</span></label></li><li tabindex="0" depth="2" data-item-id="tag/ServiceProxy/operation/serviceproxy-unset_all_service_proxy_backends" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Remove cPanel account service proxying</span></label></li><li tabindex="0" depth="2" data-item-id="tag/ServiceProxy/operation/serviceproxy-set_service_proxy_backends" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Add cPanel account service proxying</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/SSL-Certificates" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="SSL Certificates" class="sc-enMaOJ bBONey">SSL Certificates</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Auto-generated-SSL-Certificates" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Auto-generated SSL Certificates" class="sc-enMaOJ bBONey">Auto-generated SSL Certificates</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Auto-generated-SSL-Certificates/operation/add_autossl_excluded_domains" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Disable AutoSSL for domains</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Auto-generated-SSL-Certificates/operation/get_autossl_excluded_domains" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return AutoSSL disabled domains</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Auto-generated-SSL-Certificates/operation/get_autossl_problems" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return domains with AutoSSL problems</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Auto-generated-SSL-Certificates/operation/is_autossl_check_in_progress" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return whether AutoSSL check in progress</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Auto-generated-SSL-Certificates/operation/remove_autossl_excluded_domains" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Enable AutoSSL for specifed domains</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Auto-generated-SSL-Certificates/operation/set_autossl_excluded_domains" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Disable AutoSSL for specifed domains</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Auto-generated-SSL-Certificates/operation/start_autossl_check" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Start AutoSSL for current user</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/cPanel-Account-SSL-Management" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="cPanel Account SSL Management" class="sc-enMaOJ bBONey">cPanel Account SSL Management</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-SSL-Management/operation/can_ssl_redirect" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return whether domains can redirect to secure URL</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-SSL-Management/operation/delete_ssl" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Remove SSL for domain</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-SSL-Management/operation/check_shared_cert" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW iVGbgR -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return whether shared SSL certificate exists</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-SSL-Management/operation/fetch_best_for_domain" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Request best SSL certificate</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-SSL-Management/operation/fetch_cert_info" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return SSL certificate information</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-SSL-Management/operation/fetch_certificates_for_fqdns" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return SSL certificate information for all FQDN</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-SSL-Management/operation/find_certificates_for_key" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return SSL certificate for private key</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-SSL-Management/operation/fetch_key_and_cabundle_for_certificate" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="post" class="sc-erSfwj gjWqYY operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return private key and CA bundle</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-SSL-Management/operation/find_csrs_for_key" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return private key&#x27;s certificate signing requests</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-SSL-Management/operation/get_cabundle" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return certificate&#x27;s CA bundle and hostname</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-SSL-Management/operation/get_cn_name" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Request best SSL domain for service</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-SSL-Management/operation/installed_host" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return SSL certificate&#x27;s info for dedicated IP</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-SSL-Management/operation/installed_hosts" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return domains with SSL certificate information</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-SSL-Management/operation/list_certs" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return all SSL certificates</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-SSL-Management/operation/list_keys" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return all private keys</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-SSL-Management/operation/list_ssl_items" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return SSL-related items</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-SSL-Management/operation/list_csrs" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return all certificate signing requests</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-SSL-Management/operation/rebuildssldb" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Start SSL database rebuild</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-SSL-Management/operation/toggle_ssl_redirect_for_domains" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Enable or disable secure redirects</span></label></li><li tabindex="0" depth="2" data-item-id="tag/cPanel-Account-SSL-Management/operation/SSL::set_default_key_type" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update SSL TLS key type</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/SNI-Email-Settings" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="SNI Email Settings" class="sc-enMaOJ bBONey">SNI Email Settings</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/SNI-Email-Settings/operation/enable_mail_sni" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Enable SNI mail services for domain</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SNI-Email-Settings/operation/disable_mail_sni" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Disable SNI mail services for domain</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SNI-Email-Settings/operation/is_mail_sni_supported" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return whether mail SNI is enabled</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SNI-Email-Settings/operation/is_sni_supported" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return whether Apache web server supports mail SNI</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SNI-Email-Settings/operation/mail_sni_status" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return status of domain&#x27;s SNI mail services</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SNI-Email-Settings/operation/rebuild_mail_sni_config" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Start SNI configuration files rebuild</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/SSL-Certificate-Management" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="SSL Certificate Management" class="sc-enMaOJ bBONey">SSL Certificate Management</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/SSL-Certificate-Management/operation/install_ssl" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Install SSL certificate</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SSL-Certificate-Management/operation/delete_csr" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete certificate signing request</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SSL-Certificate-Management/operation/delete_key" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete private key</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SSL-Certificate-Management/operation/delete_cert" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete SSL certificate</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SSL-Certificate-Management/operation/generate_cert" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create self-signed SSL certificate</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SSL-Certificate-Management/operation/SSL-generate_key" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create private key</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SSL-Certificate-Management/operation/generate_csr" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Create certificate signing request</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SSL-Certificate-Management/operation/set_cert_friendly_name" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update SSL certificate&#x27;s friendly name</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SSL-Certificate-Management/operation/set_csr_friendly_name" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update certificate signing request&#x27;s friendly name</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SSL-Certificate-Management/operation/set_key_friendly_name" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update private key&#x27;s friendly name</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SSL-Certificate-Management/operation/set_primary_ssl" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update SSL website for dedicated IP address</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SSL-Certificate-Management/operation/show_cert" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Export SSL certificate</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SSL-Certificate-Management/operation/show_key" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Export private key</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SSL-Certificate-Management/operation/show_csr" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Export certificate signing request</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SSL-Certificate-Management/operation/upload_cert" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="post" class="sc-erSfwj gjWqYY operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Import SSL certificate</span></label></li><li tabindex="0" depth="2" data-item-id="tag/SSL-Certificate-Management/operation/upload_key" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="post" class="sc-erSfwj gjWqYY operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Import private key</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Verify-Domain-Ownership" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Verify Domain Ownership" class="sc-enMaOJ bBONey">Verify Domain Ownership</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Verify-Domain-Ownership/operation/check_domains_via_dns" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="post" class="sc-erSfwj gjWqYY operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Verify domain ownership via DNS</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Verify-Domain-Ownership/operation/check_domains_via_http" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Verify domain ownership via HTTP</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Verify-Domain-Ownership/operation/ensure_domains_can_pass_dcv" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW iVGbgR -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Verify domain ownership</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/Statistics" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="Statistics" class="sc-enMaOJ bBONey">Statistics</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Domain-Statistics" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Domain Statistics" class="sc-enMaOJ bBONey">Domain Statistics</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Domain-Statistics/operation/get_site_errors" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return specified domain access log</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Domain-Statistics/operation/get_bandwidth" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return bandwidth statistics for all domains</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Domain-Statistics/operation/list_sites" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return Analog statistics for all domains</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Domain-Statistics/operation/list_stats_by_domain" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return Analog statistics for specified domain</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Weblog-Settings" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Weblog Settings" class="sc-enMaOJ bBONey">Weblog Settings</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Weblog-Settings/operation/stats_manager_get_configuration" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Returns weblog analyzers&#x27; configuration</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Weblog-Settings/operation/stats_manager_save_configuration" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="post" class="sc-erSfwj gjWqYY operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Save current user&#x27;s weblog analyzers configuration</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/Web-Server-Configuration" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="Web Server Configuration" class="sc-enMaOJ bBONey">Web Server Configuration</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/EA4" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="EA4" class="sc-enMaOJ bBONey">EA4</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/EA4/operation/get_recommendations" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Get EA4 configuration recommendations</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/EasyApache-Settings" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="EasyApache Settings" class="sc-enMaOJ bBONey">EasyApache Settings</span></label></li><li tabindex="0" depth="1" data-item-id="tag/PHP" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="PHP" class="sc-enMaOJ bBONey">PHP</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/PHP/operation/EA4::get_php_recommendations" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Get custom PHP recommendations.</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/Web-Server-Management" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="Web Server Management" class="sc-enMaOJ bBONey">Web Server Management</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Application-Manager" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Application Manager" class="sc-enMaOJ bBONey">Application Manager</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Application-Manager/operation/edit_application" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update Passenger application settings</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Application-Manager/operation/disable_application" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Disable Passenger application</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Application-Manager/operation/enable_application" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Enable Passenger application</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Application-Manager/operation/list_applications" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return Passenger applications</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Application-Manager/operation/ensure_deps" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Install Passenger application dependencies</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Application-Manager/operation/register_application" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Register Passenger application</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Application-Manager/operation/unregister_application" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Unregister Passenger application</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/ModSecurity" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="ModSecurity" class="sc-enMaOJ bBONey">ModSecurity</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/ModSecurity/operation/disable_all_domains" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Disable ModSecurity for all domains</span></label></li><li tabindex="0" depth="2" data-item-id="tag/ModSecurity/operation/disable_domains" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Disable ModSecurity for selected domains</span></label></li><li tabindex="0" depth="2" data-item-id="tag/ModSecurity/operation/enable_all_domains" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Enable ModSecurity for all domains</span></label></li><li tabindex="0" depth="2" data-item-id="tag/ModSecurity/operation/enable_domains" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Enable ModSecurity for selected domains</span></label></li><li tabindex="0" depth="2" data-item-id="tag/ModSecurity/operation/has_modsecurity_installed" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return ModSecurity installation status</span></label></li><li tabindex="0" depth="2" data-item-id="tag/ModSecurity/operation/ModSecurity-list_domains" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return ModSecurity domains&#x27; status</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/NginxCaching" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="NginxCaching" class="sc-enMaOJ bBONey">NginxCaching</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/NginxCaching/operation/enable_cache" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Enable the user&#x27;s NGINX cache</span></label></li><li tabindex="0" depth="2" data-item-id="tag/NginxCaching/operation/clear_cache" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete NGINX cache contents.</span></label></li><li tabindex="0" depth="2" data-item-id="tag/NginxCaching/operation/reset_cache_config" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Reset the user&#x27;s NGINX cache configuration</span></label></li><li tabindex="0" depth="2" data-item-id="tag/NginxCaching/operation/disable_cache" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Disable the user&#x27;s NGINX cache</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/PHP-Settings" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="PHP Settings" class="sc-enMaOJ bBONey">PHP Settings</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/PHP-Settings/operation/php_get_domain_handler" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return PHP version&#x27;s handler</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PHP-Settings/operation/php_get_impacted_domains" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return domains that shared PHP configuration</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PHP-Settings/operation/php_get_installed_versions" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return installed PHP versions</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PHP-Settings/operation/php_ini_get_user_content" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return virtual host&#x27;s php.ini content</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PHP-Settings/operation/php_get_system_default_version" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return default PHP version</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PHP-Settings/operation/php_ini_get_user_basic_directives" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return basic PHP directives</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PHP-Settings/operation/php_ini_get_user_paths" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return php.ini file paths</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PHP-Settings/operation/php_ini_set_user_basic_directives" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update basic PHP directives</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PHP-Settings/operation/php_ini_set_user_content" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update virtual host&#x27;s php.ini content</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PHP-Settings/operation/php_set_vhost_versions" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update virtual host&#x27;s PHP version</span></label></li><li tabindex="0" depth="2" data-item-id="tag/PHP-Settings/operation/php_get_vhost_versions" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return virtual host&#x27;s PHP version</span></label></li></ul></li></ul></li><li tabindex="0" depth="0" data-item-id="group/Website-Configuration" role="menuitem" class="sc-ljhlHD ghRwPP"><label class="sc-bAEjGW dyrMKZ -depth0"><span width="calc(100% - 38px)" title="Website Configuration" class="sc-enMaOJ bBONey">Website Configuration</span></label><ul class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/Handler-Management" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Handler Management" class="sc-enMaOJ bBONey">Handler Management</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Handler-Management/operation/add_handler" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Add web server MIME type handler</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Handler-Management/operation/delete_handler" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Remove web server MIME type handler</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Handler-Management/operation/list_handlers" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return web server&#x27;s MIME handlers</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Handler-Management/operation/redirect_info" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return redirect information</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Logs" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Logs" class="sc-enMaOJ bBONey">Logs</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Logs/operation/LogManager_delete_archive" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete a log archive file</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Logs/operation/LogManager_get_settings" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Retrieve cPanel account&#x27;s log archival settings</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Logs/operation/LogManager_list_archives" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return cPanel account&#x27;s archive files list</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Logs/operation/LogManager_set_settings" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Save cPanel account&#x27;s log archive settings</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Mime-Type-Management" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Mime Type Management" class="sc-enMaOJ bBONey">Mime Type Management</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Mime-Type-Management/operation/add_mime" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Add MIME type to web server</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mime-Type-Management/operation/delete_mime" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Remove MIME type from web server</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Mime-Type-Management/operation/list_mime" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return web server&#x27;s MIME types</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Site-Information" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Site Information" class="sc-enMaOJ bBONey">Site Information</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Site-Information/operation/WordPressSite::retrieve" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return WordPress site information</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Site-Installation" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Site Installation" class="sc-enMaOJ bBONey">Site Installation</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Site-Installation/operation/WordPressSite::create" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Install WordPress site</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Site-Publisher-Management" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW blqVXy -depth1"><span width="calc(100% - 38px)" title="Site Publisher Management" class="sc-enMaOJ bBONey">Site Publisher Management</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Site-Publisher-Management/operation/list_site_templates" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return available Site Publisher templates</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Site-Publisher-Management/operation/publish" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Add Site Publisher website</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Site-Publisher-Management/operation/list_user_settings" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW fzIOJo -depth2"><span type="get" class="sc-erSfwj gjWqYY operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Return Site Publisher websites&#x27; information</span></label></li></ul></li></ul></li></ul><div class="sc-fUEImY gFEWWY"><a target="_blank" rel="noopener noreferrer" href="https://redocly.com/redoc/">API docs by Redocly</a></div></div></div><div class="sc-eqXzvo duEPxr"><div class="sc-bLmarx bYBGWl"><svg class="" style="transform:translate(2px, -4px) rotate(180deg);transition:transform 0.2s ease" viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15"><g transform="translate(904.92214,-879.1482)"><path d="
          m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,
          -55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,
          0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892,
          -174.6858 c 96.079,-96.07721 175.253196,-174.68583 175.942696,
          -174.68583 0.6895,0 26.281,25.03215 56.8701,
          55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
          -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
          -104.0616 -231.873,-231.248 z
        " fill="currentColor"></path></g></svg><svg class="" style="transform:translate(2px, 4px);transition:transform 0.2s ease" viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15"><g transform="translate(904.92214,-879.1482)"><path d="
          m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,
          -55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,
          0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892,
          -174.6858 c 96.079,-96.07721 175.253196,-174.68583 175.942696,
          -174.68583 0.6895,0 26.281,25.03215 56.8701,
          55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
          -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
          -104.0616 -231.873,-231.248 z
        " fill="currentColor"></path></g></svg></div></div><div class="sc-jdwyG knmTbM api-content"><div class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI api-info"><h1 class="sc-ixGGxD sc-geoRQH itbxeC dZsYqS">cPanel UAPI </h1><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><div class="sc-kBAPdo gmEXff"><div class="sc-ftmehX eeVPfW"><span class="sc-gbwXoZ bcPxPq">WebPros International, LLC: <a href="mailto:cs@cpanel.net">cs@cpanel.net</a></span> <span class="sc-gbwXoZ bcPxPq">URL: <a href="https://cpanel.net/support/">https://cpanel.net/support/</a></span> <span class="sc-gbwXoZ bcPxPq">License: <a href="https://cpanel.net/legal-notices/">cPanel License</a></span> <span class="sc-gbwXoZ bcPxPq"><a href="https://cpanel.net/legal-notices/">Terms of Service</a></span></div></div></div><div data-role="redoc-summary" html="" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"></div><div data-role="redoc-description" html="&lt;p&gt;UAPI accesses the cPanel interface&amp;#39;s features. Use this API to access and modify cPanel account data and settings.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>UAPI accesses the cPanel interface&#39;s features. Use this API to access and modify cPanel account data and settings.</p>
</div><div class="sc-jdeYMN gfjLjc"><a href="https://cpanel.net/developers/">https://cpanel.net/developers/</a></div></div></div></div><div id="tag/API-Token-Management" data-section-id="tag/API-Token-Management" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/API-Token-Management" aria-label="tag/API-Token-Management"></a>API Token Management</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;API Development Tools / API Token Management&lt;/p&gt;
"><p>API Development Tools / API Token Management</p>
</div></div></div><div id="tag/API-Token-Management/operation/create_full_access" data-section-id="tag/API-Token-Management/operation/create_full_access" class="sc-dntaoT ceciOs"><div data-section-id="operation/create_full_access" id="operation/create_full_access" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/API-Token-Management/operation/create_full_access" aria-label="tag/API-Token-Management/operation/create_full_access"></a>Create cPanel API token </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function creates a new API token with full access to all of a cPanel account&amp;#39;s features.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;The token &lt;strong&gt;only&lt;/strong&gt; grants access to the features that the account has access to. For example,
if you disable the &lt;a href=&quot;https://go.cpanel.net/cpaneldocsFileManager&quot;&gt;&lt;em&gt;File Manager&lt;/em&gt;&lt;/a&gt; feature, the
token can&amp;#39;t access it.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a new API token with full access to all of a cPanel account&#39;s features.</p>
<p><strong>Note:</strong></p>
<p>The token <strong>only</strong> grants access to the features that the account has access to. For example,
if you disable the <a href="https://go.cpanel.net/cpaneldocsFileManager"><em>File Manager</em></a> feature, the
token can&#39;t access it.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="expires_at" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">expires_at</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;unix_timestamp&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">expires_at=1609372800</span></div><div><div html="&lt;p&gt;The API token&amp;#39;s expiration time.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;When an API token expires the system does &lt;strong&gt;not&lt;/strong&gt; delete it. You &lt;strong&gt;must&lt;/strong&gt; manually delete expired API tokens.&lt;/li&gt;
&lt;li&gt;If you do not use this parameter, the API token will &lt;strong&gt;not&lt;/strong&gt; expire.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The API token&#39;s expiration time.</p>
<p><strong>Important:</strong></p>
<ul>
<li>When an API token expires the system does <strong>not</strong> delete it. You <strong>must</strong> manually delete expired API tokens.</li>
<li>If you do not use this parameter, the API token will <strong>not</strong> expire.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">name</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &lt;= 50 characters </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=example</span></div><div><div html="&lt;p&gt;The API token&amp;#39;s name.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;The name may &lt;strong&gt;only&lt;/strong&gt; contain alphanumeric characters, dashes (&lt;code&gt;-&lt;/code&gt;), and underscores (&lt;code&gt;_&lt;/code&gt;).&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The API token&#39;s name.</p>
<p><strong>Note:</strong></p>
<p>The name may <strong>only</strong> contain alphanumeric characters, dashes (<code>-</code>), and underscores (<code>_</code>).</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Tokens/create_full_access</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Tokens/create_full_access</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kj30q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kj30q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kj30q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj30q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kj30q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj30q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kj30q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj30q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kj30q:0" aria-labelledby="tab:R4kj30q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Tokens <span class="token punctuation">\</span>
  create_full_access <span class="token punctuation">\</span>
  <span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'example'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj30q:1" aria-labelledby="tab:R4kj30q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj30q:2" aria-labelledby="tab:R4kj30q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj30q:3" aria-labelledby="tab:R4kj30q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sj30q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sj30q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sj30q:0" aria-labelledby="tab:R4sj30q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;create_full_access&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Tokens&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"create_time"</span>: <span class="token number">1549467298</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"token"</span>: <span class="token string">&quot;JPQNSRU0DH448UJLGXH7KVJECC5QN9N9&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/API-Token-Management/operation/Tokens-list" data-section-id="tag/API-Token-Management/operation/Tokens-list" class="sc-dntaoT ceciOs"><div data-section-id="operation/Tokens-list" id="operation/Tokens-list" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/API-Token-Management/operation/Tokens-list" aria-label="tag/API-Token-Management/operation/Tokens-list"></a>Return cPanel API tokens </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns a list of a cPanel account&amp;#39;s API tokens.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns a list of a cPanel account&#39;s API tokens.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Tokens/list</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Tokens/list</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kl30q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kl30q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kl30q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl30q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kl30q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl30q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kl30q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl30q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kl30q:0" aria-labelledby="tab:R4kl30q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Tokens <span class="token punctuation">\</span>
  list
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl30q:1" aria-labelledby="tab:R4kl30q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl30q:2" aria-labelledby="tab:R4kl30q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl30q:3" aria-labelledby="tab:R4kl30q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sl30q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sl30q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sl30q:0" aria-labelledby="tab:R4sl30q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Tokens&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"create_time"</span>: <span class="token number">1549471343</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_at"</span>: <span class="token number">1609372800</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"features"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_full_access"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;exampletoken&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/API-Token-Management/operation/rename" data-section-id="tag/API-Token-Management/operation/rename" class="sc-dntaoT ceciOs"><div data-section-id="operation/rename" id="operation/rename" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/API-Token-Management/operation/rename" aria-label="tag/API-Token-Management/operation/rename"></a>Update cPanel API token&#x27;s name </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function renames a cPanel account&amp;#39;s existing API token.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function renames a cPanel account&#39;s existing API token.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">name</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=example</span></div><div><div html="&lt;p&gt;The API token&amp;#39;s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The API token&#39;s name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="new_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">new_name</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &lt;= 50 characters </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">new_name=newexample</span></div><div><div html="&lt;p&gt;The new name for the API token.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;The name may only contain alphanumeric characters, dashes (&lt;code&gt;-&lt;/code&gt;), and underscores (&lt;code&gt;_&lt;/code&gt;).&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new name for the API token.</p>
<p><strong>Note:</strong></p>
<p>The name may only contain alphanumeric characters, dashes (<code>-</code>), and underscores (<code>_</code>).</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Tokens/rename</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Tokens/rename</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kn30q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kn30q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kn30q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn30q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kn30q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn30q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kn30q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn30q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kn30q:0" aria-labelledby="tab:R4kn30q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Tokens <span class="token punctuation">\</span>
  <span class="token function">rename</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'example'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">new_name</span><span class="token operator">=</span><span class="token string">'newexample'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn30q:1" aria-labelledby="tab:R4kn30q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn30q:2" aria-labelledby="tab:R4kn30q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn30q:3" aria-labelledby="tab:R4kn30q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sn30q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sn30q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sn30q:0" aria-labelledby="tab:R4sn30q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;rename&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Tokens&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/API-Token-Management/operation/revoke" data-section-id="tag/API-Token-Management/operation/revoke" class="sc-dntaoT ceciOs"><div data-section-id="operation/revoke" id="operation/revoke" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/API-Token-Management/operation/revoke" aria-label="tag/API-Token-Management/operation/revoke"></a>Remove cPanel API token </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function removes an API token from a cPanel account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes an API token from a cPanel account.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">name</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=example</span></div><div><div html="&lt;p&gt;The API token to remove.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The API token to remove.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Tokens/revoke</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Tokens/revoke</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kp30q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kp30q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kp30q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp30q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kp30q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp30q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kp30q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp30q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kp30q:0" aria-labelledby="tab:R4kp30q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Tokens <span class="token punctuation">\</span>
  revoke <span class="token punctuation">\</span>
  <span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'example'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp30q:1" aria-labelledby="tab:R4kp30q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp30q:2" aria-labelledby="tab:R4kp30q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp30q:3" aria-labelledby="tab:R4kp30q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sp30q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sp30q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sp30q:0" aria-labelledby="tab:R4sp30q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;revoke&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Tokens&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Batch" data-section-id="tag/Batch" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Batch" aria-label="tag/Batch"></a>Batch</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;The Batch module for UAPI.&lt;/p&gt;
"><p>The Batch module for UAPI.</p>
</div></div></div><div id="tag/Batch/operation/strict" data-section-id="tag/Batch/operation/strict" class="sc-dntaoT ceciOs"><div data-section-id="operation/strict" id="operation/strict" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Batch/operation/strict" aria-label="tag/Batch/operation/strict"></a>Run multiple UAPI functions in order </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function combines calls for multiple UAPI functions and performs them in order.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;If a function call in the list fails, the &lt;code&gt;Batch::strict&lt;/code&gt; function does not run further function calls in the list.&lt;/li&gt;
&lt;li&gt;Due to the potential length of calls of this function, we recommend that you use the HTTP POST method for extremely long batch commands.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function combines calls for multiple UAPI functions and performs them in order.</p>
<p><strong>Note:</strong></p>
<ul>
<li>If a function call in the list fails, the <code>Batch::strict</code> function does not run further function calls in the list.</li>
<li>Due to the potential length of calls of this function, we recommend that you use the HTTP POST method for extremely long batch commands.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="command" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand command"><span class="property-name">command</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">strings or objects</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> [ 2 .. 3 ] items </span></span></div> <div><div html="&lt;p&gt;A UAPI function call, encoded as a JSON array with two or three items:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;The UAPI module.&lt;/li&gt;
&lt;li&gt;The UAPI function.&lt;/li&gt;
&lt;li&gt;A JSON object containing the parameters to pass to this function. You can omit this value if you do not pass any parameters to the function.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;To submit multiple commands, duplicate the parameter name, or index all parameter names and increment the index for each one.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;When using the cPanel LiveAPI PHP Library, you &lt;strong&gt;must&lt;/strong&gt; increment the parameter name when you submit the arguments in an associative array. For example: use &lt;code&gt;command-0&lt;/code&gt;, &lt;code&gt;command-1&lt;/code&gt;, and &lt;code&gt;command-2&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;When using the cPanel LiveAPI Perl Library, you &lt;strong&gt;must&lt;/strong&gt; increment the parameter name when you submit the arguments in a hash. For example: use &lt;code&gt;command-0&lt;/code&gt;, &lt;code&gt;command-1&lt;/code&gt;, and &lt;code&gt;command-2&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;You do &lt;strong&gt;not&lt;/strong&gt; need to add an index to &lt;code&gt;command&lt;/code&gt; parameters for query string calls of this function.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A UAPI function call, encoded as a JSON array with two or three items:</p>
<ul>
<li>The UAPI module.</li>
<li>The UAPI function.</li>
<li>A JSON object containing the parameters to pass to this function. You can omit this value if you do not pass any parameters to the function.</li>
</ul>
<p>To submit multiple commands, duplicate the parameter name, or index all parameter names and increment the index for each one.</p>
<ul>
<li>When using the cPanel LiveAPI PHP Library, you <strong>must</strong> increment the parameter name when you submit the arguments in an associative array. For example: use <code>command-0</code>, <code>command-1</code>, and <code>command-2</code>.</li>
<li>When using the cPanel LiveAPI Perl Library, you <strong>must</strong> increment the parameter name when you submit the arguments in a hash. For example: use <code>command-0</code>, <code>command-1</code>, and <code>command-2</code>.</li>
<li>You do <strong>not</strong> need to add an index to <code>command</code> parameters for query string calls of this function.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Batch/strict</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Batch/strict</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R15750q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R15750q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R15750q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R15750q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R15750q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R15750q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R15750q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R15750q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R15750q:0" aria-labelledby="tab:R15750q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token parameter variable">--user</span><span class="token operator">=</span>username Batch strict command-0<span class="token operator">=</span><span class="token string">'[ "PasswdStrength", "get_required_strength", { "app": "webdisk"} ]'</span> command-1<span class="token operator">=</span><span class="token string">'["SSH","get_port"]'</span></pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R15750q:1" aria-labelledby="tab:R15750q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R15750q:2" aria-labelledby="tab:R15750q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R15750q:3" aria-labelledby="tab:R15750q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R17750q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R17750q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R17750q:0" aria-labelledby="tab:R17750q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;strict&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Batch&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"strength"</span>: <span class="token number">65</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"port"</span>: <span class="token number">22</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/SSE-Task-Management" data-section-id="tag/SSE-Task-Management" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSE-Task-Management" aria-label="tag/SSE-Task-Management"></a>SSE Task Management</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;API Development Tools / SSE Task Management&lt;/p&gt;
"><p>API Development Tools / SSE Task Management</p>
</div></div></div><div id="tag/SSE-Task-Management/operation/UserTasks::delete" data-section-id="tag/SSE-Task-Management/operation/UserTasks::delete" class="sc-dntaoT ceciOs"><div data-section-id="operation/UserTasks::delete" id="operation/UserTasks::delete" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSE-Task-Management/operation/UserTasks::delete" aria-label="tag/SSE-Task-Management/operation/UserTasks::delete"></a>Remove item from task queue </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function deletes a process from the user task queue.&lt;/p&gt;
&lt;p&gt;Each cPanel account uses a separate user task queue in order to ensure that
processes for one user do not impede another user on the server.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;For example, the &lt;a href=&quot;https://go.cpanel.net/GitVersionControl&quot;&gt;&lt;em&gt;Git Version Control&lt;/em&gt;&lt;/a&gt;
interface (&lt;em&gt;cPanel &amp;gt;&amp;gt; Home &amp;gt;&amp;gt; Files &amp;gt;&amp;gt; Git Version Control&lt;/em&gt;) uses the user task queue
to clone repositories (via the &lt;code&gt;VersionControl::create&lt;/code&gt; function).&lt;/li&gt;
&lt;li&gt;For more information, read our
&lt;a href=&quot;https://go.cpanel.net/whmdocsTaskQueueMonitor&quot;&gt;Task Queue Monitor&lt;/a&gt; documentation.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes a process from the user task queue.</p>
<p>Each cPanel account uses a separate user task queue in order to ensure that
processes for one user do not impede another user on the server.</p>
<ul>
<li>For example, the <a href="https://go.cpanel.net/GitVersionControl"><em>Git Version Control</em></a>
interface (<em>cPanel &gt;&gt; Home &gt;&gt; Files &gt;&gt; Git Version Control</em>) uses the user task queue
to clone repositories (via the <code>VersionControl::create</code> function).</li>
<li>For more information, read our
<a href="https://go.cpanel.net/whmdocsTaskQueueMonitor">Task Queue Monitor</a> documentation.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">id=00000000\/5a9ec8dd4c345d</span></div><div><div html="&lt;p&gt;The task&amp;#39;s ID number.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The task&#39;s ID number.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/UserTasks/delete</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/UserTasks/delete</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ab70q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ab70q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ab70q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab70q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2ab70q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab70q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2ab70q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab70q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ab70q:0" aria-labelledby="tab:R2ab70q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token parameter variable">--user</span><span class="token operator">=</span>username UserTasks delete <span class="token assign-left variable">id</span><span class="token operator">=</span><span class="token string">'00000000\/5a9ec8dd4c345d'</span></pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab70q:1" aria-labelledby="tab:R2ab70q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab70q:2" aria-labelledby="tab:R2ab70q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab70q:3" aria-labelledby="tab:R2ab70q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eb70q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eb70q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eb70q:0" aria-labelledby="tab:R2eb70q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;delete&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;UserTasks&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/SSE-Task-Management/operation/retrieve" data-section-id="tag/SSE-Task-Management/operation/retrieve" class="sc-dntaoT ceciOs"><div data-section-id="operation/retrieve" id="operation/retrieve" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSE-Task-Management/operation/retrieve" aria-label="tag/SSE-Task-Management/operation/retrieve"></a>Return task queue information </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves a cPanel account&amp;#39;s user task queue information.&lt;/p&gt;
&lt;p&gt;Each cPanel account uses a separate user task queue in order to ensure that
processes for one user do not impede another user on the server.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;For example, the &lt;a href=&quot;https://go.cpanel.net/GitVersionControl&quot;&gt;&lt;em&gt;Git Version Control&lt;/em&gt;&lt;/a&gt;
interface (&lt;em&gt;cPanel &amp;gt;&amp;gt; Home &amp;gt;&amp;gt; Files &amp;gt;&amp;gt; Git Version Control&lt;/em&gt;) uses the user task queue
to clone repositories (via the &lt;code&gt;VersionControl::create&lt;/code&gt; function).&lt;/li&gt;
&lt;li&gt;For more information, read our
&lt;a href=&quot;https://go.cpanel.net/whmdocsTaskQueueMonitor&quot;&gt;Task Queue Monitor&lt;/a&gt; documentation.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a cPanel account&#39;s user task queue information.</p>
<p>Each cPanel account uses a separate user task queue in order to ensure that
processes for one user do not impede another user on the server.</p>
<ul>
<li>For example, the <a href="https://go.cpanel.net/GitVersionControl"><em>Git Version Control</em></a>
interface (<em>cPanel &gt;&gt; Home &gt;&gt; Files &gt;&gt; Git Version Control</em>) uses the user task queue
to clone repositories (via the <code>VersionControl::create</code> function).</li>
<li>For more information, read our
<a href="https://go.cpanel.net/whmdocsTaskQueueMonitor">Task Queue Monitor</a> documentation.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/UserTasks/retrieve</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/UserTasks/retrieve</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ad70q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ad70q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ad70q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ad70q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2ad70q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ad70q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2ad70q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ad70q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ad70q:0" aria-labelledby="tab:R2ad70q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  UserTasks <span class="token punctuation">\</span>
  retrieve
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ad70q:1" aria-labelledby="tab:R2ad70q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ad70q:2" aria-labelledby="tab:R2ad70q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ad70q:3" aria-labelledby="tab:R2ad70q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ed70q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ed70q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ed70q:0" aria-labelledby="tab:R2ed70q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;retrieve&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;UserTasks&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"action"</span>: <span class="token string">&quot;create&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"args"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;00000000\\/5a9ec8dd4c345d&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subsystem"</span>: <span class="token string">&quot;VersionControl&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"action"</span>: <span class="token string">&quot;create&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"args"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"repository_root"</span>: <span class="token string">&quot;/home/user/public_html/example&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;00000000/h39dnn27suc13l&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subsystem"</span>: <span class="token string">&quot;VersionControl&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/URL-Parsing" data-section-id="tag/URL-Parsing" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/URL-Parsing" aria-label="tag/URL-Parsing"></a>URL Parsing</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;API Development Tools / URL Parsing&lt;/p&gt;
"><p>API Development Tools / URL Parsing</p>
</div></div></div><div id="tag/URL-Parsing/operation/fetch_url" data-section-id="tag/URL-Parsing/operation/fetch_url" class="sc-dntaoT ceciOs"><div data-section-id="operation/fetch_url" id="operation/fetch_url" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/URL-Parsing/operation/fetch_url" aria-label="tag/URL-Parsing/operation/fetch_url"></a>Return integrated application URL </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the URL for an integrated application.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the URL for an integrated application.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="app" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">app</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">app=applicationname</span></div><div><div html="&lt;p&gt;The application&amp;#39;s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The application&#39;s name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Integration/fetch_url</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Integration/fetch_url</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ab90q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ab90q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ab90q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab90q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2ab90q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab90q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2ab90q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab90q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ab90q:0" aria-labelledby="tab:R2ab90q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Integration <span class="token punctuation">\</span>
  fetch_url <span class="token punctuation">\</span>
  <span class="token assign-left variable">app</span><span class="token operator">=</span><span class="token string">'applicationname'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab90q:1" aria-labelledby="tab:R2ab90q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab90q:2" aria-labelledby="tab:R2ab90q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab90q:3" aria-labelledby="tab:R2ab90q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eb90q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eb90q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eb90q:0" aria-labelledby="tab:R2eb90q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;fetch_url&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Integration&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"redirect_url"</span>: <span class="token string">&quot;</span><a href="http://application.example.com/application">http://application.example.com/application</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">&quot;</span><a href="http://application.example.com/">http://application.example.com/</a><span class="token string">&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/URL-Parsing/operation/firstfile_relative_uri" data-section-id="tag/URL-Parsing/operation/firstfile_relative_uri" class="sc-dntaoT ceciOs"><div data-section-id="operation/firstfile_relative_uri" id="operation/firstfile_relative_uri" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/URL-Parsing/operation/firstfile_relative_uri" aria-label="tag/URL-Parsing/operation/firstfile_relative_uri"></a>Return session relative URI </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function reports the first file&amp;#39;s URI, relative to the cPanel base directory.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function reports the first file&#39;s URI, relative to the cPanel base directory.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Parser/firstfile_relative_uri</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Parser/firstfile_relative_uri</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ad90q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ad90q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ad90q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ad90q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2ad90q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ad90q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2ad90q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ad90q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ad90q:0" aria-labelledby="tab:R2ad90q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Parser <span class="token punctuation">\</span>
  firstfile_relative_uri
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ad90q:1" aria-labelledby="tab:R2ad90q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ad90q:2" aria-labelledby="tab:R2ad90q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ad90q:3" aria-labelledby="tab:R2ad90q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ed90q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ed90q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ed90q:0" aria-labelledby="tab:R2ed90q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;firstfile_relative_uri&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Parser&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"uri"</span>: <span class="token string">&quot;/usr/local/cpanel/base/favicon.ico&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/External-Authentication" data-section-id="tag/External-Authentication" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/External-Authentication" aria-label="tag/External-Authentication"></a>External Authentication</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Authentication / External Authentication&lt;/p&gt;
"><p>Authentication / External Authentication</p>
</div></div></div><div id="tag/External-Authentication/operation/add_authn_link" data-section-id="tag/External-Authentication/operation/add_authn_link" class="sc-dntaoT ceciOs"><div data-section-id="operation/add_authn_link" id="operation/add_authn_link" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/External-Authentication/operation/add_authn_link" aria-label="tag/External-Authentication/operation/add_authn_link"></a>Add external authentication link </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function adds an External Authentication authorization link to an account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function adds an External Authentication authorization link to an account.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="preferred_username" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">preferred_username</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">preferred_username=Example</span></div><div><div html="&lt;p&gt;The preferred username of the account on the identity provider.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The preferred username of the account on the identity provider.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="provider_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">provider_id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">provider_id=google</span></div><div><div html="&lt;p&gt;The name of the identity provider.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the identity provider.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="subject_unique_identifier" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">subject_unique_identifier</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">subject_unique_identifier=123456789012345678901</span></div><div><div html="&lt;p&gt;The unique identifier for the user at the identity provider.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The unique identifier for the user at the identity provider.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="username" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">username</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;username&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">username=example</span></div><div><div html="&lt;p&gt;The username.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/ExternalAuthentication/add_authn_link</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/ExternalAuthentication/add_authn_link</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a9j1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9j1a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9j1a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9j1a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2a9j1a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9j1a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2a9j1a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9j1a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9j1a:0" aria-labelledby="tab:R2a9j1a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  ExternalAuthentication <span class="token punctuation">\</span>
  add_authn_link <span class="token punctuation">\</span>
  <span class="token assign-left variable">username</span><span class="token operator">=</span><span class="token string">'example'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">provider_id</span><span class="token operator">=</span><span class="token string">'google'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">subject_unique_identifier</span><span class="token operator">=</span><span class="token string">'123456789012345678901'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">preferred_username</span><span class="token operator">=</span><span class="token string">'Example'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9j1a:1" aria-labelledby="tab:R2a9j1a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9j1a:2" aria-labelledby="tab:R2a9j1a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9j1a:3" aria-labelledby="tab:R2a9j1a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2e9j1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9j1a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9j1a:0" aria-labelledby="tab:R2e9j1a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;add_authn_link&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;ExternalAuthentication&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/External-Authentication/operation/configured_modules" data-section-id="tag/External-Authentication/operation/configured_modules" class="sc-dntaoT ceciOs"><div data-section-id="operation/configured_modules" id="operation/configured_modules" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/External-Authentication/operation/configured_modules" aria-label="tag/External-Authentication/operation/configured_modules"></a>Return server&#x27;s external authentication providers </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the display information for your server&amp;#39;s available and configured external authentication identity provider modules.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the display information for your server&#39;s available and configured external authentication identity provider modules.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/ExternalAuthentication/configured_modules</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/ExternalAuthentication/configured_modules</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aaj1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aaj1a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aaj1a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aaj1a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2aaj1a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aaj1a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2aaj1a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aaj1a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aaj1a:0" aria-labelledby="tab:R2aaj1a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  ExternalAuthentication <span class="token punctuation">\</span>
  configured_modules
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aaj1a:1" aria-labelledby="tab:R2aaj1a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aaj1a:2" aria-labelledby="tab:R2aaj1a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aaj1a:3" aria-labelledby="tab:R2aaj1a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eaj1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eaj1a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eaj1a:0" aria-labelledby="tab:R2eaj1a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;configured_modules&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;ExternalAuthentication&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"color"</span>: <span class="token string">&quot;00aef0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">&quot;cPanel ID&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"documentation_url"</span>: <span class="token string">&quot;</span><a href="https://go.cpanel.net/OpenIDConnect">https://go.cpanel.net/OpenIDConnect</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon"</span>: <span class="token string">&quot;iVBORw0KGgoAAAANSUhEUgAAACMAAAAhCAYAAABTERJSAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDoxMTNFRUVGMzIyODUxMUU1OUM1RERGODcwRjIwNTQ4MCIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDoxMTNFRUVGNDIyODUxMUU1OUM1RERGODcwRjIwNTQ4MCI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOjExM0VFRUYxMjI4NTExRTU5QzVEREY4NzBGMjA1NDgwIiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOjExM0VFRUYyMjI4NTExRTU5QzVEREY4NzBGMjA1NDgwIi8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+oa0v2AAAA3VJREFUeNrsWM1uFEcQruqent3Z9Y43DmuD2YT1LoIICSIgEULKC+SaF8gr5JAnyD3XKCcChxxyyhNYiFMU5ZRTzE8UuGCQY8DGeGd3Zqrydc/ajiWjBHCEpWxLPf1T01VfV/d09TesqnRUUuQfN+5tUzMylAsRM9EOPlTJV0V9qWQg3BgLXek4+mUtpxKy+bqhAvIcLxVSlT4FHVAQITegO7Z8vGFpqeW4P+N40Iy434rNR23Hcd3ymV0wL00TNIJH6UsY2syVsrICuTlWGFJyAJlYrtVj7jUi9gZhzPQSS4tJRO+1nF1C/aThoHFfgp7n+zzjZ+GNjUWDB7yHRPYAQQnV8MCMOu04ughvPEbzztV599UHbXvOGe7OwHhsKH3jZdrKiZwhgrtcYs0ilJ6A4ffhytMpZtmAa/3s4OYuQFhg/m75IX1xtm2/XKjbw90zn3Zr19+p81W4dr5mqP0vxslkOx3+Bu6n9jOsROttf02GjlCagpmCmYI5VDD8GuP0tYYdHP72HXq3N4prTcfHEA6ev8ir2OSjLwK0jkvRoRAjNmlkFG1aGAktPxrK6NZq/o3lwh1POPtkIQ4ncqm7Y2lcqua4o4zKKr4h66ggLrSSo2zinfUrnXgPzM9r+c0P51wySE22NhTBNUEQnVGqbuZSrm6LXJhzMkit/JmVdfT/vl1QcXej+H4r91cLyrtNW/ZmrG4AydORytMRyrHXpfJgq5TL70Zy+Vgs97JCnwS5yhOgRD3fAUP+coW8qa+Q4Kxr3/72Il0dFqEtPsuubLctupdflqSyHXBEkzvFq26AfYGS/7b4hg/YDNNPewpmCuZ/DwYn5I/rI7mLY/7ZW2eUy6ujz/0ZBZoSz8a8CB50ohkRqIo57QkZiNhS6mw/qaiKwYHmySXzfwGmorZKw1LGOjb3s7K8r8o/CRXhIPXZU9Sa5Q441aVByz5CoMtXnpVfyyydQ4DtQt4DzXkjhsE+JvzwRxZ4smeToKehHpgtVzxbAuPUwDwR2Oj8XES/rueB5nbqDJCeBJo6xvZmQG8bEQ1mY3Mqifgk+jzb9H3dgzzp6S3603/m2hOv+OwmRDnFTQHLFdaphWAL8h68mpWSbRW08lBoxf8I8IQfohCrEu9VLD1Yqmel/TQOSz5oxfzxrDN2h5TyUfolcqQ+7b8EGACd0Ob6pUnq9QAAAABJRU5ErkJggg==&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon_type"</span>: <span class="token string">&quot;image/svg+xml&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Log in with a cPanel ID Account&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"link"</span>: <span class="token string">&quot;</span><a href="https://hostname.example.com:2083/openid_connect/cpanelid">https://hostname.example.com:2083/openid_connect/cpanelid</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_name"</span>: <span class="token string">&quot;cpanelid&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"textcolor"</span>: <span class="token string">&quot;FFFFFF&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/External-Authentication/operation/has_external_auth_modules_configured" data-section-id="tag/External-Authentication/operation/has_external_auth_modules_configured" class="sc-dntaoT ceciOs"><div data-section-id="operation/has_external_auth_modules_configured" id="operation/has_external_auth_modules_configured" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/External-Authentication/operation/has_external_auth_modules_configured" aria-label="tag/External-Authentication/operation/has_external_auth_modules_configured"></a>Return external authentication user status </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function determines whether the user enabled external authentication modules.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function determines whether the user enabled external authentication modules.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/ExternalAuthentication/has_external_auth_modules_configured</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/ExternalAuthentication/has_external_auth_modules_configured</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2abj1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abj1a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abj1a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abj1a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2abj1a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abj1a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2abj1a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abj1a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abj1a:0" aria-labelledby="tab:R2abj1a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  ExternalAuthentication <span class="token punctuation">\</span>
  has_external_auth_modules_configured
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abj1a:1" aria-labelledby="tab:R2abj1a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abj1a:2" aria-labelledby="tab:R2abj1a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abj1a:3" aria-labelledby="tab:R2abj1a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ebj1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebj1a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebj1a:0" aria-labelledby="tab:R2ebj1a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;has_external_auth_modules_configured&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;ExternalAuthentication&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/External-Authentication/operation/remove_authn_link" data-section-id="tag/External-Authentication/operation/remove_authn_link" class="sc-dntaoT ceciOs"><div data-section-id="operation/remove_authn_link" id="operation/remove_authn_link" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/External-Authentication/operation/remove_authn_link" aria-label="tag/External-Authentication/operation/remove_authn_link"></a>Remove external authentication link </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function removes a link to an account at an external authentication identity provider.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes a link to an account at an external authentication identity provider.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="provider" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">provider</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">provider=cpanelid</span></div><div><div html="&lt;p&gt;The name of the identity provider.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the identity provider.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="subject_unique_identifier" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">subject_unique_identifier</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">subject_unique_identifier=123456789012345678901</span></div><div><div html="&lt;p&gt;The unique identifier for the user at the identity provider.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The unique identifier for the user at the identity provider.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/ExternalAuthentication/remove_authn_link</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/ExternalAuthentication/remove_authn_link</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2acj1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2acj1a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2acj1a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acj1a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2acj1a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acj1a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2acj1a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acj1a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2acj1a:0" aria-labelledby="tab:R2acj1a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  ExternalAuthentication <span class="token punctuation">\</span>
  remove_authn_link <span class="token punctuation">\</span>
  <span class="token assign-left variable">provider</span><span class="token operator">=</span><span class="token string">'cpanelid'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">subject_unique_identifier</span><span class="token operator">=</span><span class="token string">'123456789012345678901'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acj1a:1" aria-labelledby="tab:R2acj1a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acj1a:2" aria-labelledby="tab:R2acj1a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acj1a:3" aria-labelledby="tab:R2acj1a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ecj1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ecj1a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ecj1a:0" aria-labelledby="tab:R2ecj1a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;remove_authn_link&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;ExternalAuthentication&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/External-Authentication/operation/get_authn_links" data-section-id="tag/External-Authentication/operation/get_authn_links" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_authn_links" id="operation/get_authn_links" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/External-Authentication/operation/get_authn_links" aria-label="tag/External-Authentication/operation/get_authn_links"></a>Return external authentication links </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the external authentication links to the current cPanel account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the external authentication links to the current cPanel account.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/ExternalAuthentication/get_authn_links</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/ExternalAuthentication/get_authn_links</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2adj1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2adj1a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2adj1a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adj1a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2adj1a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adj1a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2adj1a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adj1a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2adj1a:0" aria-labelledby="tab:R2adj1a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  ExternalAuthentication <span class="token punctuation">\</span>
  get_authn_links
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adj1a:1" aria-labelledby="tab:R2adj1a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adj1a:2" aria-labelledby="tab:R2adj1a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adj1a:3" aria-labelledby="tab:R2adj1a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2edj1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2edj1a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2edj1a:0" aria-labelledby="tab:R2edj1a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_authn_links&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;ExternalAuthentication&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"link_time"</span>: <span class="token number">1443124604</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"preferred_username"</span>: <span class="token string">&quot;username@gmail.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_id"</span>: <span class="token string">&quot;google&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_protocol"</span>: <span class="token string">&quot;openid_connect&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject_unique_identifier"</span>: <span class="token number">123456789012346</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Two-Factor-Settings" data-section-id="tag/Two-Factor-Settings" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Two-Factor-Settings" aria-label="tag/Two-Factor-Settings"></a>Two-Factor Settings</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Authentication / Two-Factor Settings&lt;/p&gt;
"><p>Authentication / Two-Factor Settings</p>
</div></div></div><div id="tag/Two-Factor-Settings/operation/generate_user_configuration" data-section-id="tag/Two-Factor-Settings/operation/generate_user_configuration" class="sc-dntaoT ceciOs"><div data-section-id="operation/generate_user_configuration" id="operation/generate_user_configuration" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Two-Factor-Settings/operation/generate_user_configuration" aria-label="tag/Two-Factor-Settings/operation/generate_user_configuration"></a>Create 2FA authentication code </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function generates an authentication code to enable configuration of two-factor authentication.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function generates an authentication code to enable configuration of two-factor authentication.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/TwoFactorAuth/generate_user_configuration</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/TwoFactorAuth/generate_user_configuration</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a9l1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9l1a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9l1a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9l1a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2a9l1a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9l1a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2a9l1a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9l1a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9l1a:0" aria-labelledby="tab:R2a9l1a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  TwoFactorAuth <span class="token punctuation">\</span>
  generate_user_configuration
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9l1a:1" aria-labelledby="tab:R2a9l1a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9l1a:2" aria-labelledby="tab:R2a9l1a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9l1a:3" aria-labelledby="tab:R2a9l1a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2e9l1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9l1a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9l1a:0" aria-labelledby="tab:R2e9l1a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;generate_user_configuration&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;TwoFactorAuth&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"otpauth_str"</span>: <span class="token string">&quot;otpauth://totp/Example%20cPanel%20L.L.C.:fakedomain?secret=S3I4WUY7MTHRMMWN&amp;issuer=Example%20cPanel%20L.L.C.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"secret"</span>: <span class="token string">&quot;S3I4WUY7MTHRMMWN&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Two-Factor-Settings/operation/get_team_user_configuration" data-section-id="tag/Two-Factor-Settings/operation/get_team_user_configuration" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_team_user_configuration" id="operation/get_team_user_configuration" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Two-Factor-Settings/operation/get_team_user_configuration" aria-label="tag/Two-Factor-Settings/operation/get_team_user_configuration"></a>Return team user 2FA config </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves a &lt;a href=&quot;https://go.cpanel.net/manage-team&quot;&gt;team user&amp;#39;s&lt;/a&gt; configuration settings for two-factor authentication.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a <a href="https://go.cpanel.net/manage-team">team user&#39;s</a> configuration settings for two-factor authentication.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="team_user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">team_user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">team_user=user@example.com</span></div><div><div html="&lt;p&gt;The team user&amp;#39;s username.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;The username will always precede the cPanel account&amp;#39;s primary domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The team user&#39;s username.</p>
<p><strong>Note:</strong></p>
<p>The username will always precede the cPanel account&#39;s primary domain.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/TwoFactorAuth/get_team_user_configuration</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/TwoFactorAuth/get_team_user_configuration</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aal1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aal1a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aal1a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aal1a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2aal1a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aal1a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2aal1a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aal1a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aal1a:0" aria-labelledby="tab:R2aal1a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  TwoFactorAuth <span class="token punctuation">\</span>
  get_team_user_configuration <span class="token punctuation">\</span>
  <span class="token assign-left variable">team_user</span><span class="token operator">=</span>teamuser
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aal1a:1" aria-labelledby="tab:R2aal1a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aal1a:2" aria-labelledby="tab:R2aal1a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aal1a:3" aria-labelledby="tab:R2aal1a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eal1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eal1a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eal1a:0" aria-labelledby="tab:R2eal1a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_team_user_configuration&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;TwoFactorAuth&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"is_enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer"</span>: <span class="token string">&quot;Example WebPros International, LLC&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Two-Factor-Settings/operation/get_user_configuration" data-section-id="tag/Two-Factor-Settings/operation/get_user_configuration" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_user_configuration" id="operation/get_user_configuration" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Two-Factor-Settings/operation/get_user_configuration" aria-label="tag/Two-Factor-Settings/operation/get_user_configuration"></a>Return cPanel account 2FA config </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves the cPanel account user&amp;#39;s configuration settings for two-factor authentication.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the cPanel account user&#39;s configuration settings for two-factor authentication.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/TwoFactorAuth/get_user_configuration</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/TwoFactorAuth/get_user_configuration</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2abl1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abl1a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abl1a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abl1a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2abl1a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abl1a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2abl1a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abl1a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abl1a:0" aria-labelledby="tab:R2abl1a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  TwoFactorAuth <span class="token punctuation">\</span>
  get_user_configuration
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abl1a:1" aria-labelledby="tab:R2abl1a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abl1a:2" aria-labelledby="tab:R2abl1a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abl1a:3" aria-labelledby="tab:R2abl1a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ebl1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebl1a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebl1a:0" aria-labelledby="tab:R2ebl1a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_user_configuration&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;TwoFactorAuth&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"is_enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer"</span>: <span class="token string">&quot;Example WebPros International, LLC&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Two-Factor-Settings/operation/set_user_configuration" data-section-id="tag/Two-Factor-Settings/operation/set_user_configuration" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_user_configuration" id="operation/set_user_configuration" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Two-Factor-Settings/operation/set_user_configuration" aria-label="tag/Two-Factor-Settings/operation/set_user_configuration"></a>Save 2FA config </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function configures the two-factor authentication settings for an account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function configures the two-factor authentication settings for an account.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="secret" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">secret</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &lt;= 16 characters </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">secret=JBSWY3DPEHPK3PXP</span></div><div><div html="&lt;p&gt;The 16-character string that UAPI&amp;#39;s &lt;code&gt;TwoFactorAuth::generate_user_configuration&lt;/code&gt; function generates.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The 16-character string that UAPI&#39;s <code>TwoFactorAuth::generate_user_configuration</code> function generates.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="tfa_token" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">tfa_token</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &lt;= 6 characters </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">tfa_token=528112</span></div><div><div html="&lt;p&gt;The six-digit security code that the time-based one-time password (TOTP) authentication app generates.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The six-digit security code that the time-based one-time password (TOTP) authentication app generates.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/TwoFactorAuth/set_user_configuration</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/TwoFactorAuth/set_user_configuration</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2acl1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2acl1a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2acl1a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acl1a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2acl1a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acl1a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2acl1a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acl1a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2acl1a:0" aria-labelledby="tab:R2acl1a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  TwoFactorAuth <span class="token punctuation">\</span>
  set_user_configuration <span class="token punctuation">\</span>
  <span class="token assign-left variable">secret</span><span class="token operator">=</span><span class="token string">'JBSWY3DPEHPK3PXP'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">tfa_token</span><span class="token operator">=</span><span class="token string">'528112'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acl1a:1" aria-labelledby="tab:R2acl1a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acl1a:2" aria-labelledby="tab:R2acl1a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acl1a:3" aria-labelledby="tab:R2acl1a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ecl1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ecl1a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ecl1a:0" aria-labelledby="tab:R2ecl1a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_user_configuration&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;TwoFactorAuth&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"tfa_configured"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Two-Factor-Settings/operation/remove_user_configuration" data-section-id="tag/Two-Factor-Settings/operation/remove_user_configuration" class="sc-dntaoT ceciOs"><div data-section-id="operation/remove_user_configuration" id="operation/remove_user_configuration" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Two-Factor-Settings/operation/remove_user_configuration" aria-label="tag/Two-Factor-Settings/operation/remove_user_configuration"></a>Remove 2FA config </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function removes the user from the two-factor authentication &lt;code&gt;userdata&lt;/code&gt; file.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes the user from the two-factor authentication <code>userdata</code> file.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/TwoFactorAuth/remove_user_configuration</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/TwoFactorAuth/remove_user_configuration</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2adl1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2adl1a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2adl1a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adl1a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2adl1a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adl1a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2adl1a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adl1a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2adl1a:0" aria-labelledby="tab:R2adl1a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  TwoFactorAuth <span class="token punctuation">\</span>
  remove_user_configuration
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adl1a:1" aria-labelledby="tab:R2adl1a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adl1a:2" aria-labelledby="tab:R2adl1a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adl1a:3" aria-labelledby="tab:R2adl1a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2edl1a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2edl1a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2edl1a:0" aria-labelledby="tab:R2edl1a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;remove_user_configuration&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;TwoFactorAuth&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"tfa_removed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Block-IP" data-section-id="tag/Block-IP" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Block-IP" aria-label="tag/Block-IP"></a>Block IP</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Block Ip Addresses / Block IP&lt;/p&gt;
"><p>Block Ip Addresses / Block IP</p>
</div></div></div><div id="tag/Block-IP/operation/blockip-add-ip" data-section-id="tag/Block-IP/operation/blockip-add-ip" class="sc-dntaoT ceciOs"><div data-section-id="operation/blockip-add-ip" id="operation/blockip-add-ip" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Block-IP/operation/blockip-add-ip" aria-label="tag/Block-IP/operation/blockip-add-ip"></a>Add IP address to cPanel account&#x27;s block list </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function blocks IP addresses from accessing the domains on a cPanel account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the Web Server role, the system disables this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function blocks IP addresses from accessing the domains on a cPanel account.</p>
<p><strong>Important</strong></p>
<p>When you disable the Web Server role, the system disables this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="ip" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">ip</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ip=192.168.0.1/16</span> - CIDR Format IPv4</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ip=2001:db8::/32</span> - CIDR Format IPv6</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ip=example.com</span> - Add by resolving hostname</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ip=192.168.0.1-58</span> - Implied Range</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ip=192.168.0.1-192.168.0.58</span> - IPv4 Range</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ip=2001:db8::1-2001:db8::3</span> - IPv6 Range</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ip=192.0.2.0</span> - Single IPv4 Address</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ip=2001:db8::1</span> - Single IPv6 Address</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ip=10.</span> - Subnet Range - Matches 10.*.*.*</li></ul><div><div html="&lt;p&gt;The IP address or IP address range that you wish to block.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The IP address or IP address range that you wish to block.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/BlockIP/add_ip</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/BlockIP/add_ip</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riir1q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riir1q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riir1q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riir1q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riir1q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riir1q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riir1q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riir1q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riir1q:0" aria-labelledby="tab:Riir1q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  BlockIP <span class="token punctuation">\</span>
  add_ip <span class="token punctuation">\</span>
  <span class="token assign-left variable">ip</span><span class="token operator">=</span><span class="token string">'192.168.0.1/16'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riir1q:1" aria-labelledby="tab:Riir1q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riir1q:2" aria-labelledby="tab:Riir1q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riir1q:3" aria-labelledby="tab:Riir1q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjir1q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjir1q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjir1q:0" aria-labelledby="tab:Rjir1q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;add_ip&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;BlockIP&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;1.1.1.1&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Block-IP/operation/blockip-remove-ip" data-section-id="tag/Block-IP/operation/blockip-remove-ip" class="sc-dntaoT ceciOs"><div data-section-id="operation/blockip-remove-ip" id="operation/blockip-remove-ip" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Block-IP/operation/blockip-remove-ip" aria-label="tag/Block-IP/operation/blockip-remove-ip"></a>Remove IP address from cPanel account&#x27;s block list </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function unblocks IP addresses from accessing domains on a cPanel account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the Web Server role, the system disables this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function unblocks IP addresses from accessing domains on a cPanel account.</p>
<p><strong>Important</strong></p>
<p>When you disable the Web Server role, the system disables this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="ip" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">ip</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ip=192.168.0.1/16</span> - CIDR Format IPv4</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ip=2001:db8::/32</span> - CIDR Format IPv6</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ip=example.com</span> - Add by resolving hostname</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ip=192.168.0.1-58</span> - Implied Range</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ip=192.168.0.1-192.168.0.58</span> - IPv4 Range</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ip=2001:db8::1-2001:db8::3</span> - IPv6 Range</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ip=192.0.2.0</span> - Single IPv4 Address</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ip=2001:db8::1</span> - Single IPv6 Address</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ip=10.</span> - Subnet Range - Matches 10.*.*.*</li></ul><div><div html="&lt;p&gt;The IP address or IP address range that you wish to unblock.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The IP address or IP address range that you wish to unblock.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/BlockIP/remove_ip</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/BlockIP/remove_ip</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rijb1q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rijb1q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rijb1q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijb1q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rijb1q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijb1q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rijb1q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijb1q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rijb1q:0" aria-labelledby="tab:Rijb1q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  BlockIP <span class="token punctuation">\</span>
  remove_ip <span class="token punctuation">\</span>
  <span class="token assign-left variable">ip</span><span class="token operator">=</span><span class="token string">'192.168.0.1/16'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijb1q:1" aria-labelledby="tab:Rijb1q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijb1q:2" aria-labelledby="tab:Rijb1q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijb1q:3" aria-labelledby="tab:Rijb1q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjjb1q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjjb1q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjjb1q:0" aria-labelledby="tab:Rjjb1q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;remove_ip&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;BlockIP&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;1.1.1.1&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Market-Integration" data-section-id="tag/Market-Integration" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Market-Integration" aria-label="tag/Market-Integration"></a>Market Integration</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Commerce Integration / Market Integration&lt;/p&gt;
"><p>Commerce Integration / Market Integration</p>
</div></div></div><div id="tag/Market-Integration/operation/Market-get_all_products" data-section-id="tag/Market-Integration/operation/Market-get_all_products" class="sc-dntaoT ceciOs"><div data-section-id="operation/Market-get_all_products" id="operation/Market-get_all_products" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Market-Integration/operation/Market-get_all_products" aria-label="tag/Market-Integration/operation/Market-get_all_products"></a>Return provider&#x27;s available products </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists all products available through all enabled cPanel Market providers.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists all products available through all enabled cPanel Market providers.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Market/get_all_products</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Market/get_all_products</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a9j2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9j2a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9j2a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9j2a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2a9j2a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9j2a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2a9j2a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9j2a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9j2a:0" aria-labelledby="tab:R2a9j2a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Market <span class="token punctuation">\</span>
  get_all_products
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9j2a:1" aria-labelledby="tab:R2a9j2a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9j2a:2" aria-labelledby="tab:R2a9j2a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9j2a:3" aria-labelledby="tab:R2a9j2a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2e9j2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9j2a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9j2a:0" aria-labelledby="tab:R2e9j2a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div html="&lt;p&gt;product_group=ssl_certificate&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>product_group=ssl_certificate</p>
</div><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_all_products&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Market&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"base_name"</span>: <span class="token string">&quot;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"billing_type"</span>: <span class="token string">&quot;one-time&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">&quot;An extended-validated (EV) SSL certificate signed by COMODO.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">&quot;Comodo EV SSL Certificate&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon"</span>: <span class="token string">&quot;PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iNTUwIiB3aWR0aD0iNDE3LjE2Ij48ZyBmaWxsPSIjMzViNTZjIj48cGF0aCBkPSJNNDE0LjM5NiAyNmM3LTExIDAtMjYtMTMtMjZIMTg3LjM5NWMtNDUgMC04MSAxMi0xMDcgMzZzLTQyIDU4LTQ2IDEwM2wtMTAgMTE2Yy00IDQ1IDUgNzkgMjggMTAzIDIyIDI0IDU2IDM2IDEwMSAzNmg0OXYtMWM5LjAwMS0xIDE1LjAwMS03IDE2LjAwMS0xN2w1LTU3YzAtMTEtNy0xOS0xOC4wMDEtMTloLTI3Yy0xNyAwLTMwLTQtMzctMTItNy03LTEwLTIwLTgtMzlsOS0xMDRjMi0xOCA3LTMxIDE1LTM5czIxLTEyIDM5LTEyaDE0NC4wMDFjMTcgMCAzNC05IDQ0LTIzbDMwLTQ1Ii8+PHBhdGggZD0iTTMuMzk1IDUyNGMtOCAxMS0xIDI2IDEyIDI2aDIxNy4wMDFjNDUgMCA4MS0xMiAxMDgtMzYgMjYtMjQgNDEtNTggNDUtMTAybDExLTExN2MzLTQ1LTYtNzktMjgtMTAzLTIzLTI0LTU2LTM2LTEwMS0zNmgtNDl2MWMtMTAuMDAxIDEtMTUuMDAxIDctMTYuMDAxIDE3bC01IDU4Yy0xIDEwIDcgMTggMTcuMDAxIDE4aDI3YzE4IDAgMzAgNCAzNyAxMnMxMCAyMSA5IDM5bC0xMCAxMDRjLTEgMTktNiAzMi0xNCAzOS05IDgtMjIgMTItNDAgMTJINzYuMzk1Yy0xNyAwLTMzIDktNDMgMjRsLTMwIDQ0Ii8+PC9nPjwvc3ZnPg==&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon_mime_type"</span>: <span class="token string">&quot;image/svg+xml&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"license_term"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_users"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maximum_server_price"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"minimum_server_price"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"price"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"price_unit"</span>: <span class="token string">&quot;USD&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product"</span>: <span class="token string">&quot;Comodo EV Certificate&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_category"</span>: <span class="token string">&quot;N/A&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_group"</span>: <span class="token string">&quot;ssl_certificate&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_id"</span>: <span class="token number">155</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_display_name"</span>: <span class="token string">&quot;cPanel Store&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_name"</span>: <span class="token string">&quot;cPStore&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"recommended"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"requires_ip"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_certificate_term"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">1</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;year&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_identity_verification"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Organization Name&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;organizationName&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"is_optional"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Department Name&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;organizationalUnitName&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">&quot;9 consecutive digits or “##-###-####” (More information (https://go.cpanel.net/get_duns))&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_optional"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Dun &amp; Bradstreet D-U-N-S (Data Universal Numbering System) Number&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;duns_number&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pattern"</span>: <span class="token string">&quot;^[0-9]{2}(?:-[0-9]{3}-[0-9]{4}|[0-9]{7})$&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Street Address&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;streetAddress&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;City&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;localityName&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;State or Province&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;stateOrProvinceName&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Postal Code&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;postalCode&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Country Code&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;countryName&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;country_code&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Representative’s Given (First) Name&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;rep_forename&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Representative’s Surname (Last Name)&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;rep_surname&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Representative’s Email Address&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;rep_email_address&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;email&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">&quot;This should be one of the organization’s publicly-listed telephone numbers.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_optional"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Representative’s Telephone Number&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;rep_telephone&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;tel&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">&quot;Consult the EV SSL Certificate Guidelines (https://cabforum.org/extended-validation/) for more information about this field’s options.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Business Category&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;business_category&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"options"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;b&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;Incorporated Business (“Private Organization”)&quot;</span></div></li></ul><span class="token punctuation">]</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;d&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;Non-incorporated Business (“Business Entity”)&quot;</span></div></li></ul><span class="token punctuation">]</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;c&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;Government Entity (“Government Entity”)&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;choose_one&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"is_optional"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;City Where Incorporated (JOI (Jurisdiction of Incorporation))&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;joi_locality_name&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"is_optional"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;State or Province Where Incorporated (JOI (Jurisdiction of Incorporation))&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;joi_state_or_province_name&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Country Code Where Incorporated (JOI (Jurisdiction of Incorporation))&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;joi_country_name&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;country_code&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"is_optional"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Date of Incorporation&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;date_of_incorporation&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;date&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"is_optional"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Assumed Name (DBA (Doing Business As))&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;assumed_name&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_max_http_redirects"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_payment_trigger"</span>: <span class="token string">&quot;checkout&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_price_per_domain"</span>: <span class="token number">108</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_price_per_domain_maximum"</span>: <span class="token number">1080</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_price_per_domain_minimum"</span>: <span class="token number">108</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_ssl_per_domain_pricing"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_supports_dns_dcv"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_validation_type"</span>: <span class="token string">&quot;ev&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_warn_after"</span>: <span class="token number">604800</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"base_name"</span>: <span class="token string">&quot;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"billing_type"</span>: <span class="token string">&quot;one-time&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">&quot;An organization-validated (OV) SSL certificate signed by COMODO.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">&quot;Comodo OV SSL Certificate&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon"</span>: <span class="token string">&quot;PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iNTUwIiB3aWR0aD0iNDE3LjE2Ij48ZyBmaWxsPSIjMzViNTZjIj48cGF0aCBkPSJNNDE0LjM5NiAyNmM3LTExIDAtMjYtMTMtMjZIMTg3LjM5NWMtNDUgMC04MSAxMi0xMDcgMzZzLTQyIDU4LTQ2IDEwM2wtMTAgMTE2Yy00IDQ1IDUgNzkgMjggMTAzIDIyIDI0IDU2IDM2IDEwMSAzNmg0OXYtMWM5LjAwMS0xIDE1LjAwMS03IDE2LjAwMS0xN2w1LTU3YzAtMTEtNy0xOS0xOC4wMDEtMTloLTI3Yy0xNyAwLTMwLTQtMzctMTItNy03LTEwLTIwLTgtMzlsOS0xMDRjMi0xOCA3LTMxIDE1LTM5czIxLTEyIDM5LTEyaDE0NC4wMDFjMTcgMCAzNC05IDQ0LTIzbDMwLTQ1Ii8+PHBhdGggZD0iTTMuMzk1IDUyNGMtOCAxMS0xIDI2IDEyIDI2aDIxNy4wMDFjNDUgMCA4MS0xMiAxMDgtMzYgMjYtMjQgNDEtNTggNDUtMTAybDExLTExN2MzLTQ1LTYtNzktMjgtMTAzLTIzLTI0LTU2LTM2LTEwMS0zNmgtNDl2MWMtMTAuMDAxIDEtMTUuMDAxIDctMTYuMDAxIDE3bC01IDU4Yy0xIDEwIDcgMTggMTcuMDAxIDE4aDI3YzE4IDAgMzAgNCAzNyAxMnMxMCAyMSA5IDM5bC0xMCAxMDRjLTEgMTktNiAzMi0xNCAzOS05IDgtMjIgMTItNDAgMTJINzYuMzk1Yy0xNyAwLTMzIDktNDMgMjRsLTMwIDQ0Ii8+PC9nPjwvc3ZnPg==&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon_mime_type"</span>: <span class="token string">&quot;image/svg+xml&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"license_term"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_users"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maximum_server_price"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"minimum_server_price"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"price"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"price_unit"</span>: <span class="token string">&quot;USD&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product"</span>: <span class="token string">&quot;Comodo OV Certificate&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_category"</span>: <span class="token string">&quot;N/A&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_group"</span>: <span class="token string">&quot;ssl_certificate&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_id"</span>: <span class="token number">217</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_display_name"</span>: <span class="token string">&quot;cPanel Store&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_name"</span>: <span class="token string">&quot;cPStore&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"recommended"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"requires_ip"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_certificate_term"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">1</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;year&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_identity_verification"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Organization Name&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;organizationName&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"is_optional"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Department Name&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;organizationalUnitName&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">&quot;9 consecutive digits or “##-###-####” (More information (https://go.cpanel.net/get_duns))&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_optional"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Dun &amp; Bradstreet D-U-N-S (Data Universal Numbering System) Number&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;duns_number&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pattern"</span>: <span class="token string">&quot;^[0-9]{2}(?:-[0-9]{3}-[0-9]{4}|[0-9]{7})$&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Street Address&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;streetAddress&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;City&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;localityName&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;State or Province&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;stateOrProvinceName&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Postal Code&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;postalCode&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Country Code&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;countryName&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;country_code&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Representative’s Given (First) Name&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;rep_forename&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Representative’s Surname (Last Name)&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;rep_surname&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Representative’s Email Address&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;rep_email_address&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;email&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">&quot;This should be one of the organization’s publicly-listed telephone numbers.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_optional"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Representative’s Telephone Number&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;rep_telephone&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;tel&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_max_http_redirects"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_payment_trigger"</span>: <span class="token string">&quot;checkout&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_price_per_domain"</span>: <span class="token number">36</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_price_per_domain_maximum"</span>: <span class="token number">360</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_price_per_domain_minimum"</span>: <span class="token number">36</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_price_per_wildcard_domain"</span>: <span class="token string">&quot;150.00&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_price_per_wildcard_domain_maximum"</span>: <span class="token string">&quot;1500.00&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_price_per_wildcard_domain_minimum"</span>: <span class="token string">&quot;150.00&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_ssl_per_domain_pricing"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_supports_dns_dcv"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_validation_type"</span>: <span class="token string">&quot;ov&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_warn_after"</span>: <span class="token number">604800</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_wildcard_parent_domain_free"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"base_name"</span>: <span class="token string">&quot;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"billing_type"</span>: <span class="token string">&quot;one-time&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">&quot;A domain-validated (DV) SSL certificate signed by cPanel.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">&quot;cPanel DV SSL Certificate&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon"</span>: <span class="token string">&quot;PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzNTlwdCIgaGVpZ2h0PSIzMjAiIHZpZXdCb3g9IjAgMCAzNTkgMjQwIj48ZGVmcz48Y2xpcFBhdGggaWQ9ImEiPjxwYXRoIGQ9Ik0xMjMgMGgyMzUuMzd2MjQwSDEyM3ptMCAwIi8+PC9jbGlwUGF0aD48L2RlZnM+PHBhdGggZD0iTTg5LjY5IDU5LjEwMmg2Ny44MDJsLTEwLjUgNDAuMmMtMS42MDUgNS42LTQuNjA1IDEwLjEtOSAxMy41LTQuNDAyIDMuNC05LjUwNCA1LjA5Ni0xNS4zIDUuMDk2aC0zMS41Yy03LjIgMC0xMy41NSAyLjEwMi0xOS4wNSA2LjMtNS41MDUgNC4yLTkuMzUzIDkuOTA0LTExLjU1MiAxNy4xMDMtMS40IDUuNDAzLTEuNTUgMTAuNS0uNDUgMTUuMzAyIDEuMDk4IDQuNzk2IDMuMDQ3IDkuMDUgNS44NTIgMTIuNzUgMi43OTcgMy43MDMgNi40IDYuNjUyIDEwLjc5NyA4Ljg1IDQuMzk3IDIuMiA5LjE5OCAzLjI5OCAxNC40IDMuMjk4aDE5LjJjMy42MDIgMCA2LjU0NyAxLjQ1MyA4Ljg1MiA0LjM1MiAyLjI5NyAyLjkwMiAyLjk0NSA2LjE0OCAxLjk1IDkuNzVsLTEyIDQ0LjM5OGgtMjFjLTE0LjQwMyAwLTI3LjY1My0zLjE0OC0zOS43NS05LjQ1LTEyLjEwMi02LjMtMjIuMTUzLTE0LjY0OC0zMC4xNTMtMjUuMDUtOC0xMC4zOTUtMTMuNDU0LTIyLjI0Ni0xNi4zNS0zNS41NDctMi45LTEzLjMtMi41NS0yNi45NSAxLjA1Mi00MC45NTNsMS4yLTQuNWMyLjU5Ny05LjYwMiA2LjY0OC0xOC40NSAxMi4xNDgtMjYuNTUgNS41LTguMDk4IDEyLTE1IDE5LjUtMjAuNyA3LjUtNS43IDE1Ljg1LTEwLjE0OCAyNS4wNS0xMy4zNTIgOS4yLTMuMTk1IDE4Ljc5Ny00Ljc5NiAyOC44LTQuNzk2IiBmaWxsPSIjZmY2YzJjIi8+PGcgY2xpcC1wYXRoPSJ1cmwoI2EpIj48cGF0aCBkPSJNMTIzLjg5IDI0MEwxODIuOTkgMTguNjAyYzEuNTk4LTUuNTk4IDQuNTk4LTEwLjA5OCA5LTEzLjVDMTk2LjM4OCAxLjcgMjAxLjQ4NCAwIDIwNy4yODggMGg2Mi43YzE0LjQwMyAwIDI3LjY1IDMuMTQ4IDM5Ljc1IDkuNDUgMTIuMTAyIDYuMyAyMi4xNTMgMTQuNjU1IDMwLjE1MyAyNS4wNSA3Ljk5NyAxMC40MDIgMTMuNSAyMi4yNTQgMTYuNSAzNS41NSAzIDEzLjMwNSAyLjU5NCAyNi45NTQtMS4yMDIgNDAuOTVsLTEuMiA0LjVjLTIuNTk3IDkuNjAyLTYuNTk3IDE4LjQ1LTEyIDI2LjU1LTUuMzk4IDguMDk4LTExLjg0NyAxNS4wNTItMTkuMzQ3IDIwLjg0OC03LjUgNS44MDUtMTUuODU1IDEwLjMwNS0yNS4wNSAxMy41LTkuMiAzLjIwNC0xOC44MDUgNC44MDUtMjguODA1IDQuODA1aC01NC4yOTdsMTAuOC00MC41YzEuNi01LjQwMiA0LjYtOS44IDktMTMuMjAzIDQuMzk2LTMuMzk4IDkuNDk3LTUuMTAyIDE1LjMwMi01LjEwMmgxNy4zOThjNy4yIDAgMTMuNjUzLTIuMiAxOS4zNTItNi41OTcgNS42OTUtNC4zOTggOS40NDUtMTAuMDk3IDExLjI1LTE3LjEgMS4zOTQtNC45OTcgMS41NDctOS45LjQ0NS0xNC43LTEuMS00LjgtMy4wNS05LjA0Ny01Ljg0OC0xMi43NS0yLjgtMy42OTUtNi40MDItNi42OTUtMTAuNzk2LTktNC40MDYtMi4yOTctOS4yMDYtMy40NS0xNC40MDItMy40NUgyMzMuMzlsLTQzLjggMTYyLjkwM2MtMS42MDYgNS40LTQuNjA2IDkuNzk3LTkgMTMuMTk1LTQuNDAzIDMuNDA3LTkuNDA2IDUuMTAyLTE1IDUuMTAyaC00MS43IiBmaWxsPSIjZmY2YzJjIi8+PC9nPjwvc3ZnPgo=&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon_mime_type"</span>: <span class="token string">&quot;image/svg+xml&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"license_term"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_users"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maximum_server_price"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"minimum_server_price"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"price"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"price_unit"</span>: <span class="token string">&quot;USD&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product"</span>: <span class="token string">&quot;cPanel DV Certificate&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_category"</span>: <span class="token string">&quot;N/A&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_group"</span>: <span class="token string">&quot;ssl_certificate&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_id"</span>: <span class="token number">159</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_display_name"</span>: <span class="token string">&quot;cPanel Store&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_name"</span>: <span class="token string">&quot;cPStore&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"recommended"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"requires_ip"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_certificate_term"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">1</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;year&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_identity_verification"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_max_http_redirects"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_payment_trigger"</span>: <span class="token string">&quot;issuance&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_price_per_domain"</span>: <span class="token number">9</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_price_per_domain_maximum"</span>: <span class="token number">30</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_price_per_domain_minimum"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_price_per_wildcard_domain"</span>: <span class="token string">&quot;75.00&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_price_per_wildcard_domain_maximum"</span>: <span class="token string">&quot;750.00&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_price_per_wildcard_domain_minimum"</span>: <span class="token string">&quot;75.00&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_ssl_per_domain_pricing"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_supports_dns_dcv"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_validation_type"</span>: <span class="token string">&quot;dv&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_warn_after"</span>: <span class="token number">604800</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_wildcard_parent_domain_free"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"base_name"</span>: <span class="token string">&quot;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"billing_type"</span>: <span class="token string">&quot;one-time&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">&quot;An organization-validated (OV) SSL certificate signed by cPanel.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">&quot;cPanel OV SSL Certificate&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon"</span>: <span class="token string">&quot;PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzNTlwdCIgaGVpZ2h0PSIzMjAiIHZpZXdCb3g9IjAgMCAzNTkgMjQwIj48ZGVmcz48Y2xpcFBhdGggaWQ9ImEiPjxwYXRoIGQ9Ik0xMjMgMGgyMzUuMzd2MjQwSDEyM3ptMCAwIi8+PC9jbGlwUGF0aD48L2RlZnM+PHBhdGggZD0iTTg5LjY5IDU5LjEwMmg2Ny44MDJsLTEwLjUgNDAuMmMtMS42MDUgNS42LTQuNjA1IDEwLjEtOSAxMy41LTQuNDAyIDMuNC05LjUwNCA1LjA5Ni0xNS4zIDUuMDk2aC0zMS41Yy03LjIgMC0xMy41NSAyLjEwMi0xOS4wNSA2LjMtNS41MDUgNC4yLTkuMzUzIDkuOTA0LTExLjU1MiAxNy4xMDMtMS40IDUuNDAzLTEuNTUgMTAuNS0uNDUgMTUuMzAyIDEuMDk4IDQuNzk2IDMuMDQ3IDkuMDUgNS44NTIgMTIuNzUgMi43OTcgMy43MDMgNi40IDYuNjUyIDEwLjc5NyA4Ljg1IDQuMzk3IDIuMiA5LjE5OCAzLjI5OCAxNC40IDMuMjk4aDE5LjJjMy42MDIgMCA2LjU0NyAxLjQ1MyA4Ljg1MiA0LjM1MiAyLjI5NyAyLjkwMiAyLjk0NSA2LjE0OCAxLjk1IDkuNzVsLTEyIDQ0LjM5OGgtMjFjLTE0LjQwMyAwLTI3LjY1My0zLjE0OC0zOS43NS05LjQ1LTEyLjEwMi02LjMtMjIuMTUzLTE0LjY0OC0zMC4xNTMtMjUuMDUtOC0xMC4zOTUtMTMuNDU0LTIyLjI0Ni0xNi4zNS0zNS41NDctMi45LTEzLjMtMi41NS0yNi45NSAxLjA1Mi00MC45NTNsMS4yLTQuNWMyLjU5Ny05LjYwMiA2LjY0OC0xOC40NSAxMi4xNDgtMjYuNTUgNS41LTguMDk4IDEyLTE1IDE5LjUtMjAuNyA3LjUtNS43IDE1Ljg1LTEwLjE0OCAyNS4wNS0xMy4zNTIgOS4yLTMuMTk1IDE4Ljc5Ny00Ljc5NiAyOC44LTQuNzk2IiBmaWxsPSIjZmY2YzJjIi8+PGcgY2xpcC1wYXRoPSJ1cmwoI2EpIj48cGF0aCBkPSJNMTIzLjg5IDI0MEwxODIuOTkgMTguNjAyYzEuNTk4LTUuNTk4IDQuNTk4LTEwLjA5OCA5LTEzLjVDMTk2LjM4OCAxLjcgMjAxLjQ4NCAwIDIwNy4yODggMGg2Mi43YzE0LjQwMyAwIDI3LjY1IDMuMTQ4IDM5Ljc1IDkuNDUgMTIuMTAyIDYuMyAyMi4xNTMgMTQuNjU1IDMwLjE1MyAyNS4wNSA3Ljk5NyAxMC40MDIgMTMuNSAyMi4yNTQgMTYuNSAzNS41NSAzIDEzLjMwNSAyLjU5NCAyNi45NTQtMS4yMDIgNDAuOTVsLTEuMiA0LjVjLTIuNTk3IDkuNjAyLTYuNTk3IDE4LjQ1LTEyIDI2LjU1LTUuMzk4IDguMDk4LTExLjg0NyAxNS4wNTItMTkuMzQ3IDIwLjg0OC03LjUgNS44MDUtMTUuODU1IDEwLjMwNS0yNS4wNSAxMy41LTkuMiAzLjIwNC0xOC44MDUgNC44MDUtMjguODA1IDQuODA1aC01NC4yOTdsMTAuOC00MC41YzEuNi01LjQwMiA0LjYtOS44IDktMTMuMjAzIDQuMzk2LTMuMzk4IDkuNDk3LTUuMTAyIDE1LjMwMi01LjEwMmgxNy4zOThjNy4yIDAgMTMuNjUzLTIuMiAxOS4zNTItNi41OTcgNS42OTUtNC4zOTggOS40NDUtMTAuMDk3IDExLjI1LTE3LjEgMS4zOTQtNC45OTcgMS41NDctOS45LjQ0NS0xNC43LTEuMS00LjgtMy4wNS05LjA0Ny01Ljg0OC0xMi43NS0yLjgtMy42OTUtNi40MDItNi42OTUtMTAuNzk2LTktNC40MDYtMi4yOTctOS4yMDYtMy40NS0xNC40MDItMy40NUgyMzMuMzlsLTQzLjggMTYyLjkwM2MtMS42MDYgNS40LTQuNjA2IDkuNzk3LTkgMTMuMTk1LTQuNDAzIDMuNDA3LTkuNDA2IDUuMTAyLTE1IDUuMTAyaC00MS43IiBmaWxsPSIjZmY2YzJjIi8+PC9nPjwvc3ZnPgo=&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon_mime_type"</span>: <span class="token string">&quot;image/svg+xml&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"license_term"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_users"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maximum_server_price"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"minimum_server_price"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"price"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"price_unit"</span>: <span class="token string">&quot;USD&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product"</span>: <span class="token string">&quot;cPanel OV Certificate&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_category"</span>: <span class="token string">&quot;N/A&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_group"</span>: <span class="token string">&quot;ssl_certificate&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_id"</span>: <span class="token number">213</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_display_name"</span>: <span class="token string">&quot;cPanel Store&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_name"</span>: <span class="token string">&quot;cPStore&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"recommended"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"requires_ip"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_certificate_term"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">1</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;year&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_identity_verification"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Organization Name&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;organizationName&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"is_optional"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Department Name&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;organizationalUnitName&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">&quot;9 consecutive digits or “##-###-####” (More information (https://go.cpanel.net/get_duns))&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_optional"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Dun &amp; Bradstreet D-U-N-S (Data Universal Numbering System) Number&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;duns_number&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pattern"</span>: <span class="token string">&quot;^[0-9]{2}(?:-[0-9]{3}-[0-9]{4}|[0-9]{7})$&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Street Address&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;streetAddress&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;City&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;localityName&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;State or Province&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;stateOrProvinceName&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Postal Code&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;postalCode&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Country Code&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;countryName&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;country_code&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Representative’s Given (First) Name&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;rep_forename&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Representative’s Surname (Last Name)&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;rep_surname&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Representative’s Email Address&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;rep_email_address&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;email&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">&quot;This should be one of the organization’s publicly-listed telephone numbers.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_optional"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Representative’s Telephone Number&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;rep_telephone&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;tel&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_max_http_redirects"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_payment_trigger"</span>: <span class="token string">&quot;checkout&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_price_per_domain"</span>: <span class="token number">30</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_price_per_domain_maximum"</span>: <span class="token number">300</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_price_per_domain_minimum"</span>: <span class="token number">30</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_price_per_wildcard_domain"</span>: <span class="token string">&quot;99.00&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_price_per_wildcard_domain_maximum"</span>: <span class="token string">&quot;990.00&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_price_per_wildcard_domain_minimum"</span>: <span class="token string">&quot;99.00&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_ssl_per_domain_pricing"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_supports_dns_dcv"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_validation_type"</span>: <span class="token string">&quot;ov&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_warn_after"</span>: <span class="token number">604800</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_wildcard_parent_domain_free"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"base_name"</span>: <span class="token string">&quot;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"billing_type"</span>: <span class="token string">&quot;one-time&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">&quot;A domain-validated (DV) SSL certificate signed by COMODO.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">&quot;Comodo DV SSL Certificate&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon"</span>: <span class="token string">&quot;PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iNTUwIiB3aWR0aD0iNDE3LjE2Ij48ZyBmaWxsPSIjMzViNTZjIj48cGF0aCBkPSJNNDE0LjM5NiAyNmM3LTExIDAtMjYtMTMtMjZIMTg3LjM5NWMtNDUgMC04MSAxMi0xMDcgMzZzLTQyIDU4LTQ2IDEwM2wtMTAgMTE2Yy00IDQ1IDUgNzkgMjggMTAzIDIyIDI0IDU2IDM2IDEwMSAzNmg0OXYtMWM5LjAwMS0xIDE1LjAwMS03IDE2LjAwMS0xN2w1LTU3YzAtMTEtNy0xOS0xOC4wMDEtMTloLTI3Yy0xNyAwLTMwLTQtMzctMTItNy03LTEwLTIwLTgtMzlsOS0xMDRjMi0xOCA3LTMxIDE1LTM5czIxLTEyIDM5LTEyaDE0NC4wMDFjMTcgMCAzNC05IDQ0LTIzbDMwLTQ1Ii8+PHBhdGggZD0iTTMuMzk1IDUyNGMtOCAxMS0xIDI2IDEyIDI2aDIxNy4wMDFjNDUgMCA4MS0xMiAxMDgtMzYgMjYtMjQgNDEtNTggNDUtMTAybDExLTExN2MzLTQ1LTYtNzktMjgtMTAzLTIzLTI0LTU2LTM2LTEwMS0zNmgtNDl2MWMtMTAuMDAxIDEtMTUuMDAxIDctMTYuMDAxIDE3bC01IDU4Yy0xIDEwIDcgMTggMTcuMDAxIDE4aDI3YzE4IDAgMzAgNCAzNyAxMnMxMCAyMSA5IDM5bC0xMCAxMDRjLTEgMTktNiAzMi0xNCAzOS05IDgtMjIgMTItNDAgMTJINzYuMzk1Yy0xNyAwLTMzIDktNDMgMjRsLTMwIDQ0Ii8+PC9nPjwvc3ZnPg==&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon_mime_type"</span>: <span class="token string">&quot;image/svg+xml&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"license_term"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_users"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maximum_server_price"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"minimum_server_price"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"price"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"price_unit"</span>: <span class="token string">&quot;USD&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product"</span>: <span class="token string">&quot;Comodo DV Certificate&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_category"</span>: <span class="token string">&quot;N/A&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_group"</span>: <span class="token string">&quot;ssl_certificate&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_id"</span>: <span class="token number">151</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_display_name"</span>: <span class="token string">&quot;cPanel Store&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_name"</span>: <span class="token string">&quot;cPStore&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"recommended"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"requires_ip"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_certificate_term"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">1</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;year&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_identity_verification"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_max_http_redirects"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_payment_trigger"</span>: <span class="token string">&quot;issuance&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_price_per_domain"</span>: <span class="token number">12</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_price_per_domain_maximum"</span>: <span class="token number">120</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_price_per_domain_minimum"</span>: <span class="token number">12</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_price_per_wildcard_domain"</span>: <span class="token string">&quot;99.00&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_price_per_wildcard_domain_maximum"</span>: <span class="token string">&quot;990.00&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_price_per_wildcard_domain_minimum"</span>: <span class="token string">&quot;99.00&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_ssl_per_domain_pricing"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_supports_dns_dcv"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_validation_type"</span>: <span class="token string">&quot;dv&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_warn_after"</span>: <span class="token number">604800</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_wildcard_parent_domain_free"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"base_name"</span>: <span class="token string">&quot;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"billing_type"</span>: <span class="token string">&quot;one-time&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">&quot;An extended-validated (EV) SSL certificate signed by cPanel.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">&quot;cPanel EV SSL Certificate&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon"</span>: <span class="token string">&quot;PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzNTlwdCIgaGVpZ2h0PSIzMjAiIHZpZXdCb3g9IjAgMCAzNTkgMjQwIj48ZGVmcz48Y2xpcFBhdGggaWQ9ImEiPjxwYXRoIGQ9Ik0xMjMgMGgyMzUuMzd2MjQwSDEyM3ptMCAwIi8+PC9jbGlwUGF0aD48L2RlZnM+PHBhdGggZD0iTTg5LjY5IDU5LjEwMmg2Ny44MDJsLTEwLjUgNDAuMmMtMS42MDUgNS42LTQuNjA1IDEwLjEtOSAxMy41LTQuNDAyIDMuNC05LjUwNCA1LjA5Ni0xNS4zIDUuMDk2aC0zMS41Yy03LjIgMC0xMy41NSAyLjEwMi0xOS4wNSA2LjMtNS41MDUgNC4yLTkuMzUzIDkuOTA0LTExLjU1MiAxNy4xMDMtMS40IDUuNDAzLTEuNTUgMTAuNS0uNDUgMTUuMzAyIDEuMDk4IDQuNzk2IDMuMDQ3IDkuMDUgNS44NTIgMTIuNzUgMi43OTcgMy43MDMgNi40IDYuNjUyIDEwLjc5NyA4Ljg1IDQuMzk3IDIuMiA5LjE5OCAzLjI5OCAxNC40IDMuMjk4aDE5LjJjMy42MDIgMCA2LjU0NyAxLjQ1MyA4Ljg1MiA0LjM1MiAyLjI5NyAyLjkwMiAyLjk0NSA2LjE0OCAxLjk1IDkuNzVsLTEyIDQ0LjM5OGgtMjFjLTE0LjQwMyAwLTI3LjY1My0zLjE0OC0zOS43NS05LjQ1LTEyLjEwMi02LjMtMjIuMTUzLTE0LjY0OC0zMC4xNTMtMjUuMDUtOC0xMC4zOTUtMTMuNDU0LTIyLjI0Ni0xNi4zNS0zNS41NDctMi45LTEzLjMtMi41NS0yNi45NSAxLjA1Mi00MC45NTNsMS4yLTQuNWMyLjU5Ny05LjYwMiA2LjY0OC0xOC40NSAxMi4xNDgtMjYuNTUgNS41LTguMDk4IDEyLTE1IDE5LjUtMjAuNyA3LjUtNS43IDE1Ljg1LTEwLjE0OCAyNS4wNS0xMy4zNTIgOS4yLTMuMTk1IDE4Ljc5Ny00Ljc5NiAyOC44LTQuNzk2IiBmaWxsPSIjZmY2YzJjIi8+PGcgY2xpcC1wYXRoPSJ1cmwoI2EpIj48cGF0aCBkPSJNMTIzLjg5IDI0MEwxODIuOTkgMTguNjAyYzEuNTk4LTUuNTk4IDQuNTk4LTEwLjA5OCA5LTEzLjVDMTk2LjM4OCAxLjcgMjAxLjQ4NCAwIDIwNy4yODggMGg2Mi43YzE0LjQwMyAwIDI3LjY1IDMuMTQ4IDM5Ljc1IDkuNDUgMTIuMTAyIDYuMyAyMi4xNTMgMTQuNjU1IDMwLjE1MyAyNS4wNSA3Ljk5NyAxMC40MDIgMTMuNSAyMi4yNTQgMTYuNSAzNS41NSAzIDEzLjMwNSAyLjU5NCAyNi45NTQtMS4yMDIgNDAuOTVsLTEuMiA0LjVjLTIuNTk3IDkuNjAyLTYuNTk3IDE4LjQ1LTEyIDI2LjU1LTUuMzk4IDguMDk4LTExLjg0NyAxNS4wNTItMTkuMzQ3IDIwLjg0OC03LjUgNS44MDUtMTUuODU1IDEwLjMwNS0yNS4wNSAxMy41LTkuMiAzLjIwNC0xOC44MDUgNC44MDUtMjguODA1IDQuODA1aC01NC4yOTdsMTAuOC00MC41YzEuNi01LjQwMiA0LjYtOS44IDktMTMuMjAzIDQuMzk2LTMuMzk4IDkuNDk3LTUuMTAyIDE1LjMwMi01LjEwMmgxNy4zOThjNy4yIDAgMTMuNjUzLTIuMiAxOS4zNTItNi41OTcgNS42OTUtNC4zOTggOS40NDUtMTAuMDk3IDExLjI1LTE3LjEgMS4zOTQtNC45OTcgMS41NDctOS45LjQ0NS0xNC43LTEuMS00LjgtMy4wNS05LjA0Ny01Ljg0OC0xMi43NS0yLjgtMy42OTUtNi40MDItNi42OTUtMTAuNzk2LTktNC40MDYtMi4yOTctOS4yMDYtMy40NS0xNC40MDItMy40NUgyMzMuMzlsLTQzLjggMTYyLjkwM2MtMS42MDYgNS40LTQuNjA2IDkuNzk3LTkgMTMuMTk1LTQuNDAzIDMuNDA3LTkuNDA2IDUuMTAyLTE1IDUuMTAyaC00MS43IiBmaWxsPSIjZmY2YzJjIi8+PC9nPjwvc3ZnPgo=&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon_mime_type"</span>: <span class="token string">&quot;image/svg+xml&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"license_term"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_users"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maximum_server_price"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"minimum_server_price"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"price"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"price_unit"</span>: <span class="token string">&quot;USD&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product"</span>: <span class="token string">&quot;cPanel EV Certificate&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_category"</span>: <span class="token string">&quot;N/A&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_group"</span>: <span class="token string">&quot;ssl_certificate&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_id"</span>: <span class="token number">209</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_display_name"</span>: <span class="token string">&quot;cPanel Store&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider_name"</span>: <span class="token string">&quot;cPStore&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"recommended"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"requires_ip"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_certificate_term"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">1</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;year&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_identity_verification"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Organization Name&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;organizationName&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"is_optional"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Department Name&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;organizationalUnitName&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">&quot;9 consecutive digits or “##-###-####” (More information (https://go.cpanel.net/get_duns))&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_optional"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Dun &amp; Bradstreet D-U-N-S (Data Universal Numbering System) Number&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;duns_number&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pattern"</span>: <span class="token string">&quot;^[0-9]{2}(?:-[0-9]{3}-[0-9]{4}|[0-9]{7})$&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Street Address&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;streetAddress&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;City&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;localityName&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;State or Province&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;stateOrProvinceName&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Postal Code&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;postalCode&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Country Code&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;countryName&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;country_code&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Representative’s Given (First) Name&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;rep_forename&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Representative’s Surname (Last Name)&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;rep_surname&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Representative’s Email Address&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;rep_email_address&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;email&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">&quot;This should be one of the organization’s publicly-listed telephone numbers.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_optional"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Representative’s Telephone Number&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;rep_telephone&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;tel&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">&quot;Consult the EV SSL Certificate Guidelines (https://cabforum.org/extended-validation/) for more information about this field’s options.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Business Category&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;business_category&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"options"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;b&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;Incorporated Business (“Private Organization”)&quot;</span></div></li></ul><span class="token punctuation">]</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;d&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;Non-incorporated Business (“Business Entity”)&quot;</span></div></li></ul><span class="token punctuation">]</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;c&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;Government Entity (“Government Entity”)&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;choose_one&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"is_optional"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;City Where Incorporated (JOI (Jurisdiction of Incorporation))&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;joi_locality_name&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"is_optional"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;State or Province Where Incorporated (JOI (Jurisdiction of Incorporation))&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;joi_state_or_province_name&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Country Code Where Incorporated (JOI (Jurisdiction of Incorporation))&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;joi_country_name&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;country_code&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"is_optional"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Date of Incorporation&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;date_of_incorporation&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;date&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"is_optional"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Assumed Name (DBA (Doing Business As))&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;assumed_name&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_max_http_redirects"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_payment_trigger"</span>: <span class="token string">&quot;checkout&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_price_per_domain"</span>: <span class="token number">60</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_price_per_domain_maximum"</span>: <span class="token number">600</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_price_per_domain_minimum"</span>: <span class="token number">60</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_ssl_per_domain_pricing"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_supports_dns_dcv"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_validation_type"</span>: <span class="token string">&quot;ev&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"x_warn_after"</span>: <span class="token number">604800</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Market-Integration/operation/create_shopping_cart" data-section-id="tag/Market-Integration/operation/create_shopping_cart" class="sc-dntaoT ceciOs"><div data-section-id="operation/create_shopping_cart" id="operation/create_shopping_cart" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Market-Integration/operation/create_shopping_cart" aria-label="tag/Market-Integration/operation/create_shopping_cart"></a>Create shopping cart </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function creates a shopping cart with which the system sends an order to the cPanel Store. Typically, the system will send shopping cart orders for SSL certificates to UAPI’s &lt;code&gt;Market::request_ssl_certificates&lt;/code&gt; function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a shopping cart with which the system sends an order to the cPanel Store. Typically, the system will send shopping cart orders for SSL certificates to UAPI’s <code>Market::request_ssl_certificates</code> function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="access_token" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">access_token</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;uuid&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">access_token=1a676e6f-99fc-11e6-9ab6-e60a769b73bc</span></div><div><div html="&lt;p&gt;The access token to connect to the provider.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The access token to connect to the provider.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="item" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">item</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">strings</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;json&gt; </span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR gjyOxn kpFoWb">[ items<span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;json &gt;</span> ]</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">item={&quot;product_id&quot;:123456,&quot;provider-specfic-key&quot;:&quot;provider-specfic-value&quot;,&quot;another-provider-specfic-key&quot;:&quot;another-provider-specfic-value&quot;}&amp;item={&quot;product_id&quot;:123457,&quot;provider-specfic-key&quot;:&quot;provider-specfic-value&quot;,&quot;another-provider-specfic-key&quot;:&quot;another-provider-specfic-value&quot;}</span></div><div><div html="&lt;p&gt;The items to add to the shopping cart.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note&lt;/strong&gt;:&lt;/p&gt;
&lt;p&gt;  The value is a JSON string.&lt;/p&gt;
&lt;p&gt;  This object has one required key, &lt;code&gt;product_id&lt;/code&gt;, which is a string.&lt;/p&gt;
&lt;p&gt;  The other keys/values in this object vary depending on the provider.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The items to add to the shopping cart.</p>
<p><strong>Note</strong>:</p>
<p>  The value is a JSON string.</p>
<p>  This object has one required key, <code>product_id</code>, which is a string.</p>
<p>  The other keys/values in this object vary depending on the provider.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="provider" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">provider</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">provider=cPStore</span></div><div><div html="&lt;p&gt;The cPanel Market provider’s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel Market provider’s name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="url_after_checkout" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">url_after_checkout</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;url&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">url_after_checkout=http://www.example.com/thenextplace</span></div><div><div html="&lt;p&gt;The location to which the provider directs the user after the checkout process is complete.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The location to which the provider directs the user after the checkout process is complete.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Market/create_shopping_cart</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Market/create_shopping_cart</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aaj2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aaj2a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aaj2a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aaj2a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2aaj2a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aaj2a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2aaj2a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aaj2a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aaj2a:0" aria-labelledby="tab:R2aaj2a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Market <span class="token punctuation">\</span>
  create_shopping_cart <span class="token punctuation">\</span>
  <span class="token assign-left variable">provider</span><span class="token operator">=</span><span class="token string">'cPStore'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">access_token</span><span class="token operator">=</span><span class="token string">'1a676e6f-99fc-11e6-9ab6-e60a769b73bc'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">url_after_checkout</span><span class="token operator">=</span><span class="token string">'http://www.example.com/thenextplace'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">item</span><span class="token operator">=</span><span class="token string">'{"product_id":123456,"provider-specfic-key":"provider-specfic-value","another-provider-specfic-key":"another-provider-specfic-value"}'</span> <span class="token assign-left variable">item</span><span class="token operator">=</span><span class="token string">'{"product_id":123457,"provider-specfic-key":"provider-specfic-value","another-provider-specfic-key":"another-provider-specfic-value"}'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aaj2a:1" aria-labelledby="tab:R2aaj2a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aaj2a:2" aria-labelledby="tab:R2aaj2a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aaj2a:3" aria-labelledby="tab:R2aaj2a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eaj2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eaj2a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eaj2a:0" aria-labelledby="tab:R2eaj2a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;create_shopping_cart&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Market&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"checkout_url"</span>: <span class="token string">&quot;</span><a href="http://www.example.com/checkout">http://www.example.com/checkout</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"order_id"</span>: <span class="token string">&quot;8765309&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"order_items"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Market-Integration/operation/get_login_url" data-section-id="tag/Market-Integration/operation/get_login_url" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_login_url" id="operation/get_login_url" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Market-Integration/operation/get_login_url" aria-label="tag/Market-Integration/operation/get_login_url"></a>Return provider&#x27;s login URL </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves the login URL for the cPanel Market provider.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the login URL for the cPanel Market provider.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="provider" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">provider</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">provider=cPStore</span></div><div><div html="&lt;p&gt;The cPanel Market provider&amp;#39;s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel Market provider&#39;s name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="url_after_login" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">url_after_login</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;url&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">url_after_login=http://hostname.example.com/redirectionlocation.cgi?state</span></div><div><div html="&lt;p&gt;Where the cPanel Market provider redirects the user&amp;#39;s browser after they log in.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Where the cPanel Market provider redirects the user&#39;s browser after they log in.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Market/get_login_url</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Market/get_login_url</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2abj2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abj2a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abj2a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abj2a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2abj2a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abj2a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2abj2a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abj2a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abj2a:0" aria-labelledby="tab:R2abj2a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Market <span class="token punctuation">\</span>
  get_login_url <span class="token punctuation">\</span>
  <span class="token assign-left variable">provider</span><span class="token operator">=</span><span class="token string">'cPStore'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">url_after_login</span><span class="token operator">=</span><span class="token string">'http://hostname.example.com/redirectionlocation.cgi?state'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abj2a:1" aria-labelledby="tab:R2abj2a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abj2a:2" aria-labelledby="tab:R2abj2a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abj2a:3" aria-labelledby="tab:R2abj2a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ebj2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebj2a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebj2a:0" aria-labelledby="tab:R2ebj2a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_login_url&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Market&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token string">&quot;</span><a href="https://example.com/api/?client_id=MyHearseIsAmazing&function=login&module=bogoSSL&redirect_uri=https%253A%252F%252Fqaportal.cpanel.net%252Fbogus.cgi&response_type=token">https://example.com/api/?client_id=MyHearseIsAmazing&amp;function=login&amp;module=bogoSSL&amp;redirect_uri=https%3A%2F%2Fqaportal.cpanel.net%2Fbogus.cgi&amp;response_type=token</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Market-Integration/operation/Market-get_providers_list" data-section-id="tag/Market-Integration/operation/Market-get_providers_list" class="sc-dntaoT ceciOs"><div data-section-id="operation/Market-get_providers_list" id="operation/Market-get_providers_list" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Market-Integration/operation/Market-get_providers_list" aria-label="tag/Market-Integration/operation/Market-get_providers_list"></a>Return enabled providers </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the names of enabled cPanel Market providers.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the names of enabled cPanel Market providers.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Market/get_providers_list</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Market/get_providers_list</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2acj2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2acj2a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2acj2a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acj2a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2acj2a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acj2a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2acj2a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acj2a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2acj2a:0" aria-labelledby="tab:R2acj2a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Market <span class="token punctuation">\</span>
  get_providers_list
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acj2a:1" aria-labelledby="tab:R2acj2a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acj2a:2" aria-labelledby="tab:R2acj2a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acj2a:3" aria-labelledby="tab:R2acj2a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ecj2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ecj2a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ecj2a:0" aria-labelledby="tab:R2ecj2a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_providers_list&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Market&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">&quot;cPanel Store&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;cPStore&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Market-Integration/operation/set_status_of_pending_queue_items" data-section-id="tag/Market-Integration/operation/set_status_of_pending_queue_items" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_status_of_pending_queue_items" id="operation/set_status_of_pending_queue_items" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Market-Integration/operation/set_status_of_pending_queue_items" aria-label="tag/Market-Integration/operation/set_status_of_pending_queue_items"></a>Update status of items in pending queue </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function sets the status of an item or items in the cPanel Market pending queue.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets the status of an item or items in the cPanel Market pending queue.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="order_item_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">order_item_id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">order_item_id=order_item_id-1=12345&amp;order_item_id-2=12346&amp;order_item_id-3=12347</span> - Multiple IDs.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">order_item_id=order_item_id=12345&amp;order_item_id=12346&amp;order_item_id=12347</span> - Multiple IDs alternative.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">order_item_id=12345</span> - A single ID.</li></ul><div><div html="&lt;p&gt;The ID of the ordered item.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To set the status for multiple items, duplicate or increment the parameter name. For example, to change the status for three certificates, use the &lt;code&gt;order_item_id&lt;/code&gt; parameter multiple times or use the &lt;code&gt;order_item_id-1&lt;/code&gt;, &lt;code&gt;order_item_id-2&lt;/code&gt;, and &lt;code&gt;order_item_id-3&lt;/code&gt; parameters.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The ID of the ordered item.</p>
<p><strong>Note:</strong></p>
<p>To set the status for multiple items, duplicate or increment the parameter name. For example, to change the status for three certificates, use the <code>order_item_id</code> parameter multiple times or use the <code>order_item_id-1</code>, <code>order_item_id-2</code>, and <code>order_item_id-3</code> parameters.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="provider" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">provider</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">provider=cPStore</span></div><div><div html="&lt;p&gt;The cPanel Market provider&amp;#39;s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel Market provider&#39;s name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="status" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">status</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Value:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;confirmed&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">status=confirmed</span></div><div><div html="&lt;p&gt;The new status of the item in the cPanel Market pending queue.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;confirmed&lt;/code&gt; — The system confirmed payment for the item with the provider.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new status of the item in the cPanel Market pending queue.</p>
<ul>
<li><code>confirmed</code> — The system confirmed payment for the item with the provider.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Market/set_status_of_pending_queue_items</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Market/set_status_of_pending_queue_items</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2adj2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2adj2a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2adj2a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adj2a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2adj2a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adj2a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2adj2a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adj2a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2adj2a:0" aria-labelledby="tab:R2adj2a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Market <span class="token punctuation">\</span>
  set_status_of_pending_queue_items <span class="token punctuation">\</span>
  <span class="token assign-left variable">provider</span><span class="token operator">=</span><span class="token string">'cPStore'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">order_item_id</span><span class="token operator">=</span><span class="token string">'12345'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">status</span><span class="token operator">=</span><span class="token string">'confirmed'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adj2a:1" aria-labelledby="tab:R2adj2a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adj2a:2" aria-labelledby="tab:R2adj2a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adj2a:3" aria-labelledby="tab:R2adj2a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2edj2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2edj2a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2edj2a:0" aria-labelledby="tab:R2edj2a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Example</span><div class="sc-diYFot sc-frniUE jsRqjj esCYIP"><svg class="sc-kZrBCu JXohG" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="The function failed." selected="">The function failed.</option><option value="The function succeeded.">The function succeeded.</option></select><label>The function failed.</label></div></div><div><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_status_of_pending_queue_items&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Market&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"error_type"</span>: <span class="token string">&quot;EntryDoesNotExist&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"order_item_ids"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">8675309</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;The order item ID “8675309” does not match any entries in the pending queue.&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Market-Integration/operation/set_url_after_checkout" data-section-id="tag/Market-Integration/operation/set_url_after_checkout" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_url_after_checkout" id="operation/set_url_after_checkout" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Market-Integration/operation/set_url_after_checkout" aria-label="tag/Market-Integration/operation/set_url_after_checkout"></a>Update URL after checkout </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function updates the URL to which a provider sends a user after they check out.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function updates the URL to which a provider sends a user after they check out.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="access_token" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">access_token</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">access_token=725431a1-d5bc-11e5-a28b-8b0e09a93f05</span></div><div><div html="&lt;p&gt;The access token for the session to the cPanel Market provider.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The access token for the session to the cPanel Market provider.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="order_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">order_id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">order_id=123456</span></div><div><div html="&lt;p&gt;The order ID that the cPanel Market provider assigned.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The order ID that the cPanel Market provider assigned.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="provider" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">provider</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">provider=cPStore</span></div><div><div html="&lt;p&gt;The cPanel Market provider&amp;#39;s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel Market provider&#39;s name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="url_after_checkout" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">url_after_checkout</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;url&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">url_after_checkout=http://checkout.example.com</span></div><div><div html="&lt;p&gt;The URL to send the browser after the user checks out.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The URL to send the browser after the user checks out.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Market/set_url_after_checkout</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Market/set_url_after_checkout</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aej2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aej2a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aej2a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aej2a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2aej2a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aej2a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2aej2a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aej2a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aej2a:0" aria-labelledby="tab:R2aej2a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Market <span class="token punctuation">\</span>
  set_url_after_checkout <span class="token punctuation">\</span>
  <span class="token assign-left variable">provider</span><span class="token operator">=</span><span class="token string">'cPStore'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">access_token</span><span class="token operator">=</span><span class="token string">'725431a1-d5bc-11e5-a28b-8b0e09a93f05'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">order_id</span><span class="token operator">=</span><span class="token string">'123456'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">url_after_checkout</span><span class="token operator">=</span><span class="token string">'http://checkout.example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aej2a:1" aria-labelledby="tab:R2aej2a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aej2a:2" aria-labelledby="tab:R2aej2a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aej2a:3" aria-labelledby="tab:R2aej2a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eej2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eej2a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eej2a:0" aria-labelledby="tab:R2eej2a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_url_after_checkout&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Market&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"error_type"</span>: <span class="token string">&quot;This is an error.&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Market-Integration/operation/validate_login_token" data-section-id="tag/Market-Integration/operation/validate_login_token" class="sc-dntaoT ceciOs"><div data-section-id="operation/validate_login_token" id="operation/validate_login_token" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Market-Integration/operation/validate_login_token" aria-label="tag/Market-Integration/operation/validate_login_token"></a>Validate login token </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function validates a login token to a cPanel Market provider and returns an access token.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function validates a login token to a cPanel Market provider and returns an access token.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="login_token" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">login_token</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">login_token=8675309</span></div><div><div html="&lt;p&gt;The login token for the cPanel Market provider.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The login token for the cPanel Market provider.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="provider" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">provider</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">provider=cPStore</span></div><div><div html="&lt;p&gt;The name of the cPanel Market provider.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the cPanel Market provider.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="url_after_login" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">url_after_login</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;url&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">url_after_login=http://hostname.example.com/redirectionlocation.cgi?state</span></div><div><div html="&lt;p&gt;The &lt;code&gt;url_after_login&lt;/code&gt; value that you sent to UAPI&amp;#39;s &lt;code&gt;Market::get_login_url&lt;/code&gt; function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The <code>url_after_login</code> value that you sent to UAPI&#39;s <code>Market::get_login_url</code> function.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Market/validate_login_token</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Market/validate_login_token</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2afj2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2afj2a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2afj2a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2afj2a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2afj2a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2afj2a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2afj2a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2afj2a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2afj2a:0" aria-labelledby="tab:R2afj2a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Market <span class="token punctuation">\</span>
  validate_login_token <span class="token punctuation">\</span>
  <span class="token assign-left variable">provider</span><span class="token operator">=</span><span class="token string">'cPStore'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">login_token</span><span class="token operator">=</span><span class="token string">'8675309'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">url_after_login</span><span class="token operator">=</span><span class="token string">'http://hostname.example.com/redirectionlocation.cgi?state'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2afj2a:1" aria-labelledby="tab:R2afj2a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2afj2a:2" aria-labelledby="tab:R2afj2a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2afj2a:3" aria-labelledby="tab:R2afj2a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2efj2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2efj2a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2efj2a:0" aria-labelledby="tab:R2efj2a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;validate_login_token&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Market&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"access_token"</span>: <span class="token string">&quot;8675309&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/SSL-Certificates" data-section-id="tag/SSL-Certificates" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSL-Certificates" aria-label="tag/SSL-Certificates"></a>SSL Certificates</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Commerce Integration / SSL Certificates&lt;/p&gt;
"><p>Commerce Integration / SSL Certificates</p>
</div></div></div><div id="tag/SSL-Certificates/operation/cancel_pending_ssl_certificate" data-section-id="tag/SSL-Certificates/operation/cancel_pending_ssl_certificate" class="sc-dntaoT ceciOs"><div data-section-id="operation/cancel_pending_ssl_certificate" id="operation/cancel_pending_ssl_certificate" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSL-Certificates/operation/cancel_pending_ssl_certificate" aria-label="tag/SSL-Certificates/operation/cancel_pending_ssl_certificate"></a>Delete an order </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function cancels an order and removes the polling for a pending certificate.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function cancels an order and removes the polling for a pending certificate.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="order_item_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">order_item_id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">order_item_id=10427508</span></div><div><div html="&lt;p&gt;The ID of the ordered item to cancel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The ID of the ordered item to cancel.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="provider" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">provider</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">provider=cPStore</span></div><div><div html="&lt;p&gt;The cPanel Market provider&amp;#39;s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel Market provider&#39;s name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Market/cancel_pending_ssl_certificate</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Market/cancel_pending_ssl_certificate</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a9l2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9l2a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9l2a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9l2a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2a9l2a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9l2a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2a9l2a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9l2a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9l2a:0" aria-labelledby="tab:R2a9l2a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Market <span class="token punctuation">\</span>
  cancel_pending_ssl_certificate <span class="token punctuation">\</span>
  <span class="token assign-left variable">provider</span><span class="token operator">=</span><span class="token string">'cPStore'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">order_item_id</span><span class="token operator">=</span><span class="token string">'10427508'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9l2a:1" aria-labelledby="tab:R2a9l2a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9l2a:2" aria-labelledby="tab:R2a9l2a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9l2a:3" aria-labelledby="tab:R2a9l2a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2e9l2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9l2a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9l2a:0" aria-labelledby="tab:R2e9l2a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;cancel_pending_ssl_certificate&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Market&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created_time"</span>: <span class="token number">1458061262</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"csr"</span>: <span class="token string">&quot;-----BEGIN CERTIFICATE REQUEST-----\nMIIC0TCCAbkCAQAwGzEZMBcGA1UEAxMQY29icmFzc2x0ZXN0Lm9yZzCCASIwDQYJ\nKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKsZWNkF8hjUjoCDNNSkXO0CTp/z/0pu\niFiDMzdFAa6mg5wr97EwRBCniSvJEJ1rdQ0Sus2AAK9hg7TeZAWbFf97r7mS0chm\nr27Ht9qfit3r0EJLYcjRjnZ/wj21ZhsdjQIjjTRiI1TvXtOQRAQpWNsGxK7QV3Q3\nnjkSM/gTpteHuC3JAQxbpv72B+IjiyzUZr8DOUOoB94IO5iP27UXnkSbExInDvqu\nK43zVGYNU0Zev20A6SBWU3BALjWXHlYjwbC109FxOWNssHTg3xvePsBxzk6BFDcT\nS/QAS0tFYPfHZKmCBg6irBGFOdTjSDVmFk8zAoFYibev0juRJCMn2XsCAwEAAaBx\nMG8GCSqGSIb3DQEJDjFiMGAwXgYDVR0RAQH/BFQwUoIQY29icmFzc2x0ZXN0Lm9y\nZ4IUd3d3LmNvYnJhc3NsdGVzdC5vcmeCEWNwYW5lbHNzbHRlc3Qub3JnghV3d3cu\nY3BhbmVsc3NsdGVzdC5vcmcwDQYJKoZIhvcNAQELBQADggEBAG0l4aChMO1rSmgR\nSF5qlKu785n5YS5rTE9ev+OFu0952DvjVAB0R8y5+TZSXfg+9CH7pa2VDosAEYF4\nyjUJOuiwwVEUD/9Qhrls/2xT8KKk0QSxuWmOgP2YQy/QRH+W7ykoigtiWdXEIUuF\niJmeavS8JOYt560366V3dw7YT+QstUHQ7UlGEFDeWQI3osUN1wDrtW5qcaq09Q/G\nTcphzXrRkL5lRjKXKLIcY/HVYzOnoEX30ALX2I3bJ9s4IMRfpnhTqLmWalcr+4vq\nvqVnlB0B/nXf/qaB/xvxmEtSGx/GZ/8Gsrf5PB7GhRuStUtJoXcLuADK0bgug3X2\nGxEruS4=\n-----END CERTIFICATE REQUEST-----\n&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example1.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;example2.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expired"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_poll_time"</span>: <span class="token number">1458061262</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_poll_time"</span>: <span class="token number">1458061262</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_status_code"</span>: <span class="token string">&quot;CertificateNotFound&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"order_id"</span>: <span class="token string">&quot;1392472&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"order_item_id"</span>: <span class="token string">&quot;10427508&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_id"</span>: <span class="token string">&quot;143&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider"</span>: <span class="token string">&quot;cPStore&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">&quot;confirmed&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"support_uri"</span>: <span class="token string">&quot;</span><a href="http://support.example.com/">http://support.example.com/</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vhost_names"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;abcde.com&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/SSL-Certificates/operation/get_certificate_status_details" data-section-id="tag/SSL-Certificates/operation/get_certificate_status_details" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_certificate_status_details" id="operation/get_certificate_status_details" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSL-Certificates/operation/get_certificate_status_details" aria-label="tag/SSL-Certificates/operation/get_certificate_status_details"></a>Return provider&#x27;s SSL certificate request status </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the status of an SSL certificate request. The returns include
actionable URLs for users to expedite the validation process, if applicable.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;Because this function returns data from a dynamic source, the returns in each
object can vary.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the status of an SSL certificate request. The returns include
actionable URLs for users to expedite the validation process, if applicable.</p>
<p><strong>Important:</strong></p>
<p>Because this function returns data from a dynamic source, the returns in each
object can vary.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="order_item_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">order_item_id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= 1 </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">order_item_id=1234567890</span></div><div><div html="&lt;p&gt;The order ID that the cPanel Market provider assigned.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The order ID that the cPanel Market provider assigned.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="provider" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">provider</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">provider=cPStore</span></div><div><div html="&lt;p&gt;The cPanel Market provider&amp;#39;s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel Market provider&#39;s name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Market/get_certificate_status_details</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Market/get_certificate_status_details</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aal2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aal2a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aal2a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aal2a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2aal2a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aal2a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2aal2a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aal2a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aal2a:0" aria-labelledby="tab:R2aal2a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Market <span class="token punctuation">\</span>
  get_certificate_status_details <span class="token punctuation">\</span>
  <span class="token assign-left variable">order_item_id</span><span class="token operator">=</span><span class="token string">'1234567890'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">provider</span><span class="token operator">=</span><span class="token string">'cPStore'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aal2a:1" aria-labelledby="tab:R2aal2a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aal2a:2" aria-labelledby="tab:R2aal2a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aal2a:3" aria-labelledby="tab:R2aal2a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eal2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eal2a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eal2a:0" aria-labelledby="tab:R2eal2a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_certificate_status_details&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Market&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"actionUrls"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"evClickThroughStatus"</span>: <span class="token string">&quot;</span><a href="https://example.com/action">https://example.com/action</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ovCallbackStatus"</span>: <span class="token string">&quot;</span><a href="https://example.com/action">https://example.com/action</a><span class="token string">&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain_details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;www.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">&quot;AWAITINGBRAND&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status_details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"brandValStatus"</span>: <span class="token string">&quot;in-progress&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"certificateStatus"</span>: <span class="token string">&quot;in-progress&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"csrStatus"</span>: <span class="token string">&quot;completed&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dcvStatus"</span>: <span class="token string">&quot;completed&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"evClickThroughStatus"</span>: <span class="token string">&quot;in-progress&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"freeDVUPStatus"</span>: <span class="token string">&quot;not applicable&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"organizationValidationStatus"</span>: <span class="token string">&quot;not applicable&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ovCallbackStatus"</span>: <span class="token string">&quot;not applicable&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"validationStatus"</span>: <span class="token string">&quot;in-progress&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;Certificate request is still being processed.&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/SSL-Certificates/operation/get_pending_ssl_certificates" data-section-id="tag/SSL-Certificates/operation/get_pending_ssl_certificates" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_pending_ssl_certificates" id="operation/get_pending_ssl_certificates" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSL-Certificates/operation/get_pending_ssl_certificates" aria-label="tag/SSL-Certificates/operation/get_pending_ssl_certificates"></a>Return provider&#x27;s pending SSL certificates </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists all pending SSL certificates from a cPanel Market provider for which the system currently polls.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists all pending SSL certificates from a cPanel Market provider for which the system currently polls.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="provider" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">provider</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">provider=cPStore</span></div><div><div html="&lt;p&gt;The cPanel Market provider&amp;#39;s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel Market provider&#39;s name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Market/get_pending_ssl_certificates</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Market/get_pending_ssl_certificates</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2abl2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abl2a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abl2a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abl2a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2abl2a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abl2a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2abl2a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abl2a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abl2a:0" aria-labelledby="tab:R2abl2a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Market <span class="token punctuation">\</span>
  get_pending_ssl_certificates <span class="token punctuation">\</span>
  <span class="token assign-left variable">provider</span><span class="token operator">=</span><span class="token string">'cPStore'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abl2a:1" aria-labelledby="tab:R2abl2a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abl2a:2" aria-labelledby="tab:R2abl2a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abl2a:3" aria-labelledby="tab:R2abl2a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ebl2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebl2a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebl2a:0" aria-labelledby="tab:R2ebl2a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_pending_ssl_certificates&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Market&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created_time"</span>: <span class="token number">1417475501</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"csr"</span>: <span class="token string">&quot;Click to view...-----BEGIN CERTIFICATE REQUEST----- MIIC4DCCAcgCAQAwgZoxFjAUBgNVBAMTDXRlc3RzaW1vbi5jb20xFjAUBgNVBAsT DURvY3VtZW50YXRpb24xDjAMBgNVBAgTBVRleGFzMQ8wDQYDVQQKEwZjUGFuZWwx KDAmBgkqhkiG9w0BCQEWGWxhdXJlbmNlLnNpbW9uQGNwYW5lbC5uZXQxCzAJBgNV BAYTAlVTMRAwDgYDVQQHEwdIb3VzdG9uMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A MIIBCgKCAQEA4AVM6J4Qg3DIFWr/eJ5GRmIATYsJIepKbrDy70sq+udcO8R8xxak 0oMZ/9mUdpjSNK/fLVTuCO0kxTfQ9VUWJllX7ThD6Zh9ZvlC/nf/OEZLm3ZbnBgu 8rbC8E9wuDOkKbJLnINgdhtowIydLK2MJ++q62bFV89jkHWTMcKyyqHENo3hc+lk pd9vnp8rZTinaVb7nX26uQqAFZYRo+WU0G/NPsq40QVSMoqPxyEz4qXo0hvuIlCX mzFZq/6fCVPEKPLhQgMmpdBkMz4dVOazREfqXdjMD2+QXSNiA1AwWr8l0r4rtzlx EYDJIR41yXp0xMl3KoolxMyvLBqZy32niQIDAQABoAAwDQYJKoZIhvcNAQEFBQAD ggEBAEaCn+rg6qlhp6SEKuZg1G6z1M+1XQoTN3E6bTdM3rD1wXjqtyFfYGTy5Bvv gUKrl6t312owJ2si8/K9v/ocVxdjc0rPWSOWScfSc1Od3i1L1YuqbboL2aQSak3y gpGnZMHCUED1y4xyABAFOaXUurFiZj5u3P2mBAYGt2ez2afiPlo5YpTRNCoTUlVz KNKkyUnptBLOvlwGgerBmOoP4QdVhTSuxO9TECsiPdldE1BVZrlFclDFvoP01jFZ WOTWz+k3O202gK4w/tPP2VMVldNFrC0QoENu85ohT1nJj6F3mrM1CZ+1c8zYzr+S 6aAXFhHE6FweeunRAGjEJggoTPo= -----END CERTIFICATE REQUEST-----&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expired"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_poll_time"</span>: <span class="token number">1437475501</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"identity_verification"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"assumed_name"</span>: <span class="token string">&quot;cPanel&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"business_category"</span>: <span class="token string">&quot;b&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"countryName"</span>: <span class="token string">&quot;US&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"date_of_incorporation"</span>: <span class="token string">&quot;1996-01-01&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"duns_number"</span>: <span class="token string">&quot;12-345-6789&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"joi_country_name"</span>: <span class="token string">&quot;US&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"joi_locality_name"</span>: <span class="token string">&quot;Somewhere&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"joi_state_or_province_name"</span>: <span class="token string">&quot;PA&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"localityName"</span>: <span class="token string">&quot;Houston&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"organizationName"</span>: <span class="token string">&quot;WebPros International, LLC&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"organizationalUnitName"</span>: <span class="token string">&quot;Team Cobra&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"postalCode"</span>: <span class="token string">&quot;77092&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rep_email_address"</span>: <span class="token string">&quot;richard.ang@cpanel.net&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rep_forename"</span>: <span class="token string">&quot;Richard&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rep_surname"</span>: <span class="token string">&quot;Ang&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rep_telephone"</span>: <span class="token string">&quot;713-529-0800&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"stateOrProvinceName"</span>: <span class="token string">&quot;TX&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"streetAddress"</span>: <span class="token string">&quot;2500 N. Loop W.&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_poll_time"</span>: <span class="token number">1457475501</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_status_code"</span>: <span class="token string">&quot;CertificateNotFound&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"order_id"</span>: <span class="token string">&quot;AAE35B28-E57B-11E5-A5DD-B633DD41FB49&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"order_item_id"</span>: <span class="token string">&quot;1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_id"</span>: <span class="token string">&quot;12345&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider"</span>: <span class="token string">&quot;cPStore&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">&quot;confirmed&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"support_uri"</span>: <span class="token string">&quot;</span><a href="http://support.example.com/">http://support.example.com/</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vhost_names"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/SSL-Certificates/operation/get_ssl_certificate_if_available" data-section-id="tag/SSL-Certificates/operation/get_ssl_certificate_if_available" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_ssl_certificate_if_available" id="operation/get_ssl_certificate_if_available" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSL-Certificates/operation/get_ssl_certificate_if_available" aria-label="tag/SSL-Certificates/operation/get_ssl_certificate_if_available"></a>Return provider&#x27;s available SSL certificates </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves SSL certificates when they are available from the cPanel Market provider.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves SSL certificates when they are available from the cPanel Market provider.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="order_item_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">order_item_id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">order_item_id=8675309</span></div><div><div html="&lt;p&gt;The order item for which to poll.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The order item for which to poll.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="provider" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">provider</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">provider=cPStore</span></div><div><div html="&lt;p&gt;The cPanel Market provider&amp;#39;s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel Market provider&#39;s name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Market/get_ssl_certificate_if_available</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Market/get_ssl_certificate_if_available</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2acl2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2acl2a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2acl2a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acl2a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2acl2a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acl2a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2acl2a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acl2a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2acl2a:0" aria-labelledby="tab:R2acl2a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Market <span class="token punctuation">\</span>
  get_ssl_certificate_if_available <span class="token punctuation">\</span>
  <span class="token assign-left variable">provider</span><span class="token operator">=</span><span class="token string">'cPStore'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">order_item_id</span><span class="token operator">=</span><span class="token string">'8675309'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acl2a:1" aria-labelledby="tab:R2acl2a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acl2a:2" aria-labelledby="tab:R2acl2a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acl2a:3" aria-labelledby="tab:R2acl2a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ecl2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ecl2a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ecl2a:0" aria-labelledby="tab:R2ecl2a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_ssl_certificate_if_available&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Market&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"certificate_pem"</span>: <span class="token string">&quot;-----BEGIN CERTIFICATE----- MIIDcTCCAlmgAwIBAgIFAU+BNVgwDQYJKoZIhvcNAQEFBQAwUTESMBAGA1UEAwwJ c2lza28udGxkMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGY1BhbmVsMQswCQYDVQQI DAJUWDEQMA4GA1UEBwwHSG91c3RvbjAeFw0xNDEwMDYyMjI2MTlaFw0xNTEwMDYy MjI2MTlaMFExEjAQBgNVBAMMCXNpc2tvLnRsZDELMAkGA1UEBhMCVVMxDzANBgNV BAoMBmNQYW5lbDELMAkGA1UECAwCVFgxEDAOBgNVBAcMB0hvdXN0b24wggEiMA0G CSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9zx6zGiHdmWA0dKtoXmJiWXpZ9E3P Xx3YHsjFEWW7e5pH0vZ+jVMzDmm5nsJ7RXrAkZO1IvpIpVLvoQfiJOWVvkD+o9fW voK1tWJS72FSgPju+58mA2ieBuc87A790Pzuv1P3NR3zFLAjUR99zkHR1fpri/da M3PBWO8ET48FWkyU1kOeZaUlF67/+wrEiNgg+t1qhKOCAB61PdNVkLaSGHimksuC +Czk8Kq9nuS0E0TCnDtjjEyJ455FUcaCfczlTb8xkB/F9ORe74yTzD+vlk0tFMG6 PLj/ajIwWqwO0qmQ8wX3NRxkWgGz5kVO1wrVJarKQ5EYQ3/mgvit0v6dAgMBAAGj UDBOMB0GA1UdDgQWBBRw+wKBo34+bgexjAa3EMDsgSCd7zAfBgNVHSMEGDAWgBRw +wKBo34+bgexjAa3EMDsgSCd7zAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUA A4IBAQCHRXIs53opzKM2rM8Qe8lcw524WK6hqy2EWrZHp78N7rU7/6DQ/I3hv3Wh cDDIO04I2/Xhe88MLBaLoM367Ya+vy7CaLr14aLi/SfQszMA0ALBvMao+Fis0iVw FYq/NLgSXw+fgnpFskt8v8iQZ+4Kaal8U8e9sVgu8m0RgO7rzym1eRiIKpsKd1rh /SD7LbSN7M7TRL3QqF7ltw9sQhAAsQcRaBBF21pdWrqhiGZ+Eioo3hhgwNavH2ag qz78ddHwrFpHFwrEeUk1OfpPb76MYIce7xIy/4oQNdg6fOq4l/FrajBv+WkzDVPa Km6r7YmwfLN/YMZBHXSR58oOGP9W -----END CERTIFICATE-----&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"encrypted_action_urls"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"evClickThroughStatus"</span>: <span class="token string">&quot;mgs8RgnN0rkRmJz0SAMvjLokoPoXm5LdzEkmKA7IsGmzvU5XTrFInOegFBbWFycToS7FPOevzkH9\\nZp0+QG1xcC/0bWKB1cNeTiYB3Fmv0HGu2ZsA+AYgIhSsZikyD9M6YbHk1IZA3GLNPl8DxX5zG9LQ\\nHiv7Ll2QMJcPmMaJ3xktTY9NuiaPiPmYBljEE094LeqabP3w/kRALDnhR4FcwjsTn7iDJKoxtKju\\nP/DbgV32vhESwWoaKrIYPkSJ/Dav0a/LQqLqD3Jg27WgrW+GaZSbHlHr09UQW/2CIiIK7jbUoLG3\\nANL0fKevyjxrBjCfXQq0umXcZIJPWo4gfukfkQ==\\n&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ovCallbackStatus"</span>: <span class="token string">&quot;mgs8RgnN0rkRmJz0SAMvjLokoPoXm5LdzEkmKA7IsGmzvU5XTrFInOegFBbWFycToS7FPOevzkH9\\nZp0+QG1xcC/0bWKB1cNeTiYB3Fmv0HGu2ZsA+AYgIhSsZikyD9M6YbHk1IZA3GLNPl8DxX5zG9LQ\\nHiv7Ll2QMJcPmMaJ3xktTY9NuiaPiPmYBljEE094LeqabP3w/kRALDnhR4FcwjsTn7iDJKoxtKju\\nP/DbgV32vhESwWoaKrIYPkSJ/Dav0a/LQqLqD3Jg27WgrW+GaZSbHlHr09UQW/2CIiIK7jbUoLG3\\nANL0fKevyjxrBjCfXQq0umXcZIJPWo4gfukfkQ==\\n&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status_code"</span>: <span class="token string">&quot;RequiresApproval&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status_message"</span>: <span class="token string">&quot;PRE-SIGN FAILED: CAA: Processing error&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/SSL-Certificates/operation/Market-get_provider_specific_dcv_constraints" data-section-id="tag/SSL-Certificates/operation/Market-get_provider_specific_dcv_constraints" class="sc-dntaoT ceciOs"><div data-section-id="operation/Market-get_provider_specific_dcv_constraints" id="operation/Market-get_provider_specific_dcv_constraints" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSL-Certificates/operation/Market-get_provider_specific_dcv_constraints" aria-label="tag/SSL-Certificates/operation/Market-get_provider_specific_dcv_constraints"></a>Return provider&#x27;s DCV filename requirements </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the provider&amp;#39;s filename requirements for Domain Control Validation (DCV) checks.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the provider&#39;s filename requirements for Domain Control Validation (DCV) checks.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="provider" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">provider</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">provider=cPStore</span></div><div><div html="&lt;p&gt;The cPanel Market provider&amp;#39;s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel Market provider&#39;s name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Market/get_provider_specific_dcv_constraints</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Market/get_provider_specific_dcv_constraints</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2adl2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2adl2a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2adl2a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adl2a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2adl2a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adl2a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2adl2a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adl2a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2adl2a:0" aria-labelledby="tab:R2adl2a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Market <span class="token punctuation">\</span>
  get_provider_specific_dcv_constraints <span class="token punctuation">\</span>
  <span class="token assign-left variable">provider</span><span class="token operator">=</span><span class="token string">'cPStore'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adl2a:1" aria-labelledby="tab:R2adl2a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adl2a:2" aria-labelledby="tab:R2adl2a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adl2a:3" aria-labelledby="tab:R2adl2a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2edl2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2edl2a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2edl2a:0" aria-labelledby="tab:R2edl2a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_provider_specific_dcv_constraints&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Market&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dcv_file_allowed_characters"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">0</span>,</div></li><li><div class="hoverable "><span class="token number">1</span>,</div></li><li><div class="hoverable "><span class="token number">2</span>,</div></li><li><div class="hoverable "><span class="token number">3</span>,</div></li><li><div class="hoverable "><span class="token number">4</span>,</div></li><li><div class="hoverable "><span class="token number">5</span>,</div></li><li><div class="hoverable "><span class="token number">6</span>,</div></li><li><div class="hoverable "><span class="token number">7</span>,</div></li><li><div class="hoverable "><span class="token number">8</span>,</div></li><li><div class="hoverable "><span class="token number">9</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;A&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;B&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;C&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;D&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;E&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;F&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dcv_file_extension"</span>: <span class="token string">&quot;txt&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dcv_file_random_character_count"</span>: <span class="token number">32</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dcv_file_relative_path"</span>: <span class="token string">&quot;.well-known/pki-validation&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dcv_max_redirects"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dcv_user_agent_string"</span>: <span class="token string">&quot;COMODO DCV&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/SSL-Certificates/operation/request_ssl_certificates" data-section-id="tag/SSL-Certificates/operation/request_ssl_certificates" class="sc-dntaoT ceciOs"><div data-section-id="operation/request_ssl_certificates" id="operation/request_ssl_certificates" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSL-Certificates/operation/request_ssl_certificates" aria-label="tag/SSL-Certificates/operation/request_ssl_certificates"></a>Request SSL certificate order </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function submits a request for a certificate order to the cPanel Market provider.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function submits a request for a certificate order to the cPanel Market provider.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="access_token" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">access_token</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">access_token=725431a1-d5bc-11e5-a28b-8b0e09a93f05</span></div><div><div html="&lt;p&gt;The access token for the session to the cPanel Market provider.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The access token for the session to the cPanel Market provider.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="certificate" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand certificate"><span class="property-name">certificate</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">certificate={&quot;price&quot;:6,&quot;product_id&quot;:&quot;143&quot;,&quot;subject_names&quot;:[{&quot;dNSName&quot;:&quot;example.com&quot;},{&quot;dNSName&quot;:&quot;example.org&quot;}],&quot;validity_period&quot;:[&quot;1, \&quot;year\&quot;&quot;],&quot;vhost_names&quot;:[&quot;example.com&quot;]}</span></div><div><div html="&lt;p&gt;A JSON-encoded string that contains the details of the certificate.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To request multiple certificates, duplicate or increment the parameter name.
For example, to request three certificates, use the &lt;code&gt;certificate&lt;/code&gt; parameter multiple times or use the &lt;code&gt;certificate-1&lt;/code&gt;,
&lt;code&gt;certificate-2&lt;/code&gt;, and &lt;code&gt;certificate-3&lt;/code&gt; parameters.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A JSON-encoded string that contains the details of the certificate.</p>
<p><strong>Note:</strong></p>
<p>To request multiple certificates, duplicate or increment the parameter name.
For example, to request three certificates, use the <code>certificate</code> parameter multiple times or use the <code>certificate-1</code>,
<code>certificate-2</code>, and <code>certificate-3</code> parameters.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="identity_verification" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">identity_verification</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">identity_verification={&quot;countryName&quot;:&quot;US&quot;,&quot;duns_number&quot;:&quot;12-345-6789&quot;,&quot;localityName&quot;:&quot;City Name&quot;,&quot;organizationName&quot;:&quot;Company, Inc.&quot;,&quot;organizationalUnitName&quot;:&quot;Team Company,&quot;,&quot;postalCode&quot;:55555,&quot;rep_email_address&quot;:&quot;username@example.com&quot;,&quot;rep_forename&quot;:&quot;First Name&quot;,&quot;rep_surname&quot;:&quot;Last Name&quot;,&quot;rep_telephone&quot;:&quot;123-456-7891&quot;,&quot;stateOrProvinceName&quot;:&quot;ST&quot;,&quot;streetAddress&quot;:&quot;555 Street Name&quot;}</span></div><div><div html="&lt;p&gt;An object containing the required information for an EV or OV certificate. This information depends on the provider of the certificate.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;The function returns this object for OV or EV certificate requests.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An object containing the required information for an EV or OV certificate. This information depends on the provider of the certificate.</p>
<p><strong>Note:</strong></p>
<p>The function returns this object for OV or EV certificate requests.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="provider" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">provider</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">provider=cPStore</span></div><div><div html="&lt;p&gt;The cPanel Market provider&amp;#39;s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel Market provider&#39;s name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="url_after_checkout" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">url_after_checkout</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;url&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">url_after_checkout=http://checkout.example.com</span></div><div><div html="&lt;p&gt;The URL to send the browser after the user checks out.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This URL does &lt;strong&gt;not&lt;/strong&gt; contain a query string.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The URL to send the browser after the user checks out.</p>
<p><strong>Note:</strong></p>
<p>This URL does <strong>not</strong> contain a query string.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Market/request_ssl_certificates</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Market/request_ssl_certificates</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ael2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ael2a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ael2a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ael2a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2ael2a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ael2a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2ael2a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ael2a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ael2a:0" aria-labelledby="tab:R2ael2a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi --output-jsonpretty <span class="token parameter variable">--user</span><span class="token operator">=</span>username Market request_ssl_certificates <span class="token assign-left variable">access_token</span><span class="token operator">=</span><span class="token string">'725431a1-d5bc-11e5-a28b-8b0e09a93f05'</span> <span class="token assign-left variable">certificate</span><span class="token operator">=</span><span class="token string">'{"price":"6","product_id":"143","subject_names":[{"dNSName":"example.com"},{"dNSName":"example.org"}],"validity_period":["1, \"year\""],"vhost_names":["example.com"]}'</span> <span class="token assign-left variable">provider</span><span class="token operator">=</span><span class="token string">'cPStore'</span></pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ael2a:1" aria-labelledby="tab:R2ael2a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ael2a:2" aria-labelledby="tab:R2ael2a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ael2a:3" aria-labelledby="tab:R2ael2a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eel2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eel2a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eel2a:0" aria-labelledby="tab:R2eel2a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;request_ssl_certificates&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Market&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"certificates"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"key_id"</span>: <span class="token string">&quot;ac90f_639fd_6c236062f0d7a4579a30e01612c4cee0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"order_item_id"</span>: <span class="token number">12345</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"checkout_url"</span>: <span class="token string">&quot;</span><a href="http://store.example.com/showmethemoney.cgi">http://store.example.com/showmethemoney.cgi</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"order_id"</span>: <span class="token number">123456</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/SSL-Certificates/operation/process_ssl_pending_queue" data-section-id="tag/SSL-Certificates/operation/process_ssl_pending_queue" class="sc-dntaoT ceciOs"><div data-section-id="operation/process_ssl_pending_queue" id="operation/process_ssl_pending_queue" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSL-Certificates/operation/process_ssl_pending_queue" aria-label="tag/SSL-Certificates/operation/process_ssl_pending_queue"></a>Start processing pending queue&#x27;s SSL certificates </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function manually processes the cPanel Market&amp;#39;s SSL certificate request pending queue.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function manually processes the cPanel Market&#39;s SSL certificate request pending queue.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Market/process_ssl_pending_queue</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Market/process_ssl_pending_queue</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2afl2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2afl2a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2afl2a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2afl2a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2afl2a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2afl2a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2afl2a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2afl2a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2afl2a:0" aria-labelledby="tab:R2afl2a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Market <span class="token punctuation">\</span>
  process_ssl_pending_queue
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2afl2a:1" aria-labelledby="tab:R2afl2a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2afl2a:2" aria-labelledby="tab:R2afl2a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2afl2a:3" aria-labelledby="tab:R2afl2a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2efl2a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2efl2a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2efl2a:0" aria-labelledby="tab:R2efl2a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;process_ssl_pending_queue&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Market&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"certificate_pem"</span>: <span class="token string">&quot;null&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_time"</span>: <span class="token number">1460136406</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"csr"</span>: <span class="token string">&quot;-----BEGIN CERTIFICATE REQUEST-----\\nMIICqjCCAZICAQAwHDEaMBgGA1UEAxMRY3BhbmVsc3NsdGVzdC5vcmcwggEiMA0G\\nCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCqu4KLPxCgAENTJFjcUyc4v5KaF8Lu\\n2OldjIT/vB58IRCIUxdDSD29v/qHFVBaUFEtr+Ssey0strMcc6JYSl8Vdwfe2qwv\\npB6+Ufg+hlN4lAgojxgwz7iZlPnGuRVfNTvNMmljVRzGDc4SSzskpDxZhk+aaMgP\\nSkMLFg6f6pFZ+44alridlSG5gxD34xWAtt8Qy2v+6Q4XVuMNCd9KlyAoCV9Q+wH1\\nq49yoRdwvcY6G6mqlFWtHsToz4tdYk/Nt7odZnyKcjHWGWnlRzO2FGbbBxVKF8s6\\ns3DL5OwPRfQQD18V7eL7NmcFo45zmdndBOevrLuwXJ1yWITM2bmYgF1nAgMBAAGg\\nSTBHBgkqhkiG9w0BCQ4xOjA4MDYGA1UdEQEB/wQsMCqCEWNwYW5lbHNzbHRlc3Qu\\nb3JnghV3d3cuY3BhbmVsc3NsdGVzdC5vcmcwDQYJKoZIhvcNAQELBQADggEBAFAJ\\nSqTvd3d8PN26UiT4uX0WjofaX8u1/11hU5Saekai0Dxl/ijq2R7TpebXe9r0t6Cr\\ns7NXKszVoKzQHV4nSFbfb3ZxEsnVDXbPUv3D+oLfGpMASLG+P2yOjmDhzZBNJgo4\\nQu6nf6ggJxJ0PRM81xL234FAKqsOvvTwTLXtYVrwbUCzfB+yKJXvfeGETR/3HGxR\\nqoJ97Zmjsbw78fETEsZ6rsBHDPuxtxum73BC7qoLjCl4psPznHshXvWTeV9fyR3c\\nqpdpLvwBxhI8ZOWoNGgJlUpY9jUFgqG+YI/Mkmzmxk9QC9edIHSScTXxroYkmwMC\\nginnKRLDafSp+7FyIzs=\\n-----END CERTIFICATE REQUEST-----&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expired"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"first_poll_time"</span>: <span class="token number">1458061262</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"installed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_poll_time"</span>: <span class="token number">1458061299</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_status_code"</span>: <span class="token string">&quot;CertificateNotFound&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_status_message"</span>: <span class="token string">&quot;PRE-SIGN FAILED: CAA: Processing error&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"order_id"</span>: <span class="token string">&quot;19461&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"order_item_id"</span>: <span class="token string">&quot;f9d7&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"product_id"</span>: <span class="token string">&quot;fg2&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"provider"</span>: <span class="token string">&quot;cPStore&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">&quot;confirmed&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vhost_names"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Contact-Information" data-section-id="tag/Contact-Information" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Contact-Information" aria-label="tag/Contact-Information"></a>Contact Information</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;cPanel Account / Contact Information&lt;/p&gt;
"><p>cPanel Account / Contact Information</p>
</div></div></div><div id="tag/Contact-Information/operation/contactinformation-unset_email_addresses" data-section-id="tag/Contact-Information/operation/contactinformation-unset_email_addresses" class="sc-dntaoT ceciOs"><div data-section-id="operation/contactinformation-unset_email_addresses" id="operation/contactinformation-unset_email_addresses" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Contact-Information/operation/contactinformation-unset_email_addresses" aria-label="tag/Contact-Information/operation/contactinformation-unset_email_addresses"></a>Unset contact email addresses </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;Use this function to unset all contact email address for an account.&lt;/p&gt;
&lt;p&gt;To set contact email address(es), call &lt;code&gt;set_email_addresses&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>Use this function to unset all contact email address for an account.</p>
<p>To set contact email address(es), call <code>set_email_addresses</code>.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="old_address" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">old_address</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">strings</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR gjyOxn kpFoWb">[ items<span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email &gt;</span> ]</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">old_address=old1@example.com</span></div><div><div html="&lt;p&gt;The account’s existing contact email addresses.&lt;/p&gt;
&lt;p&gt;If this list does not match the account’s current current email address(es),
then the request will fail. This control is here to prevent
race conditions.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account’s existing contact email addresses.</p>
<p>If this list does not match the account’s current current email address(es),
then the request will fail. This control is here to prevent
race conditions.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="password" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">password</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">password=q1df%D9&lt;z0ShqdxRP%^</span></div><div><div html="&lt;p&gt;The account’s password.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account’s password.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/ContactInformation/unset_email_addresses</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/ContactInformation/unset_email_addresses</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riir2q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riir2q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riir2q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riir2q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riir2q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riir2q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riir2q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riir2q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riir2q:0" aria-labelledby="tab:Riir2q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  ContactInformation <span class="token punctuation">\</span>
  unset_email_addresses <span class="token punctuation">\</span>
  <span class="token assign-left variable">old_address</span><span class="token operator">=</span><span class="token string">'old1@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">password</span><span class="token operator">=</span><span class="token string">'q1df%D9&lt;z0ShqdxRP%^'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riir2q:1" aria-labelledby="tab:Riir2q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riir2q:2" aria-labelledby="tab:Riir2q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riir2q:3" aria-labelledby="tab:Riir2q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjir2q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjir2q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjir2q:0" aria-labelledby="tab:Rjir2q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;create&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DynamicDNS&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Contact-Information/operation/contactinformation-set_email_addresses" data-section-id="tag/Contact-Information/operation/contactinformation-set_email_addresses" class="sc-dntaoT ceciOs"><div data-section-id="operation/contactinformation-set_email_addresses" id="operation/contactinformation-set_email_addresses" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Contact-Information/operation/contactinformation-set_email_addresses" aria-label="tag/Contact-Information/operation/contactinformation-set_email_addresses"></a>Set contact email address(es) </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;Use this function to set an account&amp;#39;s contact email address(es).&lt;/p&gt;
&lt;p&gt;To unset all contact email addresses, call &lt;code&gt;unset_email_addresses&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>Use this function to set an account&#39;s contact email address(es).</p>
<p>To unset all contact email addresses, call <code>unset_email_addresses</code>.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="address" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">address</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">strings</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR gjyOxn kpFoWb">[ items<span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email &gt;</span> ]</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">address=foo@example.com&amp;address=bar@example.com</span></div><div><div html="&lt;p&gt;The account’s new contact email addresses.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account’s new contact email addresses.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="old_address" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">old_address</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">strings</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR gjyOxn kpFoWb">[ items<span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email &gt;</span> ]</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">old_address=old1@example.com</span></div><div><div html="&lt;p&gt;The account’s existing contact email addresses.&lt;/p&gt;
&lt;p&gt;If this list does not match the account’s current current email address(es),
then the request will fail. This control is here to prevent
race conditions.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account’s existing contact email addresses.</p>
<p>If this list does not match the account’s current current email address(es),
then the request will fail. This control is here to prevent
race conditions.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="password" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">password</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">password=q1df%D9&lt;z0ShqdxRP%^</span></div><div><div html="&lt;p&gt;The account’s password.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account’s password.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/ContactInformation/set_email_addresses</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/ContactInformation/set_email_addresses</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rijb2q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rijb2q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rijb2q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijb2q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rijb2q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijb2q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rijb2q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijb2q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rijb2q:0" aria-labelledby="tab:Rijb2q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  ContactInformation <span class="token punctuation">\</span>
  set_email_addresses <span class="token punctuation">\</span>
  <span class="token assign-left variable">address</span><span class="token operator">=</span><span class="token string">'foo@example.com'</span> <span class="token assign-left variable">address</span><span class="token operator">=</span><span class="token string">'bar@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">old_address</span><span class="token operator">=</span><span class="token string">'old1@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">password</span><span class="token operator">=</span><span class="token string">'q1df%D9&lt;z0ShqdxRP%^'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijb2q:1" aria-labelledby="tab:Rijb2q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijb2q:2" aria-labelledby="tab:Rijb2q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijb2q:3" aria-labelledby="tab:Rijb2q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjjb2q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjjb2q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjjb2q:0" aria-labelledby="tab:Rjjb2q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_email_addresses&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;ContactInformation&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Contact-Information/operation/is_enabled" data-section-id="tag/Contact-Information/operation/is_enabled" class="sc-dntaoT ceciOs"><div data-section-id="operation/is_enabled" id="operation/is_enabled" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Contact-Information/operation/is_enabled" aria-label="tag/Contact-Information/operation/is_enabled"></a>Return whether contact option is enabled </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function checks whether the cPanel account can contact their hosting provider from the cPanel interface.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether the cPanel account can contact their hosting provider from the cPanel interface.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Contactus/is_enabled</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Contactus/is_enabled</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rijr2q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rijr2q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rijr2q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijr2q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rijr2q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijr2q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rijr2q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijr2q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rijr2q:0" aria-labelledby="tab:Rijr2q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Contactus <span class="token punctuation">\</span>
  is_enabled
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijr2q:1" aria-labelledby="tab:Rijr2q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijr2q:2" aria-labelledby="tab:Rijr2q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijr2q:3" aria-labelledby="tab:Rijr2q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjjr2q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjjr2q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjjr2q:0" aria-labelledby="tab:Rjjr2q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;is_enabled&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Contactus&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Account-Enhancements" data-section-id="tag/Account-Enhancements" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Enhancements" aria-label="tag/Account-Enhancements"></a>Account Enhancements</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;The Account Enhancement module for UAPI.&lt;/p&gt;
"><p>The Account Enhancement module for UAPI.</p>
</div></div></div><div id="tag/Account-Enhancements/operation/AccountEnhancements-list" data-section-id="tag/Account-Enhancements/operation/AccountEnhancements-list" class="sc-dntaoT ceciOs"><div data-section-id="operation/AccountEnhancements-list" id="operation/AccountEnhancements-list" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Enhancements/operation/AccountEnhancements-list" aria-label="tag/Account-Enhancements/operation/AccountEnhancements-list"></a>Return all cPanel account&#x27;s Account Enhancements </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists a cPanel account&amp;#39;s &lt;a href=&quot;https://go.cpanel.net/account-enhancements&quot;&gt;Account Enhancements&lt;/a&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists a cPanel account&#39;s <a href="https://go.cpanel.net/account-enhancements">Account Enhancements</a>.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/AccountEnhancements/list</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/AccountEnhancements/list</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4km33a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4km33a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4km33a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4km33a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4km33a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4km33a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4km33a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4km33a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4km33a:0" aria-labelledby="tab:R4km33a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  AccountEnhancements <span class="token punctuation">\</span>
  list
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4km33a:1" aria-labelledby="tab:R4km33a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4km33a:2" aria-labelledby="tab:R4km33a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4km33a:3" aria-labelledby="tab:R4km33a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sm33a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sm33a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sm33a:0" aria-labelledby="tab:R4sm33a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;AccountEnhancements&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;sample-enhancement-id&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;Sample Enhancement&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Account-Enhancements/operation/AccountEnhancements-has-enhancement" data-section-id="tag/Account-Enhancements/operation/AccountEnhancements-has-enhancement" class="sc-dntaoT ceciOs"><div data-section-id="operation/AccountEnhancements-has-enhancement" id="operation/AccountEnhancements-has-enhancement" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Enhancements/operation/AccountEnhancements-has-enhancement" aria-label="tag/Account-Enhancements/operation/AccountEnhancements-has-enhancement"></a>Validate Account Enhancement assignment </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns whether a cPanel account has a specific &lt;a href=&quot;https://go.cpanel.net/account-enhancements&quot;&gt;Account Enhancement&lt;/a&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns whether a cPanel account has a specific <a href="https://go.cpanel.net/account-enhancements">Account Enhancement</a>.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">id=sample-enhancement-id</span></div><div><div html="&lt;p&gt;The identifier for a specific Account Enhancement.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To retrieve a list of all Account Enhancements IDs on the server, run the WHM API 1 &lt;code&gt;list_account_enhancements&lt;/code&gt; function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The identifier for a specific Account Enhancement.</p>
<p><strong>Note:</strong></p>
<p>To retrieve a list of all Account Enhancements IDs on the server, run the WHM API 1 <code>list_account_enhancements</code> function.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/AccountEnhancements/has_enhancement</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/AccountEnhancements/has_enhancement</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kq33a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kq33a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kq33a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kq33a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kq33a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kq33a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kq33a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kq33a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kq33a:0" aria-labelledby="tab:R4kq33a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  AccountEnhancements <span class="token punctuation">\</span>
  has_enhancement <span class="token punctuation">\</span>
  <span class="token assign-left variable">id</span><span class="token operator">=</span>account_enhancement
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kq33a:1" aria-labelledby="tab:R4kq33a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kq33a:2" aria-labelledby="tab:R4kq33a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kq33a:3" aria-labelledby="tab:R4kq33a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sq33a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sq33a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sq33a:0" aria-labelledby="tab:R4sq33a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;AccountEnhancements&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Account-Information" data-section-id="tag/Account-Information" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Information" aria-label="tag/Account-Information"></a>Account Information</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;cPanel Account / Account Information&lt;/p&gt;
"><p>cPanel Account / Account Information</p>
</div></div></div><div id="tag/Account-Information/operation/list_accounts" data-section-id="tag/Account-Information/operation/list_accounts" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_accounts" id="operation/list_accounts" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Information/operation/list_accounts" aria-label="tag/Account-Information/operation/list_accounts"></a>Return reseller&#x27;s cPanel accounts </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists all of a reseller&amp;#39;s cPanel accounts.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists all of a reseller&#39;s cPanel accounts.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Resellers/list_accounts</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Resellers/list_accounts</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4km53a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4km53a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4km53a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4km53a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4km53a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4km53a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4km53a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4km53a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4km53a:0" aria-labelledby="tab:R4km53a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Resellers <span class="token punctuation">\</span>
  list_accounts
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4km53a:1" aria-labelledby="tab:R4km53a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4km53a:2" aria-labelledby="tab:R4km53a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4km53a:3" aria-labelledby="tab:R4km53a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sm53a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sm53a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sm53a:0" aria-labelledby="tab:R4sm53a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_accounts&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Resellers&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"select"</span>: <span class="token string">&quot;1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">&quot;username&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Account-Information/operation/Variables-get_user_information" data-section-id="tag/Account-Information/operation/Variables-get_user_information" class="sc-dntaoT ceciOs"><div data-section-id="operation/Variables-get_user_information" id="operation/Variables-get_user_information" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Information/operation/Variables-get_user_information" aria-label="tag/Account-Information/operation/Variables-get_user_information"></a>Return cPanel account&#x27;s configuration settings </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves the user&amp;#39;s account configuration settings.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the user&#39;s account configuration settings.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">name</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=name-1=mailbox_format&amp;name-2=home&amp;name-3=shell</span> - Get multiple account configuration settings.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=mailbox_format</span> - Get a single account configuration setting.</li></ul><div><div html="&lt;p&gt;The user configuration variables to retrieve. If you don&amp;#39;t use this parameter, this function returns &lt;strong&gt;all&lt;/strong&gt; of the user&amp;#39;s configuration data.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To retrieve multiple account configuration settings for a user, increment the parameter name. For example: &lt;code&gt;name-0&lt;/code&gt;, &lt;code&gt;name-1&lt;/code&gt;, and &lt;code&gt;name-2&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user configuration variables to retrieve. If you don&#39;t use this parameter, this function returns <strong>all</strong> of the user&#39;s configuration data.</p>
<p><strong>Note:</strong></p>
<p>To retrieve multiple account configuration settings for a user, increment the parameter name. For example: <code>name-0</code>, <code>name-1</code>, and <code>name-2</code>.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Variables/get_user_information</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Variables/get_user_information</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kq53a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kq53a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kq53a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kq53a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kq53a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kq53a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kq53a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kq53a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kq53a:0" aria-labelledby="tab:R4kq53a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Variables <span class="token punctuation">\</span>
  get_user_information
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kq53a:1" aria-labelledby="tab:R4kq53a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kq53a:2" aria-labelledby="tab:R4kq53a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kq53a:3" aria-labelledby="tab:R4kq53a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sq53a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sq53a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sq53a:0" aria-labelledby="tab:R4sq53a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_user_information&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Variables&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"backup_enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"bandwidth_limit"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cgi_enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"contact_email"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"contact_email_2"</span>: <span class="token string">&quot;user2@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cpanel_root_directory"</span>: <span class="token string">&quot;/usr/local/cpanel&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token number">1432220941</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_in_version"</span>: <span class="token string">&quot;11.94.0.0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"database_owner"</span>: <span class="token string">&quot;root&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dead_domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example.example.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"demo_mode"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"disk_block_limit"</span>: <span class="token number">100000000</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dkim_enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"feature"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"custom_feature"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"feature_list"</span>: <span class="token string">&quot;feature_list&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"gid"</span>: <span class="token number">5678</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"home"</span>: <span class="token string">&quot;/home/user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"home_directory_links"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;symlink&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip"</span>: <span class="token string">&quot;192.0.2.0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lang"</span>: <span class="token string">&quot;english&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_modified"</span>: <span class="token number">1416586493</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"legacy_backup_enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"locale"</span>: <span class="token string">&quot;en&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mailbox_format"</span>: <span class="token string">&quot;maildir&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maximum_addon_domains"</span>: <span class="token string">&quot;unlimited&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maximum_databases"</span>: <span class="token string">&quot;unlimited&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maximum_defer_fail_percentage"</span>: <span class="token string">&quot;unlimited&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maximum_email_account_disk_quota"</span>: <span class="token string">&quot;unlimited&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maximum_emails_per_hour"</span>: <span class="token string">&quot;unlimited&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maximum_ftp_accounts"</span>: <span class="token string">&quot;unlimited&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maximum_mail_accounts"</span>: <span class="token string">&quot;0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maximum_mailing_lists"</span>: <span class="token string">&quot;unlimited&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maximum_parked_domains"</span>: <span class="token string">&quot;unlimited&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maximum_passenger_apps"</span>: <span class="token string">&quot;unlimited&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maximum_subdomains"</span>: <span class="token string">&quot;unlimited&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mxcheck"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"example.com"</span>: <span class="token string">&quot;local&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"example2.com"</span>: <span class="token string">&quot;remote&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_account_authn_link"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_account_authn_link_notification_disabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_account_login"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_account_login_for_known_netblock"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_account_login_notification_disabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_autossl_expiry"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_autossl_expiry_coverage"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_autossl_renewal_coverage"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_autossl_renewal_coverage_reduced"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_autossl_renewal_uncovered_domains"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_bandwidth_limit"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_contact_address_change"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_contact_address_change_notification_disabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_disk_limit"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_password_change"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_password_change_notification_disabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_ssl_expiry"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_twofactorauth_change"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notify_twofactorauth_change_notification_disabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"owner"</span>: <span class="token string">&quot;root&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"package_extensions"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;ext1&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;ext2&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;ext3&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"plan"</span>: <span class="token string">&quot;packagename&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pushbullet_access_token"</span>: <span class="token string">&quot;1234567890&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"shell"</span>: <span class="token string">&quot;/bin/bash&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"spf_enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ssl_default_key_type"</span>: <span class="token string">&quot;rsa-2048&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"theme"</span>: <span class="token string">&quot;jupiter&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"uid"</span>: <span class="token number">1234</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">&quot;username&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"utf8_mailbox"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Account-Management" data-section-id="tag/Account-Management" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Management" aria-label="tag/Account-Management"></a>Account Management</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;cPanel Account / Account Management&lt;/p&gt;
"><p>cPanel Account / Account Management</p>
</div></div></div><div id="tag/Account-Management/operation/change_password" data-section-id="tag/Account-Management/operation/change_password" class="sc-dntaoT ceciOs"><div data-section-id="operation/change_password" id="operation/change_password" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Account-Management/operation/change_password" aria-label="tag/Account-Management/operation/change_password"></a>Update cPanel account password </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function updates the cPanel account&amp;#39;s password.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function updates the cPanel account&#39;s password.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="enablemysql" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">enablemysql</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">enablemysql=0</span></div><div><div html="&lt;p&gt;Whether to update the cPanel account&amp;#39;s MySQL password.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Update MySQL password.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Do not update MySQL passowrd.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to update the cPanel account&#39;s MySQL password.</p>
<ul>
<li><code>1</code> - Update MySQL password.</li>
<li><code>0</code> - Do not update MySQL passowrd.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="newpass" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">newpass</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;password&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">newpass=MyNewPassw0rd!</span></div><div><div html="&lt;p&gt;The new password.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new password.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="oldpass" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">oldpass</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;password&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">oldpass=ThisWasMyPassword!</span></div><div><div html="&lt;p&gt;The current password.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The current password.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/UserManager/change_password</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/UserManager/change_password</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ae73a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ae73a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ae73a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ae73a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2ae73a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ae73a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2ae73a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ae73a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ae73a:0" aria-labelledby="tab:R2ae73a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  UserManager <span class="token punctuation">\</span>
  change_password <span class="token punctuation">\</span>
  <span class="token assign-left variable">oldpass</span><span class="token operator">=</span><span class="token string">'MyPreviousPassword'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">newpass</span><span class="token operator">=</span><span class="token string">'MyUpdatedPassword'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ae73a:1" aria-labelledby="tab:R2ae73a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ae73a:2" aria-labelledby="tab:R2ae73a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ae73a:3" aria-labelledby="tab:R2ae73a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ee73a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ee73a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ee73a:0" aria-labelledby="tab:R2ee73a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;change_password&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;UserManager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/AuditLog" data-section-id="tag/AuditLog" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/AuditLog" aria-label="tag/AuditLog"></a>AuditLog</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;The AuditLog module for UAPI.&lt;/p&gt;
"><p>The AuditLog module for UAPI.</p>
</div></div></div><div id="tag/Contact-Information" data-section-id="tag/Contact-Information" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Contact-Information" aria-label="tag/Contact-Information"></a>Contact Information</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;cPanel Account / Contact Information&lt;/p&gt;
"><p>cPanel Account / Contact Information</p>
</div></div></div><div id="tag/Contact-Information/operation/contactinformation-unset_email_addresses" data-section-id="tag/Contact-Information/operation/contactinformation-unset_email_addresses" class="sc-dntaoT ceciOs"><div data-section-id="operation/contactinformation-unset_email_addresses" id="operation/contactinformation-unset_email_addresses" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Contact-Information/operation/contactinformation-unset_email_addresses" aria-label="tag/Contact-Information/operation/contactinformation-unset_email_addresses"></a>Unset contact email addresses </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;Use this function to unset all contact email address for an account.&lt;/p&gt;
&lt;p&gt;To set contact email address(es), call &lt;code&gt;set_email_addresses&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>Use this function to unset all contact email address for an account.</p>
<p>To set contact email address(es), call <code>set_email_addresses</code>.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="old_address" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">old_address</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">strings</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR gjyOxn kpFoWb">[ items<span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email &gt;</span> ]</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">old_address=old1@example.com</span></div><div><div html="&lt;p&gt;The account’s existing contact email addresses.&lt;/p&gt;
&lt;p&gt;If this list does not match the account’s current current email address(es),
then the request will fail. This control is here to prevent
race conditions.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account’s existing contact email addresses.</p>
<p>If this list does not match the account’s current current email address(es),
then the request will fail. This control is here to prevent
race conditions.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="password" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">password</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">password=q1df%D9&lt;z0ShqdxRP%^</span></div><div><div html="&lt;p&gt;The account’s password.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account’s password.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/ContactInformation/unset_email_addresses</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/ContactInformation/unset_email_addresses</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kmb3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kmb3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kmb3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kmb3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kmb3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kmb3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kmb3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kmb3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kmb3a:0" aria-labelledby="tab:R4kmb3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  ContactInformation <span class="token punctuation">\</span>
  unset_email_addresses <span class="token punctuation">\</span>
  <span class="token assign-left variable">old_address</span><span class="token operator">=</span><span class="token string">'old1@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">password</span><span class="token operator">=</span><span class="token string">'q1df%D9&lt;z0ShqdxRP%^'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kmb3a:1" aria-labelledby="tab:R4kmb3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kmb3a:2" aria-labelledby="tab:R4kmb3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kmb3a:3" aria-labelledby="tab:R4kmb3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4smb3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4smb3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4smb3a:0" aria-labelledby="tab:R4smb3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;create&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DynamicDNS&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Contact-Information/operation/contactinformation-set_email_addresses" data-section-id="tag/Contact-Information/operation/contactinformation-set_email_addresses" class="sc-dntaoT ceciOs"><div data-section-id="operation/contactinformation-set_email_addresses" id="operation/contactinformation-set_email_addresses" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Contact-Information/operation/contactinformation-set_email_addresses" aria-label="tag/Contact-Information/operation/contactinformation-set_email_addresses"></a>Set contact email address(es) </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;Use this function to set an account&amp;#39;s contact email address(es).&lt;/p&gt;
&lt;p&gt;To unset all contact email addresses, call &lt;code&gt;unset_email_addresses&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>Use this function to set an account&#39;s contact email address(es).</p>
<p>To unset all contact email addresses, call <code>unset_email_addresses</code>.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="address" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">address</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">strings</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR gjyOxn kpFoWb">[ items<span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email &gt;</span> ]</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">address=foo@example.com&amp;address=bar@example.com</span></div><div><div html="&lt;p&gt;The account’s new contact email addresses.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account’s new contact email addresses.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="old_address" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">old_address</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">strings</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR gjyOxn kpFoWb">[ items<span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email &gt;</span> ]</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">old_address=old1@example.com</span></div><div><div html="&lt;p&gt;The account’s existing contact email addresses.&lt;/p&gt;
&lt;p&gt;If this list does not match the account’s current current email address(es),
then the request will fail. This control is here to prevent
race conditions.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account’s existing contact email addresses.</p>
<p>If this list does not match the account’s current current email address(es),
then the request will fail. This control is here to prevent
race conditions.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="password" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">password</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">password=q1df%D9&lt;z0ShqdxRP%^</span></div><div><div html="&lt;p&gt;The account’s password.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account’s password.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/ContactInformation/set_email_addresses</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/ContactInformation/set_email_addresses</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kqb3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kqb3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kqb3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kqb3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kqb3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kqb3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kqb3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kqb3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kqb3a:0" aria-labelledby="tab:R4kqb3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  ContactInformation <span class="token punctuation">\</span>
  set_email_addresses <span class="token punctuation">\</span>
  <span class="token assign-left variable">address</span><span class="token operator">=</span><span class="token string">'foo@example.com'</span> <span class="token assign-left variable">address</span><span class="token operator">=</span><span class="token string">'bar@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">old_address</span><span class="token operator">=</span><span class="token string">'old1@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">password</span><span class="token operator">=</span><span class="token string">'q1df%D9&lt;z0ShqdxRP%^'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kqb3a:1" aria-labelledby="tab:R4kqb3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kqb3a:2" aria-labelledby="tab:R4kqb3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kqb3a:3" aria-labelledby="tab:R4kqb3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sqb3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sqb3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sqb3a:0" aria-labelledby="tab:R4sqb3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_email_addresses&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;ContactInformation&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Contact-Information/operation/is_enabled" data-section-id="tag/Contact-Information/operation/is_enabled" class="sc-dntaoT ceciOs"><div data-section-id="operation/is_enabled" id="operation/is_enabled" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Contact-Information/operation/is_enabled" aria-label="tag/Contact-Information/operation/is_enabled"></a>Return whether contact option is enabled </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function checks whether the cPanel account can contact their hosting provider from the cPanel interface.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether the cPanel account can contact their hosting provider from the cPanel interface.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Contactus/is_enabled</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Contactus/is_enabled</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kub3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kub3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kub3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kub3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kub3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kub3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kub3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kub3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kub3a:0" aria-labelledby="tab:R4kub3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Contactus <span class="token punctuation">\</span>
  is_enabled
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kub3a:1" aria-labelledby="tab:R4kub3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kub3a:2" aria-labelledby="tab:R4kub3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kub3a:3" aria-labelledby="tab:R4kub3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sub3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sub3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sub3a:0" aria-labelledby="tab:R4sub3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;is_enabled&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Contactus&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/cPanel-Features" data-section-id="tag/cPanel-Features" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Features" aria-label="tag/cPanel-Features"></a>cPanel Features</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;cPanel Account / cPanel Features&lt;/p&gt;
"><p>cPanel Account / cPanel Features</p>
</div></div></div><div id="tag/cPanel-Features/operation/has_feature" data-section-id="tag/cPanel-Features/operation/has_feature" class="sc-dntaoT ceciOs"><div data-section-id="operation/has_feature" id="operation/has_feature" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Features/operation/has_feature" aria-label="tag/cPanel-Features/operation/has_feature"></a>Validate cPanel account&#x27;s feature access </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function checks whether a cPanel account has access to
a &lt;a href=&quot;https://go.cpanel.net/whmdocsFeatureManager#selectable-features&quot;&gt;feature&lt;/a&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether a cPanel account has access to
a <a href="https://go.cpanel.net/whmdocsFeatureManager#selectable-features">feature</a>.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">name</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=autossl</span></div><div><div html="&lt;p&gt;The feature&amp;#39;s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The feature&#39;s name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Features/has_feature</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Features/has_feature</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kmd3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kmd3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kmd3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kmd3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kmd3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kmd3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kmd3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kmd3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kmd3a:0" aria-labelledby="tab:R4kmd3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Features <span class="token punctuation">\</span>
  has_feature <span class="token punctuation">\</span>
  <span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'autossl'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kmd3a:1" aria-labelledby="tab:R4kmd3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kmd3a:2" aria-labelledby="tab:R4kmd3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kmd3a:3" aria-labelledby="tab:R4kmd3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4smd3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4smd3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4smd3a:0" aria-labelledby="tab:R4smd3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Example</span><div class="sc-diYFot sc-frniUE jsRqjj esCYIP"><svg class="sc-kZrBCu JXohG" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="The account does not have a feature." selected="">The account does not have a feature.</option><option value="The feature exists but the account does not have it enabled.">The feature exists but the account does not have it enabled.</option><option value="The account has a feature.">The account has a feature.</option></select><label>The account does not have a feature.</label></div></div><div><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div></div><div id="tag/cPanel-Features/operation/list_features" data-section-id="tag/cPanel-Features/operation/list_features" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_features" id="operation/list_features" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Features/operation/list_features" aria-label="tag/cPanel-Features/operation/list_features"></a>Return cPanel account&#x27;s features </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists a cPanel account&amp;#39;s features.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists a cPanel account&#39;s features.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Features/list_features</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Features/list_features</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kqd3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kqd3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kqd3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kqd3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kqd3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kqd3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kqd3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kqd3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kqd3a:0" aria-labelledby="tab:R4kqd3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Features <span class="token punctuation">\</span>
  list_features
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kqd3a:1" aria-labelledby="tab:R4kqd3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kqd3a:2" aria-labelledby="tab:R4kqd3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kqd3a:3" aria-labelledby="tab:R4kqd3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sqd3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sqd3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sqd3a:0" aria-labelledby="tab:R4sqd3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_features&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Features&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"bbs"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"blockers"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"boxtrapper"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"changemx"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"chat"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"defaultaddress"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email_disk_usage"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"emailarchive"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"emailauth"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"emaildomainfwd"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"emailtrace"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"popaccts"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"spamassassin"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"spambox"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"traceaddy"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updatecontact"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"webmail"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/cPanel-Features/operation/get_feature_metadata" data-section-id="tag/cPanel-Features/operation/get_feature_metadata" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_feature_metadata" id="operation/get_feature_metadata" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Features/operation/get_feature_metadata" aria-label="tag/cPanel-Features/operation/get_feature_metadata"></a>Return cPanel account&#x27;s features&#x27; metadata </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the details of a cPanel account&amp;#39;s available feature lists.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the details of a cPanel account&#39;s available feature lists.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Features/get_feature_metadata</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Features/get_feature_metadata</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kud3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kud3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kud3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kud3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kud3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kud3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kud3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kud3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kud3a:0" aria-labelledby="tab:R4kud3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Features <span class="token punctuation">\</span>
  get_feature_metadata
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kud3a:1" aria-labelledby="tab:R4kud3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kud3a:2" aria-labelledby="tab:R4kud3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kud3a:3" aria-labelledby="tab:R4kud3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sud3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sud3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sud3a:0" aria-labelledby="tab:R4sud3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_feature_metadata&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Features&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;wordpress_manager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_cpaddon"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_plugin"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;Wordpress Manager&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Disk-Quotas" data-section-id="tag/Disk-Quotas" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Disk-Quotas" aria-label="tag/Disk-Quotas"></a>Disk Quotas</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;cPanel Account / Disk Quotas&lt;/p&gt;
"><p>cPanel Account / Disk Quotas</p>
</div></div></div><div id="tag/Disk-Quotas/operation/get_local_quota_info" data-section-id="tag/Disk-Quotas/operation/get_local_quota_info" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_local_quota_info" id="operation/get_local_quota_info" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Disk-Quotas/operation/get_local_quota_info" aria-label="tag/Disk-Quotas/operation/get_local_quota_info"></a>Return local disk quota information </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves the cPanel account&amp;#39;s quota for the server where you run the function. For example, a &lt;a href=&quot;https://go.cpanel.net/glossaryD&quot;&gt;distributed cPanel account&lt;/a&gt; could approach its quota. The servers will balance that cPanel user&amp;#39;s quota between the parent and the child node.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  This function runs on &lt;strong&gt;only&lt;/strong&gt; the local server. To retrieve the cPanel account&amp;#39;s total quota, use the UAPI &lt;code&gt;Quota::get_quota&lt;/code&gt; function instead.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the cPanel account&#39;s quota for the server where you run the function. For example, a <a href="https://go.cpanel.net/glossaryD">distributed cPanel account</a> could approach its quota. The servers will balance that cPanel user&#39;s quota between the parent and the child node.</p>
<p><strong>Note:</strong></p>
<p>  This function runs on <strong>only</strong> the local server. To retrieve the cPanel account&#39;s total quota, use the UAPI <code>Quota::get_quota</code> function instead.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Quota/get_local_quota_info</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Quota/get_local_quota_info</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kmf3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kmf3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kmf3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kmf3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kmf3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kmf3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kmf3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kmf3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kmf3a:0" aria-labelledby="tab:R4kmf3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Quota <span class="token punctuation">\</span>
  get_local_quota_info
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kmf3a:1" aria-labelledby="tab:R4kmf3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kmf3a:2" aria-labelledby="tab:R4kmf3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kmf3a:3" aria-labelledby="tab:R4kmf3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4smf3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4smf3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4smf3a:0" aria-labelledby="tab:R4smf3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_local_quota_info&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Quota&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"byte_limit"</span>: <span class="token number">262144000</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"bytes_used"</span>: <span class="token number">4149284</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"inode_limit"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"inodes_used"</span>: <span class="token number">1035</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Disk-Quotas/operation/get_quota_info" data-section-id="tag/Disk-Quotas/operation/get_quota_info" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_quota_info" id="operation/get_quota_info" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Disk-Quotas/operation/get_quota_info" aria-label="tag/Disk-Quotas/operation/get_quota_info"></a>Return disk quota information </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves the cPanel account&amp;#39;s quota.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the cPanel account&#39;s quota.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Quota/get_quota_info</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Quota/get_quota_info</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kqf3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kqf3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kqf3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kqf3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kqf3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kqf3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kqf3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kqf3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kqf3a:0" aria-labelledby="tab:R4kqf3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Quota <span class="token punctuation">\</span>
  get_quota_info
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kqf3a:1" aria-labelledby="tab:R4kqf3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kqf3a:2" aria-labelledby="tab:R4kqf3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kqf3a:3" aria-labelledby="tab:R4kqf3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sqf3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sqf3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sqf3a:0" aria-labelledby="tab:R4sqf3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_quota_info&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Quota&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"inode_limit"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"inodes_remain"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"inodes_used"</span>: <span class="token number">1035</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"megabyte_limit"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"megabytes_remain"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"megabytes_used"</span>: <span class="token number">5.46</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"under_inode_limit"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"under_megabyte_limit"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"under_quota_overall"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Personalization" data-section-id="tag/Personalization" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Personalization" aria-label="tag/Personalization"></a>Personalization</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;The Personalization module for UAPI.&lt;/p&gt;
"><p>The Personalization module for UAPI.</p>
</div></div></div><div id="tag/Personalization/operation/Personalization::get" data-section-id="tag/Personalization/operation/Personalization::get" class="sc-dntaoT ceciOs"><div data-section-id="operation/Personalization::get" id="operation/Personalization::get" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Personalization/operation/Personalization::get" aria-label="tag/Personalization/operation/Personalization::get"></a>Retrieve NVData data from file </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves the data from an NVData file on disk. cPanel
NVData is a per-account configuration storage mechanism that you can use to
maintain persistent cPanel &amp;amp; WHM settings across multiple sessions. This includes
custom settings for your own themes and plugins.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;NVData keys and values are limited to 128 and 2048 bytes, respectively.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the data from an NVData file on disk. cPanel
NVData is a per-account configuration storage mechanism that you can use to
maintain persistent cPanel &amp; WHM settings across multiple sessions. This includes
custom settings for your own themes and plugins.</p>
<p><strong>Note:</strong></p>
<p>NVData keys and values are limited to 128 and 2048 bytes, respectively.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><h5 class="sc-dpBQxM eJAAZj">Request Body schema: <span class="sc-dhCplO khtVmz">application/json</span><div class="sc-CNKsk sc-hGZxvd sc-kLJHhQ hPAOR feFoaC fRACBr">required</div></h5><div html="" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"></div><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="names" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">names</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">strings</span></div> <div><div html="&lt;p&gt;List of NVData keys to query the server about.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>List of NVData keys to query the server about.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="post" class="sc-txhaY dCeVuA http-verb post">post</span><span class="sc-etPtWW iqHzp">/Personalization/get</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Personalization/get</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kmh3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kmh3a:0" tabindex="0" data-rttab="true">Payload</li><li class="react-tabs__tab" role="tab" id="tab:R4kmh3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kmh3a:1" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kmh3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kmh3a:2" data-rttab="true">HTTP Request (Wire Format)</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kmh3a:0" aria-labelledby="tab:R4kmh3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"names"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;coffee&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;milk&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kmh3a:1" aria-labelledby="tab:R4kmh3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kmh3a:2" aria-labelledby="tab:R4kmh3a:2"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4smh3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4smh3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4smh3a:0" aria-labelledby="tab:R4smh3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Personalization&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"coffee"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">&quot;OK&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"success"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;hot&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"milk"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">&quot;OK&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"success"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;cold&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Personalization/operation/Personalization-set" data-section-id="tag/Personalization/operation/Personalization-set" class="sc-dntaoT ceciOs"><div data-section-id="operation/Personalization-set" id="operation/Personalization-set" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Personalization/operation/Personalization-set" aria-label="tag/Personalization/operation/Personalization-set"></a>Save NVData data to file </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function saves its data to an NVData file on disk. cPanel
NVData is a per-account configuration storage mechanism that you can use to
maintain persistent cPanel &amp;amp; WHM settings across multiple sessions. This includes
custom settings for your own themes and plugins.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;NVData keys and values are limited to 128 and 2048 bytes, respectively.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function saves its data to an NVData file on disk. cPanel
NVData is a per-account configuration storage mechanism that you can use to
maintain persistent cPanel &amp; WHM settings across multiple sessions. This includes
custom settings for your own themes and plugins.</p>
<p><strong>Note:</strong></p>
<p>NVData keys and values are limited to 128 and 2048 bytes, respectively.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><h5 class="sc-dpBQxM eJAAZj">Request Body schema: <span class="sc-dhCplO khtVmz">application/json</span><div class="sc-CNKsk sc-hGZxvd sc-kLJHhQ hPAOR feFoaC fRACBr">required</div></h5><div html="" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"></div><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="personalization" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand personalization"><span class="property-name">personalization</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="&lt;p&gt;The NVData keys and values to update.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The NVData keys and values to update.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="post" class="sc-txhaY dCeVuA http-verb post">post</span><span class="sc-etPtWW iqHzp">/Personalization/set</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Personalization/set</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kqh3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kqh3a:0" tabindex="0" data-rttab="true">Payload</li><li class="react-tabs__tab" role="tab" id="tab:R4kqh3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kqh3a:1" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kqh3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kqh3a:2" data-rttab="true">HTTP Request (Wire Format)</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kqh3a:0" aria-labelledby="tab:R4kqh3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"personalization"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"coffee"</span>: <span class="token string">&quot;hot&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"milk"</span>: <span class="token string">&quot;cold&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kqh3a:1" aria-labelledby="tab:R4kqh3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kqh3a:2" aria-labelledby="tab:R4kqh3a:2"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sqh3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sqh3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sqh3a:0" aria-labelledby="tab:R4sqh3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Personalization&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"coffee"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">&quot;OK&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"success"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;hot&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"milk"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">&quot;OK&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"success"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;cold&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Resource-Usage-and-Statistics" data-section-id="tag/Resource-Usage-and-Statistics" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Resource-Usage-and-Statistics" aria-label="tag/Resource-Usage-and-Statistics"></a>Resource Usage and Statistics</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;cPanel Account / Resource Usage and Statistics&lt;/p&gt;
"><p>cPanel Account / Resource Usage and Statistics</p>
</div></div></div><div id="tag/Resource-Usage-and-Statistics/operation/get_usages" data-section-id="tag/Resource-Usage-and-Statistics/operation/get_usages" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_usages" id="operation/get_usages" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Resource-Usage-and-Statistics/operation/get_usages" aria-label="tag/Resource-Usage-and-Statistics/operation/get_usages"></a>Return resource usage and custom statistics </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves resource usage and custom statistics for a cPanel user account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves resource usage and custom statistics for a cPanel user account.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/ResourceUsage/get_usages</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/ResourceUsage/get_usages</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kmj3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kmj3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kmj3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kmj3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kmj3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kmj3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kmj3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kmj3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kmj3a:0" aria-labelledby="tab:R4kmj3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  ResourceUsage <span class="token punctuation">\</span>
  get_usages
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kmj3a:1" aria-labelledby="tab:R4kmj3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kmj3a:2" aria-labelledby="tab:R4kmj3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kmj3a:3" aria-labelledby="tab:R4kmj3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4smj3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4smj3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4smj3a:0" aria-labelledby="tab:R4smj3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_usages&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;ResourceUsage&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">&quot;MySQL® Databases&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"formatter"</span>: <span class="token string">&quot;format_bytes&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;mysql_databases&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maximum"</span>: <span class="token number">15</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">&quot;sql/index.html&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Resource-Usage-and-Statistics/operation/get_stats" data-section-id="tag/Resource-Usage-and-Statistics/operation/get_stats" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_stats" id="operation/get_stats" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Resource-Usage-and-Statistics/operation/get_stats" aria-label="tag/Resource-Usage-and-Statistics/operation/get_stats"></a>Return cPanel account statistics </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves a cPanel account&amp;#39;s statistics.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a cPanel account&#39;s statistics.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="display" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">display</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">display=bandwidthusage|diskusage</span></div><div><div html="&lt;p&gt;A pipe-delimited list of the account&amp;#39;s statistics.&lt;/p&gt;
&lt;details&gt;
  &lt;summary&gt;Click for a list of available display parameters.&lt;/summary&gt;

&lt;ul&gt;
&lt;li&gt;&lt;code&gt;addondomains&lt;/code&gt; — Information about the account&amp;#39;s addon domains.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;apacheversion&lt;/code&gt; — The server&amp;#39;s Apache version.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;autoresponders&lt;/code&gt; — Information about the account&amp;#39;s auto-responders.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;bandwidthusage&lt;/code&gt; — Information about the account&amp;#39;s bandwidth usage.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;cachedlistdiskusage&lt;/code&gt; — The amount of cached mailing list disk space the account currently uses.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;cachedmysqldiskusage&lt;/code&gt; — The amount of cached disk space that the account&amp;#39;s MySQL® databases currently use.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;cachedpostgresdiskusage&lt;/code&gt; — The amount of cached disk space that the account&amp;#39;s PostgreSQL databases use.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;cpanelversion&lt;/code&gt; — The server&amp;#39;s cPanel version.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;dedicatedip&lt;/code&gt; — Account websites that use dedicated IP addresses.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;diskusage&lt;/code&gt; — Information the account&amp;#39;s disk space usage.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;emailaccounts&lt;/code&gt; — Information about the account&amp;#39;s email accounts.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;emailfilters&lt;/code&gt; — Information the account&amp;#39;s email filters.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;emailforwarders&lt;/code&gt; — Information about the account&amp;#39;s forwarders.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;fileusage&lt;/code&gt; — Information about the account&amp;#39;s file usage.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;ftpaccounts&lt;/code&gt; — Information about the account&amp;#39;s FTP accounts.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;hostingpackage&lt;/code&gt; — The account&amp;#39;s hosting package.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;hostname&lt;/code&gt; — The server&amp;#39;s hostname.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;kernelversion&lt;/code&gt; — The operating system&amp;#39;s kernel version.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;localip&lt;/code&gt; — Account websites that use local IP addresses.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;machinetype&lt;/code&gt; — The type of operating system that the server uses.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;mailinglists&lt;/code&gt; — Information the account&amp;#39;s mailing lists.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;mysqldatabases&lt;/code&gt; — The number of MySQL databases the account possesses.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;mysqldiskusage&lt;/code&gt; — The amount of disk space that the account&amp;#39;s MySQL databases use.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;mysqlversion&lt;/code&gt; — The server&amp;#39;s MySQL version.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;operatingsystem&lt;/code&gt; — The server&amp;#39;s operating system.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;parkeddomains&lt;/code&gt; — Information about the account&amp;#39;s parked domains (aliases).&lt;/li&gt;
&lt;li&gt;&lt;code&gt;perlpath&lt;/code&gt; — The Perl binary&amp;#39;s absolute path.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;perlversion&lt;/code&gt; — The server&amp;#39;s Perl version.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;phpversion&lt;/code&gt; — The server&amp;#39;s PHP version.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;postgresqldatabases&lt;/code&gt; — The number of PostgreSQL databases the cPanel account possesses.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;postgresdiskusage&lt;/code&gt; — The amount of disk space that the cPanel account&amp;#39;s PostgreSQL databases use.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;sendmailpath&lt;/code&gt; — The path to the system&amp;#39;s sendmail binary.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;sharedip&lt;/code&gt; — Any of the account&amp;#39;s websites that use a shared IP address.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;shorthostname&lt;/code&gt; — The short version of your server&amp;#39;s hostname.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;sqldatabases&lt;/code&gt; — Information about the all of the account&amp;#39;s SQL databases.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;subdomains&lt;/code&gt; — Information about the account&amp;#39;s subdomains.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;theme&lt;/code&gt; — The account&amp;#39;s current theme.&lt;/details&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;This function may require URI-encode format (&lt;code&gt;%7C&lt;/code&gt;) or quotes (&lt;code&gt;&amp;quot;&lt;/code&gt;) in some
contexts, such as the command line tool.&lt;/li&gt;
&lt;li&gt;Some display parameters may be unavailable based on the server&amp;#39;s configuration.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A pipe-delimited list of the account&#39;s statistics.</p>
<details>
  <summary>Click for a list of available display parameters.</summary>

<ul>
<li><code>addondomains</code> — Information about the account&#39;s addon domains.</li>
<li><code>apacheversion</code> — The server&#39;s Apache version.</li>
<li><code>autoresponders</code> — Information about the account&#39;s auto-responders.</li>
<li><code>bandwidthusage</code> — Information about the account&#39;s bandwidth usage.</li>
<li><code>cachedlistdiskusage</code> — The amount of cached mailing list disk space the account currently uses.</li>
<li><code>cachedmysqldiskusage</code> — The amount of cached disk space that the account&#39;s MySQL® databases currently use.</li>
<li><code>cachedpostgresdiskusage</code> — The amount of cached disk space that the account&#39;s PostgreSQL databases use.</li>
<li><code>cpanelversion</code> — The server&#39;s cPanel version.</li>
<li><code>dedicatedip</code> — Account websites that use dedicated IP addresses.</li>
<li><code>diskusage</code> — Information the account&#39;s disk space usage.</li>
<li><code>emailaccounts</code> — Information about the account&#39;s email accounts.</li>
<li><code>emailfilters</code> — Information the account&#39;s email filters.</li>
<li><code>emailforwarders</code> — Information about the account&#39;s forwarders.</li>
<li><code>fileusage</code> — Information about the account&#39;s file usage.</li>
<li><code>ftpaccounts</code> — Information about the account&#39;s FTP accounts.</li>
<li><code>hostingpackage</code> — The account&#39;s hosting package.</li>
<li><code>hostname</code> — The server&#39;s hostname.</li>
<li><code>kernelversion</code> — The operating system&#39;s kernel version.</li>
<li><code>localip</code> — Account websites that use local IP addresses.</li>
<li><code>machinetype</code> — The type of operating system that the server uses.</li>
<li><code>mailinglists</code> — Information the account&#39;s mailing lists.</li>
<li><code>mysqldatabases</code> — The number of MySQL databases the account possesses.</li>
<li><code>mysqldiskusage</code> — The amount of disk space that the account&#39;s MySQL databases use.</li>
<li><code>mysqlversion</code> — The server&#39;s MySQL version.</li>
<li><code>operatingsystem</code> — The server&#39;s operating system.</li>
<li><code>parkeddomains</code> — Information about the account&#39;s parked domains (aliases).</li>
<li><code>perlpath</code> — The Perl binary&#39;s absolute path.</li>
<li><code>perlversion</code> — The server&#39;s Perl version.</li>
<li><code>phpversion</code> — The server&#39;s PHP version.</li>
<li><code>postgresqldatabases</code> — The number of PostgreSQL databases the cPanel account possesses.</li>
<li><code>postgresdiskusage</code> — The amount of disk space that the cPanel account&#39;s PostgreSQL databases use.</li>
<li><code>sendmailpath</code> — The path to the system&#39;s sendmail binary.</li>
<li><code>sharedip</code> — Any of the account&#39;s websites that use a shared IP address.</li>
<li><code>shorthostname</code> — The short version of your server&#39;s hostname.</li>
<li><code>sqldatabases</code> — Information about the all of the account&#39;s SQL databases.</li>
<li><code>subdomains</code> — Information about the account&#39;s subdomains.</li>
<li><code>theme</code> — The account&#39;s current theme.</details></li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li>This function may require URI-encode format (<code>%7C</code>) or quotes (<code>&quot;</code>) in some
contexts, such as the command line tool.</li>
<li>Some display parameters may be unavailable based on the server&#39;s configuration.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="infinityimg" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">infinityimg</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or null</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">null</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">infinityimg=/home/example/infinity.png</span></div><div><div html="&lt;p&gt;The absolute file path to an alternative infinity symbol image.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The absolute file path to an alternative infinity symbol image.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="infinitylang" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">infinitylang</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or null</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">null</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">infinitylang=infinity</span></div><div><div html="&lt;p&gt;A phrase to represent infinity that the locales system can use.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A phrase to represent infinity that the locales system can use.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="rowcounter" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">rowcounter</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or null</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">null</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">rowcounter=even</span></div><div><div html="&lt;p&gt;The type of row.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;odd&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;even&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The type of row.</p>
<ul>
<li><code>odd</code></li>
<li><code>even</code></li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="warninglevel" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">warninglevel</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer or null</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> [ 1 .. 100 ] </span></span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">null</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">warninglevel=87</span></div><div><div html="&lt;p&gt;The minimum level at which to return warnings.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The minimum level at which to return warnings.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="warnings" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">warnings</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer or null</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">null</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">warnings=0</span></div><div><div html="&lt;p&gt;Whether to return all results with a warning.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Return only warnings that &lt;strong&gt;exceed&lt;/strong&gt; the &lt;code&gt;warninglevel&lt;/code&gt; parameter&amp;#39;s
value.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Return all results.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to return all results with a warning.</p>
<ul>
<li><code>1</code> — Return only warnings that <strong>exceed</strong> the <code>warninglevel</code> parameter&#39;s
value.</li>
<li><code>0</code> — Return all results.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="warnout" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">warnout</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer or null</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">null</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">warnout=0</span></div><div><div html="&lt;p&gt;Whether to display results with a value of &lt;code&gt;100%&lt;/code&gt;.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Display results with a value of &lt;code&gt;100%&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Hide results with a value of &lt;code&gt;100%&lt;/code&gt;.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to display results with a value of <code>100%</code>.</p>
<ul>
<li><code>1</code> — Display results with a value of <code>100%</code>.</li>
<li><code>0</code> — Hide results with a value of <code>100%</code>.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/StatsBar/get_stats</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/StatsBar/get_stats</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kqj3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kqj3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kqj3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kqj3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kqj3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kqj3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kqj3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kqj3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kqj3a:0" aria-labelledby="tab:R4kqj3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  StatsBar <span class="token punctuation">\</span>
  get_stats <span class="token punctuation">\</span>
  <span class="token assign-left variable">display</span><span class="token operator">=</span><span class="token string">'bandwidthusage|diskusage'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kqj3a:1" aria-labelledby="tab:R4kqj3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kqj3a:2" aria-labelledby="tab:R4kqj3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kqj3a:3" aria-labelledby="tab:R4kqj3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sqj3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sqj3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sqj3a:0" aria-labelledby="tab:R4sqj3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_stats&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;StatsBar&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"_count"</span>: <span class="token string">&quot;0.00&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_max"</span>: <span class="token string">&quot;1024.00&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_maxed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"count"</span>: <span class="token string">&quot;0 bytes&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"feature"</span>: <span class="token string">&quot;bandwidth&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;bandwidthusage&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_maxed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"item"</span>: <span class="token string">&quot;Monthly Bandwidth Transfer&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max"</span>: <span class="token string">&quot;1 GB&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maxed_phrase"</span>: <span class="token string">&quot;You have transferred your maximum allotment of data ([format_bytes,_1]) for this month.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Stats&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;bandwidthusage&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"near_limit_phrase"</span>: <span class="token string">&quot;You have transferred [format_bytes,_1] of your [format_bytes,_2] data allotment for this month.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"normalized"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"percent"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"percent10"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"percent20"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"percent5"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phrase"</span>: <span class="token string">&quot;Monthly Bandwidth Transfer&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rowtype"</span>: <span class="token string">&quot;even&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"units"</span>: <span class="token string">&quot;MB&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"zeroisunlimited"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"_count"</span>: <span class="token string">&quot;1.75&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_max"</span>: <span class="token string">&quot;1024.00&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_maxed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"count"</span>: <span class="token string">&quot;1.75 MB&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;diskusage&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_maxed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"item"</span>: <span class="token string">&quot;Disk Space Usage&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"langkey"</span>: <span class="token string">&quot;INDXDiskUsage&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max"</span>: <span class="token string">&quot;1 GB&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"maxed_phrase"</span>: <span class="token string">&quot;You are using your maximum storage allotment, [format_bytes,_1].&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Quota&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;diskusage&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"near_limit_phrase"</span>: <span class="token string">&quot;You are using [format_bytes,_1] of the [format_bytes,_2] of storage available to you.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"normalized"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"percent"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"percent10"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"percent20"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"percent5"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phrase"</span>: <span class="token string">&quot;Disk Space Usage&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rowtype"</span>: <span class="token string">&quot;odd&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"units"</span>: <span class="token string">&quot;MB&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"zeroisunlimited"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Subaccount-Management" data-section-id="tag/Subaccount-Management" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Subaccount-Management" aria-label="tag/Subaccount-Management"></a>Subaccount Management</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;cPanel Account / Subaccount Management&lt;/p&gt;
"><p>cPanel Account / Subaccount Management</p>
</div></div></div><div id="tag/Subaccount-Management/operation/UserManager::create_user" data-section-id="tag/Subaccount-Management/operation/UserManager::create_user" class="sc-dntaoT ceciOs"><div data-section-id="operation/UserManager::create_user" id="operation/UserManager::create_user" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Subaccount-Management/operation/UserManager::create_user" aria-label="tag/Subaccount-Management/operation/UserManager::create_user"></a>Create Subaccount </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function creates a Subaccount.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a Subaccount.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="alternate_email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">alternate_email</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">null</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">alternate_email=user@example.com</span></div><div><div html="&lt;p&gt;An alternate email address for the Subaccount&amp;#39;s user.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; You &lt;strong&gt;must&lt;/strong&gt; use this parameter if you set the &lt;code&gt;send_invite&lt;/code&gt; value to &lt;code&gt;1&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An alternate email address for the Subaccount&#39;s user.</p>
<p><strong>Note:</strong></p>
<p> You <strong>must</strong> use this parameter if you set the <code>send_invite</code> value to <code>1</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="avatar_url" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">avatar_url</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;url&gt; </span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">null</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">avatar_url=https://img.example.com/avatars/example.jpg</span></div><div><div html="&lt;p&gt;The URL path to the user&amp;#39;s Subaccount profile photo.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You &lt;strong&gt;must&lt;/strong&gt; use the HTTPS protocol to prevent mixed content warnings when users view the image from another HTTPS URL.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;We reserved this parameter for future use. Do &lt;strong&gt;not&lt;/strong&gt; use this parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The URL path to the user&#39;s Subaccount profile photo.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> use the HTTPS protocol to prevent mixed content warnings when users view the image from another HTTPS URL.</p>
<p><strong>Warning:</strong></p>
<p>We reserved this parameter for future use. Do <strong>not</strong> use this parameter.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The Subaccount user&amp;#39;s associated domain that the cPanel account owns.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount user&#39;s associated domain that the cPanel account owns.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="password" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">password</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;password&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">password=123456luggage</span></div><div><div html="&lt;p&gt;The Subaccount&amp;#39;s password.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; Email, FTP, and Web Disk services use this password.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount&#39;s password.</p>
<p><strong>Note:</strong></p>
<p> Email, FTP, and Web Disk services use this password.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="phone_number" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">phone_number</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">null</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">phone_number=+15551234567</span></div><div><div html="&lt;p&gt;A phone number for the Subaccount user that conforms to
&lt;a href=&quot;https://en.wikipedia.org/wiki/ITU-T&quot;&gt;ITU-T&lt;/a&gt;&amp;#39;s &lt;a href=&quot;https://en.wikipedia.org/wiki/E.164&quot;&gt;E.164&lt;/a&gt;
standards.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;We reserved this parameter for future use. Do &lt;strong&gt;not&lt;/strong&gt; use this parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A phone number for the Subaccount user that conforms to
<a href="https://en.wikipedia.org/wiki/ITU-T">ITU-T</a>&#39;s <a href="https://en.wikipedia.org/wiki/E.164">E.164</a>
standards.</p>
<p><strong>Warning:</strong></p>
<p>We reserved this parameter for future use. Do <strong>not</strong> use this parameter.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="real_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">real_name</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">null</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">real_name=John Doe</span></div><div><div html="&lt;p&gt;The Subaccount user&amp;#39;s first and/or last name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount user&#39;s first and/or last name.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="send_invite" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">send_invite</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">send_invite=0</span></div><div><div html="&lt;p&gt;Whether to send a reset password email to the Subaccount&amp;#39;s alternate email address.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Send.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Do not send.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to send a reset password email to the Subaccount&#39;s alternate email address.</p>
<ul>
<li><code>1</code> - Send.</li>
<li><code>0</code> - Do not send.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.email.enabled" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.email.enabled</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.email.enabled=1</span></div><div><div html="&lt;p&gt;Whether to grant the Subaccount email access.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Can access.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - &lt;strong&gt;Cannot&lt;/strong&gt; access.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to grant the Subaccount email access.</p>
<ul>
<li><code>1</code> - Can access.</li>
<li><code>0</code> - <strong>Cannot</strong> access.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.email.quota" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.email.quota</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.email.quota=500</span></div><div><div html="&lt;p&gt;The maximum amount of disk space, in megabytes (MB), allocated to Subaccount&amp;#39;s email account.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; or &lt;code&gt;unlimited&lt;/code&gt; - The subaccount has unlimited disk space.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;This value defaults to the defined system value.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This value &lt;strong&gt;cannot&lt;/strong&gt; be larger than the system&amp;#39;s maximum email quota.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum amount of disk space, in megabytes (MB), allocated to Subaccount&#39;s email account.</p>
<ul>
<li><code>0</code> or <code>unlimited</code> - The subaccount has unlimited disk space.</li>
</ul>
<p>This value defaults to the defined system value.</p>
<p><strong>Note:</strong></p>
<p>This value <strong>cannot</strong> be larger than the system&#39;s maximum email quota.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.email.send_welcome_email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.email.send_welcome_email</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.email.send_welcome_email=1</span></div><div><div html="&lt;p&gt;Whether to send client configuration instructions to the account.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Send the instructions.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Do &lt;strong&gt;not&lt;/strong&gt; send the instructions.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to send client configuration instructions to the account.</p>
<ul>
<li><code>1</code> - Send the instructions.</li>
<li><code>0</code> - Do <strong>not</strong> send the instructions.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.ftp.enabled" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.ftp.enabled</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.ftp.enabled=1</span></div><div><div html="&lt;p&gt;Whether to grant the Subaccount FTP access.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Can access.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - &lt;strong&gt;Cannot&lt;/strong&gt; access.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to grant the Subaccount FTP access.</p>
<ul>
<li><code>1</code> - Can access.</li>
<li><code>0</code> - <strong>Cannot</strong> access.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.ftp.homedir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.ftp.homedir</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.ftp.homedir=/Subaccount</span></div><div><div html="&lt;p&gt;The Subaccount&amp;#39;s FTP home directory, relative to the cPanel account&amp;#39;s home directory.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;This parameter is &lt;strong&gt;required&lt;/strong&gt; if you enabled the &lt;code&gt;services.ftp.homedir&lt;/code&gt; parameter.&lt;/li&gt;
&lt;li&gt;The directory &lt;strong&gt;must&lt;/strong&gt; exist.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount&#39;s FTP home directory, relative to the cPanel account&#39;s home directory.</p>
<p><strong>Note:</strong></p>
<ul>
<li>This parameter is <strong>required</strong> if you enabled the <code>services.ftp.homedir</code> parameter.</li>
<li>The directory <strong>must</strong> exist.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.webdisk.enabled" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.webdisk.enabled</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.webdisk.enabled=1</span></div><div><div html="&lt;p&gt;Whether to grant the Subaccount Web Disk access.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; _ Can access.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - &lt;strong&gt;Cannot&lt;/strong&gt; access.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to grant the Subaccount Web Disk access.</p>
<ul>
<li><code>1</code> _ Can access.</li>
<li><code>0</code> - <strong>Cannot</strong> access.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.webdisk.enabledigest" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.webdisk.enabledigest</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.webdisk.enabledigest=0</span></div><div><div html="&lt;p&gt;Whether to enable the Web Disk Digest Authentication.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Enabled.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Disabled.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;strong&gt;Only&lt;/strong&gt; enable Digest Authentication for clients that require additional compatibility support on
certain versions of Windows® operating systems. This compatibility support is &lt;strong&gt;only&lt;/strong&gt; required on servers
that use a self-signed certificate for the &lt;code&gt;cpsrvd&lt;/code&gt; and &lt;code&gt;cpdavd&lt;/code&gt; daemons.&lt;/li&gt;
&lt;li&gt;We recommend that you do &lt;strong&gt;not&lt;/strong&gt; use Digest Authentication.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to enable the Web Disk Digest Authentication.</p>
<ul>
<li><code>1</code> - Enabled.</li>
<li><code>0</code> - Disabled.</li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li><strong>Only</strong> enable Digest Authentication for clients that require additional compatibility support on
certain versions of Windows® operating systems. This compatibility support is <strong>only</strong> required on servers
that use a self-signed certificate for the <code>cpsrvd</code> and <code>cpdavd</code> daemons.</li>
<li>We recommend that you do <strong>not</strong> use Digest Authentication.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.webdisk.homedir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.webdisk.homedir</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.webdisk.homedir=/Subaccount</span></div><div><div html="&lt;p&gt;The Subaccount&amp;#39;s Web Disk home directory, relative to the cPanel account&amp;#39;s home directory.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This parameter is &lt;strong&gt;required&lt;/strong&gt; if you enable the &lt;code&gt;services.webdisk.enabled&lt;/code&gt; parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount&#39;s Web Disk home directory, relative to the cPanel account&#39;s home directory.</p>
<p><strong>Note:</strong></p>
<p>This parameter is <strong>required</strong> if you enable the <code>services.webdisk.enabled</code> parameter.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.webdisk.perms" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.webdisk.perms</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;rw&quot;</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.webdisk.perms=rw</span></div><div><div html="&lt;p&gt;The Subaccount&amp;#39;s file permissions for its Web Disk home directory.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;ro&lt;/code&gt; - Read-only permissions.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;rw&lt;/code&gt; - Read and write permissions.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; The &lt;code&gt;services.webdisk.homedir&lt;/code&gt; parameter determines the Subaccount&amp;#39;s Web Disk home directory.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount&#39;s file permissions for its Web Disk home directory.</p>
<ul>
<li><code>ro</code> - Read-only permissions.</li>
<li><code>rw</code> - Read and write permissions.</li>
</ul>
<p><strong>Note:</strong></p>
<p> The <code>services.webdisk.homedir</code> parameter determines the Subaccount&#39;s Web Disk home directory.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.webdisk.private" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.webdisk.private</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.webdisk.private=1</span></div><div><div html="&lt;p&gt;Whether to set the directory&amp;#39;s permissions to public or private.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Private (&lt;code&gt;0700&lt;/code&gt;).&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Public (&lt;code&gt;0755&lt;/code&gt;).&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to set the directory&#39;s permissions to public or private.</p>
<ul>
<li><code>1</code> - Private (<code>0700</code>).</li>
<li><code>0</code> - Public (<code>0755</code>).</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="type" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">type</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;sub&quot;</span></div><div><span class="sc-CNKsk hPAOR"> Value:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;sub&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">type=sub</span></div><div><div html="&lt;p&gt;The type of account.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;sub&lt;/code&gt; - A Subaccount.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The type of account.</p>
<ul>
<li><code>sub</code> - A Subaccount.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="username" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">username</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;username&gt; </span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &lt;= 64 characters </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">username=example</span></div><div><div html="&lt;p&gt;The username for the Subaccount. The username can only contain alphanumeric characters, dots (&lt;code&gt;.&lt;/code&gt;), hyphens (&lt;code&gt;-&lt;/code&gt;), and underscores (&lt;code&gt;_&lt;/code&gt;).&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This value does &lt;strong&gt;not&lt;/strong&gt; include the domain name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username for the Subaccount. The username can only contain alphanumeric characters, dots (<code>.</code>), hyphens (<code>-</code>), and underscores (<code>_</code>).</p>
<p><strong>Note:</strong></p>
<p>This value does <strong>not</strong> include the domain name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/UserManager/create_user</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/UserManager/create_user</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rii6l3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rii6l3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rii6l3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii6l3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rii6l3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii6l3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rii6l3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii6l3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rii6l3a:0" aria-labelledby="tab:Rii6l3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  UserManager <span class="token punctuation">\</span>
  create_user <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">password</span><span class="token operator">=</span><span class="token string">'123456luggage'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">username</span><span class="token operator">=</span><span class="token string">'example'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii6l3a:1" aria-labelledby="tab:Rii6l3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii6l3a:2" aria-labelledby="tab:Rii6l3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii6l3a:3" aria-labelledby="tab:Rii6l3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rji6l3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rji6l3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rji6l3a:0" aria-labelledby="tab:Rji6l3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;create_user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;UserManager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"alternate_email"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">&quot;</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_delete"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_password"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_quota"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dismissed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">&quot;N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_siblings"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issues"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"area"</span>: <span class="token string">&quot;quota&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"limit"</span>: <span class="token number">1500</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">&quot;Your account is over quota.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">&quot;email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;info&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"used"</span>: <span class="token number">2000</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parent_type"</span>: <span class="token string">&quot;hypothetical&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">&quot;+15551234567&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">&quot;John Doe&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"services"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token number">1500</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ftp"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/subaccount&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token string">&quot;0.00&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"webdisk"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/bob&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">&quot;rw&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"private"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"special"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sub_account_exists"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"synced_password"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">&quot;example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dismissed_merge_candidates"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"alternate_email"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">&quot;</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_delete"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_password"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_quota"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dismissed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">&quot;N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_siblings"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issues"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"area"</span>: <span class="token string">&quot;quota&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"limit"</span>: <span class="token number">1500</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">&quot;Your account is over quota.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">&quot;email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;info&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"used"</span>: <span class="token number">2000</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parent_type"</span>: <span class="token string">&quot;hypothetical&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">&quot;+15551234567&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">&quot;John Doe&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"services"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token number">1500</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ftp"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/subaccount&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token string">&quot;0.00&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"webdisk"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/bob&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">&quot;rw&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"private"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"special"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sub_account_exists"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"synced_password"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">&quot;example&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_expired_invite"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_invite"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"invite_expiration"</span>: <span class="token number">1591718154</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"merge_candidates"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"alternate_email"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">&quot;</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_delete"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_password"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_quota"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dismissed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">&quot;N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_siblings"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issues"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"area"</span>: <span class="token string">&quot;quota&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"limit"</span>: <span class="token number">1500</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">&quot;Your account is over quota.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">&quot;email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;info&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"used"</span>: <span class="token number">2000</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parent_type"</span>: <span class="token string">&quot;hypothetical&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">&quot;+15551234567&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">&quot;John Doe&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"services"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token number">1500</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ftp"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/subaccount&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token string">&quot;0.00&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"webdisk"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/bob&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">&quot;rw&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"private"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"special"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sub_account_exists"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"synced_password"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">&quot;example&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Subaccount-Management/operation/UserManager::delete_user" data-section-id="tag/Subaccount-Management/operation/UserManager::delete_user" class="sc-dntaoT ceciOs"><div data-section-id="operation/UserManager::delete_user" id="operation/UserManager::delete_user" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Subaccount-Management/operation/UserManager::delete_user" aria-label="tag/Subaccount-Management/operation/UserManager::delete_user"></a>Delete Subaccount </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function deletes a Subaccount. This function returns only metadata if no other service accounts exist with the same username and domain.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;If one service account uses the same username and domain, the function returns the service account&amp;#39;s information.&lt;/li&gt;
&lt;li&gt;If two or more service accounts use the same username and domain, the function returns a hypothetical Subaccount.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;A hypothetical Subaccount consists of two or more service accounts that use the same username and domain.&lt;/li&gt;
&lt;li&gt;This function returns only metadata if the specified username and domain do &lt;strong&gt;not&lt;/strong&gt; match any service accounts or hypothetical Subaccounts.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes a Subaccount. This function returns only metadata if no other service accounts exist with the same username and domain.</p>
<ul>
<li>If one service account uses the same username and domain, the function returns the service account&#39;s information.</li>
<li>If two or more service accounts use the same username and domain, the function returns a hypothetical Subaccount.</li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li>A hypothetical Subaccount consists of two or more service accounts that use the same username and domain.</li>
<li>This function returns only metadata if the specified username and domain do <strong>not</strong> match any service accounts or hypothetical Subaccounts.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The Subaccount&amp;#39;s associated domain.  The domain &lt;strong&gt;must&lt;/strong&gt; be one that the cPanel account owns.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount&#39;s associated domain.  The domain <strong>must</strong> be one that the cPanel account owns.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="username" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">username</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &lt;= 64 characters </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">username=example</span></div><div><div html="&lt;p&gt;The Subaccount&amp;#39;s username.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;Characters — &lt;code&gt;a-z&lt;/code&gt;, &lt;code&gt;A-Z&lt;/code&gt;, &lt;code&gt;0-9&lt;/code&gt;, dot (&lt;code&gt;.&lt;/code&gt;), hyphen (&lt;code&gt;-&lt;/code&gt;), underscore (&lt;code&gt;_&lt;/code&gt;)&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This value does &lt;strong&gt;not&lt;/strong&gt; include the domain name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount&#39;s username.</p>
<ul>
<li>Characters — <code>a-z</code>, <code>A-Z</code>, <code>0-9</code>, dot (<code>.</code>), hyphen (<code>-</code>), underscore (<code>_</code>)</li>
</ul>
<p><strong>Note:</strong></p>
<p>This value does <strong>not</strong> include the domain name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/UserManager/delete_user</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/UserManager/delete_user</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riial3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riial3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riial3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riial3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riial3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riial3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riial3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riial3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riial3a:0" aria-labelledby="tab:Riial3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  UserManager <span class="token punctuation">\</span>
  delete_user <span class="token punctuation">\</span>
  <span class="token assign-left variable">username</span><span class="token operator">=</span><span class="token string">'example'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riial3a:1" aria-labelledby="tab:Riial3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riial3a:2" aria-labelledby="tab:Riial3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riial3a:3" aria-labelledby="tab:Riial3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjial3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjial3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjial3a:0" aria-labelledby="tab:Rjial3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;delete_user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;UserManager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"alternate_email"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">&quot;</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_delete"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_password"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_quota"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dismissed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dismissed_merge_candidates"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">&quot;N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_expired_invite"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_invite"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_siblings"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"invite_expiration"</span>: <span class="token number">1466258282</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issues"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"area"</span>: <span class="token string">&quot;quota&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"limit"</span>: <span class="token number">1500</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">&quot;Your account is over quota.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">&quot;email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;info&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"used"</span>: <span class="token number">2000</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"merge_candidates"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"alternate_email"</span>: <span class="token string">&quot;string&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">&quot;string&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_delete"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_password"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_quota"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dismissed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dismissed_merge_candidates"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;string&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;string&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">&quot;string&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">&quot;string&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_expired_invite"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_invite"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_siblings"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"invite_expiration"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issues"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;string&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"merge_candidates"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;string&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parent_type"</span>: <span class="token string">&quot;string&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">&quot;string&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">&quot;string&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"services"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"special"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sub_account_exists"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"synced_password"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;string&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">&quot;string&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parent_type"</span>: <span class="token string">&quot;hypothetical&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">&quot;+15551234567&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">&quot;John Doe&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"services"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token number">100</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ftp"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/account&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token number">100</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"webdisk"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/bob&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">&quot;rw&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"private"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"special"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sub_account_exists"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"synced_password"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;service&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">&quot;string&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Subaccount-Management/operation/check_account_conflicts" data-section-id="tag/Subaccount-Management/operation/check_account_conflicts" class="sc-dntaoT ceciOs"><div data-section-id="operation/check_account_conflicts" id="operation/check_account_conflicts" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Subaccount-Management/operation/check_account_conflicts" aria-label="tag/Subaccount-Management/operation/check_account_conflicts"></a>Return Subaccounts and service accounts conflicts </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the other Subaccounts or services accounts that conflict
with the specified username.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If the function returns more than one account, it will return some values
multiple times within the return arrays.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the other Subaccounts or services accounts that conflict
with the specified username.</p>
<p><strong>Note:</strong></p>
<p>If the function returns more than one account, it will return some values
multiple times within the return arrays.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="full_username" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">full_username</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">full_username=username@example.com</span></div><div><div html="&lt;p&gt;The Subaccount&amp;#39;s username and domain name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount&#39;s username and domain name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/UserManager/check_account_conflicts</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/UserManager/check_account_conflicts</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiel3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiel3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiel3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiel3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riiel3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiel3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riiel3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiel3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiel3a:0" aria-labelledby="tab:Riiel3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  UserManager <span class="token punctuation">\</span>
  check_account_conflicts <span class="token punctuation">\</span>
  <span class="token assign-left variable">full_username</span><span class="token operator">=</span><span class="token string">'username@example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiel3a:1" aria-labelledby="tab:Riiel3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiel3a:2" aria-labelledby="tab:Riiel3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiel3a:3" aria-labelledby="tab:Riiel3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjiel3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiel3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiel3a:0" aria-labelledby="tab:Rjiel3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;check_account_conflicts&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;UserManager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"accounts"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"alternate_email"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">&quot;</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_delete"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_password"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_quota"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dismissed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dismissed_merge_candidates"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">&quot;username@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">&quot;N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_expired_invite"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_invite"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_siblings"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"invite_expiration"</span>: <span class="token number">1600162200</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issues"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"area"</span>: <span class="token string">&quot;info&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"limit"</span>: <span class="token number">1500</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">&quot;Your account is over quota.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">&quot;email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;info&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"used"</span>: <span class="token number">2000</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"merge_candidates"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"parent_type"</span>: <span class="token string">&quot;sub&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">&quot;+15551234567&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">&quot;John Doe&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"services"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token number">100</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ftp"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/Subaccount&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token number">100</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"webdisk"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/username&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">&quot;rw&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"private"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"special"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sub_account_exists"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"synced_password"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">&quot;username&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"conflict"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Subaccount-Management/operation/dismiss_merge" data-section-id="tag/Subaccount-Management/operation/dismiss_merge" class="sc-dntaoT ceciOs"><div data-section-id="operation/dismiss_merge" id="operation/dismiss_merge" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Subaccount-Management/operation/dismiss_merge" aria-label="tag/Subaccount-Management/operation/dismiss_merge"></a>Remove service account link request </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function removes a service account as a link candidate to create a subaccount or
link to a subaccount. When you use this function, the system removes the &lt;em&gt;Link&lt;/em&gt; option in
cPanel&amp;#39;s &lt;a href=&quot;https://go.cpanel.net/cpaneldocsUserManager&quot;&gt;&lt;em&gt;User Manager&lt;/em&gt;&lt;/a&gt; interface (&lt;em&gt;cPanel &amp;gt;&amp;gt; Home &amp;gt;&amp;gt; Preferences &amp;gt;&amp;gt; User Manager&lt;/em&gt;).&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You &lt;strong&gt;must&lt;/strong&gt; use at least one of the following parameters:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;services.email.dismiss&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;services.ftp.dismiss&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;services.webdisk.dismiss&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes a service account as a link candidate to create a subaccount or
link to a subaccount. When you use this function, the system removes the <em>Link</em> option in
cPanel&#39;s <a href="https://go.cpanel.net/cpaneldocsUserManager"><em>User Manager</em></a> interface (<em>cPanel &gt;&gt; Home &gt;&gt; Preferences &gt;&gt; User Manager</em>).</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> use at least one of the following parameters:</p>
<ul>
<li><code>services.email.dismiss</code></li>
<li><code>services.ftp.dismiss</code></li>
<li><code>services.webdisk.dismiss</code></li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The service account&amp;#39;s associated domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The service account&#39;s associated domain.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.email.dismiss" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.email.dismiss</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.email.dismiss=1</span></div><div><div html="&lt;p&gt;Whether to dismiss the merge of the email service account.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Dismiss.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Do &lt;strong&gt;not&lt;/strong&gt; dismiss.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to dismiss the merge of the email service account.</p>
<ul>
<li><code>1</code> - Dismiss.</li>
<li><code>0</code> - Do <strong>not</strong> dismiss.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.ftp.dismiss" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.ftp.dismiss</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.ftp.dismiss=1</span></div><div><div html="&lt;p&gt;Whether to dismiss the merge of the FTP service account.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Dismiss.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Do &lt;strong&gt;not&lt;/strong&gt; dismiss.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to dismiss the merge of the FTP service account.</p>
<ul>
<li><code>1</code> - Dismiss.</li>
<li><code>0</code> - Do <strong>not</strong> dismiss.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.webdisk.dismiss" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.webdisk.dismiss</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.webdisk.dismiss=1</span></div><div><div html="&lt;p&gt;Whether to dismiss the merge of the Web Disk service account.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Dismiss.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Do &lt;strong&gt;not&lt;/strong&gt; dismiss.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to dismiss the merge of the Web Disk service account.</p>
<ul>
<li><code>1</code> - Dismiss.</li>
<li><code>0</code> - Do <strong>not</strong> dismiss.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="username" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">username</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;username&gt; </span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &lt;= 64 characters </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">username=example1</span></div><div><div html="&lt;p&gt;The username for the service account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This parameter does &lt;strong&gt;not&lt;/strong&gt; include the domain name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username for the service account.</p>
<p><strong>Note:</strong></p>
<p>This parameter does <strong>not</strong> include the domain name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/UserManager/dismiss_merge</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/UserManager/dismiss_merge</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiil3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiil3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiil3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiil3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riiil3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiil3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riiil3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiil3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiil3a:0" aria-labelledby="tab:Riiil3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  UserManager <span class="token punctuation">\</span>
  dismiss_merge <span class="token punctuation">\</span>
  <span class="token assign-left variable">username</span><span class="token operator">=</span><span class="token string">'example1'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiil3a:1" aria-labelledby="tab:Riiil3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiil3a:2" aria-labelledby="tab:Riiil3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiil3a:3" aria-labelledby="tab:Riiil3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjiil3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiil3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiil3a:0" aria-labelledby="tab:Rjiil3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;dismiss_merge&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;UserManager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Subaccount-Management/operation/lookup_service_account" data-section-id="tag/Subaccount-Management/operation/lookup_service_account" class="sc-dntaoT ceciOs"><div data-section-id="operation/lookup_service_account" id="operation/lookup_service_account" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Subaccount-Management/operation/lookup_service_account" aria-label="tag/Subaccount-Management/operation/lookup_service_account"></a>Return service account&#x27;s information </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists a service account&amp;#39;s information.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists a service account&#39;s information.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="full_username" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">full_username</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">full_username=username@example.com</span></div><div><div html="&lt;p&gt;The full username for the system account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The full username for the system account.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="type" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">type</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;email&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;ftp&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;webdisk&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">type=email</span></div><div><div html="&lt;p&gt;The type of system account.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;email&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;ftp&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;webdisk&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The type of system account.</p>
<ul>
<li><code>email</code></li>
<li><code>ftp</code></li>
<li><code>webdisk</code></li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/UserManager/lookup_service_account</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/UserManager/lookup_service_account</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiml3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiml3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiml3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiml3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riiml3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiml3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riiml3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiml3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiml3a:0" aria-labelledby="tab:Riiml3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  UserManager <span class="token punctuation">\</span>
  lookup_service_account <span class="token punctuation">\</span>
  <span class="token assign-left variable">type</span><span class="token operator">=</span><span class="token string">'email'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">full_username</span><span class="token operator">=</span><span class="token string">'username@example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiml3a:1" aria-labelledby="tab:Riiml3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiml3a:2" aria-labelledby="tab:Riiml3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiml3a:3" aria-labelledby="tab:Riiml3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjiml3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiml3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiml3a:0" aria-labelledby="tab:Rjiml3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;lookup_service_account&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;UserManager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dismissed_merge_candidates"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"merge_candidates"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"alternate_email"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">&quot;</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_delete"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_password"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_quota"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dismissed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">&quot;N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_expired_invite"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_invite"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_siblings"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"invite_expiration"</span>: <span class="token number">1591718154</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issues"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"area"</span>: <span class="token string">&quot;quota&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"limit"</span>: <span class="token number">1500</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">&quot;Your account is over quota.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">&quot;email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;info&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"used"</span>: <span class="token number">2000</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parent_type"</span>: <span class="token string">&quot;hypothetical&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">&quot;+15551234567&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">&quot;John Doe&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"services"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token number">100</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ftp"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/subaccount&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token number">100</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"webdisk"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/bob&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">&quot;rw&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"private"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"special"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sub_account_exists"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"synced_password"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">&quot;example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"merge_candidates"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"alternate_email"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">&quot;</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_delete"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_password"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_quota"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dismissed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">&quot;N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_expired_invite"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_invite"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_siblings"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"invite_expiration"</span>: <span class="token number">1591718154</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issues"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"area"</span>: <span class="token string">&quot;quota&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"limit"</span>: <span class="token number">1500</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">&quot;Your account is over quota.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">&quot;email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;info&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"used"</span>: <span class="token number">2000</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parent_type"</span>: <span class="token string">&quot;hypothetical&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">&quot;+15551234567&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">&quot;John Doe&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"services"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token number">100</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ftp"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/subaccount&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token number">100</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"webdisk"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/bob&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">&quot;rw&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"private"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"special"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sub_account_exists"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"synced_password"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">&quot;example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"merge_candidates"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"alternate_email"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">&quot;</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_delete"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_password"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_quota"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dismissed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">&quot;N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_expired_invite"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_invite"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_siblings"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"invite_expiration"</span>: <span class="token number">1591718154</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issues"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"area"</span>: <span class="token string">&quot;quota&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"limit"</span>: <span class="token number">1500</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">&quot;Your account is over quota.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">&quot;email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;info&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"used"</span>: <span class="token number">2000</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parent_type"</span>: <span class="token string">&quot;hypothetical&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">&quot;+15551234567&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">&quot;John Doe&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"services"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token number">100</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ftp"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/subaccount&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token number">100</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"webdisk"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/bob&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">&quot;rw&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"private"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"special"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sub_account_exists"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"synced_password"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">&quot;example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"merge_candidates"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Subaccount-Management/operation/edit_user" data-section-id="tag/Subaccount-Management/operation/edit_user" class="sc-dntaoT ceciOs"><div data-section-id="operation/edit_user" id="operation/edit_user" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Subaccount-Management/operation/edit_user" aria-label="tag/Subaccount-Management/operation/edit_user"></a>Update Subaccount settings </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function edits a Subaccount.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function edits a Subaccount.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="alternate_email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">alternate_email</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or null</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">null</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">alternate_email=user@example.com</span></div><div><div html="&lt;p&gt;An alternate email address for the Subaccount&amp;#39;s user.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; The cPanel account user could use this email address to contact the Subaccount user if their primary email address&amp;#39;s domain is unavailable.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An alternate email address for the Subaccount&#39;s user.</p>
<p><strong>Note:</strong></p>
<p> The cPanel account user could use this email address to contact the Subaccount user if their primary email address&#39;s domain is unavailable.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="avatar_url" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">avatar_url</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or null</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;url&gt; </span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">null</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">avatar_url=https://img.example.com/avatars/example.jpg</span></div><div><div html="&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; We reserved this parameter for future use. Do &lt;strong&gt;not&lt;/strong&gt; use this parameter.&lt;/p&gt;
&lt;p&gt;The user&amp;#39;s Subaccount profile photo.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; You &lt;strong&gt;must&lt;/strong&gt; use the HTTPS protocol to prevent mixed content warnings when users view the photo from another HTTPS URL.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p><strong>Warning:</strong></p>
<p> We reserved this parameter for future use. Do <strong>not</strong> use this parameter.</p>
<p>The user&#39;s Subaccount profile photo.</p>
<p><strong>Note:</strong></p>
<p> You <strong>must</strong> use the HTTPS protocol to prevent mixed content warnings when users view the photo from another HTTPS URL.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The Subaccount user&amp;#39;s associated domain.&lt;/p&gt;
&lt;p&gt;A domain that the cPanel account owns.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount user&#39;s associated domain.</p>
<p>A domain that the cPanel account owns.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="password" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">password</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">password=12345luggage</span></div><div><div html="&lt;p&gt;The Subaccount&amp;#39;s new password.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; The Subaccount uses this password for email, FTP, and Web Disk services.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount&#39;s new password.</p>
<p><strong>Note:</strong></p>
<p> The Subaccount uses this password for email, FTP, and Web Disk services.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="phone_number" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">phone_number</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or null</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">null</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">phone_number=+15551234567</span></div><div><div html="&lt;p&gt;The Subaccount user&amp;#39;s phone number.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; We reserved this parameter for future use. Do &lt;strong&gt;not&lt;/strong&gt; use this parameter.&lt;/p&gt;
&lt;p&gt;The number conforms to the &lt;a href=&quot;https://en.wikipedia.org/wiki/ITU-T&quot;&gt;ITU-T&lt;/a&gt;&amp;#39;s &lt;a href=&quot;https://en.wikipedia.org/wiki/E.164&quot;&gt;E.164&lt;/a&gt;-recommended standard for the representation of telephone numbers.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount user&#39;s phone number.</p>
<p><strong>Warning:</strong></p>
<p> We reserved this parameter for future use. Do <strong>not</strong> use this parameter.</p>
<p>The number conforms to the <a href="https://en.wikipedia.org/wiki/ITU-T">ITU-T</a>&#39;s <a href="https://en.wikipedia.org/wiki/E.164">E.164</a>-recommended standard for the representation of telephone numbers.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="real_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">real_name</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or null</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">null</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">real_name=John Doe</span></div><div><div html="&lt;p&gt;The Subaccount user&amp;#39;s name.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;A first name.&lt;/li&gt;
&lt;li&gt;A last name.&lt;/li&gt;
&lt;li&gt;A first name and last name.&lt;/li&gt;
&lt;li&gt;An empty string.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount user&#39;s name.</p>
<ul>
<li>A first name.</li>
<li>A last name.</li>
<li>A first name and last name.</li>
<li>An empty string.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.email.enabled" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.email.enabled</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.email.enabled=1</span></div><div><div html="&lt;p&gt;Whether to grant the Subaccount email access.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Can access.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - &lt;strong&gt;Cannot&lt;/strong&gt; access.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to grant the Subaccount email access.</p>
<ul>
<li><code>1</code> - Can access.</li>
<li><code>0</code> - <strong>Cannot</strong> access.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.email.quota" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.email.quota</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.email.quota=500</span></div><div><div html="&lt;p&gt;The maximum amount of disk space, in megabytes (MB), that the subaccount&amp;#39;s email account may use.&lt;/p&gt;
&lt;p&gt;If you do not declare a value, the system defaults to the defined system value.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; This value &lt;strong&gt;cannot&lt;/strong&gt; be greater than the maximum email quota.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; or &lt;code&gt;unlimited&lt;/code&gt; - The subaccount possesses unlimited disk space.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum amount of disk space, in megabytes (MB), that the subaccount&#39;s email account may use.</p>
<p>If you do not declare a value, the system defaults to the defined system value.</p>
<p><strong>Note:</strong></p>
<p> This value <strong>cannot</strong> be greater than the maximum email quota.</p>
<ul>
<li><code>0</code> or <code>unlimited</code> - The subaccount possesses unlimited disk space.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.ftp.enabled" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.ftp.enabled</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.ftp.enabled=1</span></div><div><div html="&lt;p&gt;Whether to grant the Subaccount FTP access.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Can access.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - &lt;strong&gt;Cannot&lt;/strong&gt; access.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to grant the Subaccount FTP access.</p>
<ul>
<li><code>1</code> - Can access.</li>
<li><code>0</code> - <strong>Cannot</strong> access.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.ftp.homedir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.ftp.homedir</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.ftp.homedir=/Subaccount</span></div><div><div html="&lt;p&gt;The Subaccount&amp;#39;s FTP home directory.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; This parameter is &lt;strong&gt;required&lt;/strong&gt; if you enable FTP access.&lt;/p&gt;
&lt;p&gt;A relative path from the cPanel account&amp;#39;s home directory.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; The specified directory &lt;strong&gt;must&lt;/strong&gt; exist.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount&#39;s FTP home directory.</p>
<p><strong>Note:</strong></p>
<p> This parameter is <strong>required</strong> if you enable FTP access.</p>
<p>A relative path from the cPanel account&#39;s home directory.</p>
<p><strong>Note:</strong></p>
<p> The specified directory <strong>must</strong> exist.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.webdisk.enabled" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.webdisk.enabled</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.webdisk.enabled=1</span></div><div><div html="&lt;p&gt;Whether to grant the Subaccount Web Disk access.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Can access.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - &lt;strong&gt;Cannot&lt;/strong&gt; access.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to grant the Subaccount Web Disk access.</p>
<ul>
<li><code>1</code> - Can access.</li>
<li><code>0</code> - <strong>Cannot</strong> access.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.webdisk.enabledigest" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.webdisk.enabledigest</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.webdisk.enabledigest=0</span></div><div><div html="&lt;p&gt;Whether to enable Web Disk digest authentication.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Notes:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;p&gt;&lt;strong&gt;Only&lt;/strong&gt; enable Digest Authentication for clients that require additional compatibility support on certain versions of Windows® operating systems. This compatibility support is &lt;strong&gt;only&lt;/strong&gt; required on servers that use a self-signed certificate for the &lt;code&gt;cpsrvd&lt;/code&gt; and &lt;code&gt;cpdavd&lt;/code&gt; daemons.&lt;/p&gt;
&lt;/li&gt;
&lt;li&gt;&lt;p&gt;We recommend that you do &lt;strong&gt;not&lt;/strong&gt; use Digest Authentication.&lt;/p&gt;
&lt;/li&gt;
&lt;li&gt;&lt;p&gt;&lt;code&gt;1&lt;/code&gt; - Enabled&lt;/p&gt;
&lt;/li&gt;
&lt;li&gt;&lt;p&gt;&lt;code&gt;0&lt;/code&gt; - Disabled.&lt;/p&gt;
&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to enable Web Disk digest authentication.</p>
<p><strong>Notes:</strong></p>
<ul>
<li><p><strong>Only</strong> enable Digest Authentication for clients that require additional compatibility support on certain versions of Windows® operating systems. This compatibility support is <strong>only</strong> required on servers that use a self-signed certificate for the <code>cpsrvd</code> and <code>cpdavd</code> daemons.</p>
</li>
<li><p>We recommend that you do <strong>not</strong> use Digest Authentication.</p>
</li>
<li><p><code>1</code> - Enabled</p>
</li>
<li><p><code>0</code> - Disabled.</p>
</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.webdisk.homedir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.webdisk.homedir</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.webdisk.homedir=/Subaccount</span></div><div><div html="&lt;p&gt;The Subaccount&amp;#39;s Web Disk home directory.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; This parameter is &lt;strong&gt;required&lt;/strong&gt; if you enable Web Disk access.&lt;/p&gt;
&lt;p&gt;A relative path from the cPanel account&amp;#39;s home directory.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount&#39;s Web Disk home directory.</p>
<p><strong>Note:</strong></p>
<p> This parameter is <strong>required</strong> if you enable Web Disk access.</p>
<p>A relative path from the cPanel account&#39;s home directory.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.webdisk.perms" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.webdisk.perms</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;rw&quot;</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;ro&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;rw&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.webdisk.perms=rw</span></div><div><div html="&lt;p&gt;Whether to grant write permissions to the Subaccount.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; The &lt;code&gt;services.webdisk.homedir&lt;/code&gt; parameter determines the Subaccount&amp;#39;s Web Disk home directory.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;ro&lt;/code&gt; - Read-only permissions.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;rw&lt;/code&gt; - Read and write permissions.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to grant write permissions to the Subaccount.</p>
<p><strong>Note:</strong></p>
<p> The <code>services.webdisk.homedir</code> parameter determines the Subaccount&#39;s Web Disk home directory.</p>
<ul>
<li><code>ro</code> - Read-only permissions.</li>
<li><code>rw</code> - Read and write permissions.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.webdisk.private" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.webdisk.private</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.webdisk.private=1</span></div><div><div html="&lt;p&gt;Whether to set the Web Disk directory&amp;#39;s permissions to public or private.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Private (&lt;code&gt;0700&lt;/code&gt;).&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Public (&lt;code&gt;0755&lt;/code&gt;).&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to set the Web Disk directory&#39;s permissions to public or private.</p>
<ul>
<li><code>1</code> - Private (<code>0700</code>).</li>
<li><code>0</code> - Public (<code>0755</code>).</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="type" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">type</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;sub&quot;</span></div><div><span class="sc-CNKsk hPAOR"> Value:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;sub&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">type=sub</span></div><div><div html="&lt;p&gt;The type of account.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;sub&lt;/code&gt; - A Subaccount.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The type of account.</p>
<ul>
<li><code>sub</code> - A Subaccount.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="username" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">username</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">username=example</span></div><div><div html="&lt;p&gt;The Subaccount&amp;#39;s username.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;Length - 64 characters.&lt;/li&gt;
&lt;li&gt;Characters - &lt;code&gt;a-z&lt;/code&gt;, &lt;code&gt;A-Z&lt;/code&gt;, &lt;code&gt;0-9&lt;/code&gt;, dot (&lt;code&gt;.&lt;/code&gt;), hyphen (&lt;code&gt;-&lt;/code&gt;), underscore (&lt;code&gt;_&lt;/code&gt;).&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; This value does &lt;strong&gt;not&lt;/strong&gt; include the domain name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount&#39;s username.</p>
<ul>
<li>Length - 64 characters.</li>
<li>Characters - <code>a-z</code>, <code>A-Z</code>, <code>0-9</code>, dot (<code>.</code>), hyphen (<code>-</code>), underscore (<code>_</code>).</li>
</ul>
<p><strong>Note:</strong></p>
<p> This value does <strong>not</strong> include the domain name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/UserManager/edit_user</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/UserManager/edit_user</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiql3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiql3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiql3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiql3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riiql3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiql3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riiql3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiql3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiql3a:0" aria-labelledby="tab:Riiql3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  UserManager <span class="token punctuation">\</span>
  edit_user <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">password</span><span class="token operator">=</span><span class="token string">'12345luggage'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">username</span><span class="token operator">=</span><span class="token string">'example'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiql3a:1" aria-labelledby="tab:Riiql3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiql3a:2" aria-labelledby="tab:Riiql3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiql3a:3" aria-labelledby="tab:Riiql3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjiql3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiql3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiql3a:0" aria-labelledby="tab:Rjiql3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;edit_user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;UserManager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dismissed_merge_candidates"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"merge_candidates"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"alternate_email"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">&quot;</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_delete"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_password"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_quota"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dismissed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">&quot;N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_expired_invite"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_invite"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_siblings"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"invite_expiration"</span>: <span class="token number">1591718154</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issues"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"area"</span>: <span class="token string">&quot;quota&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"limit"</span>: <span class="token number">1500</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">&quot;Your account is over quota.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">&quot;email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;info&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"used"</span>: <span class="token number">2000</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parent_type"</span>: <span class="token string">&quot;hypothetical&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">&quot;+15551234567&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">&quot;John Doe&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"services"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token number">100</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ftp"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/subaccount&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token number">100</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"webdisk"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/bob&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">&quot;rw&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"private"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"special"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sub_account_exists"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"synced_password"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">&quot;example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"merge_candidates"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"alternate_email"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">&quot;</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_delete"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_password"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_quota"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dismissed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">&quot;N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_expired_invite"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_invite"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_siblings"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"invite_expiration"</span>: <span class="token number">1591718154</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issues"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"area"</span>: <span class="token string">&quot;quota&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"limit"</span>: <span class="token number">1500</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">&quot;Your account is over quota.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">&quot;email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;info&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"used"</span>: <span class="token number">2000</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parent_type"</span>: <span class="token string">&quot;hypothetical&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">&quot;+15551234567&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">&quot;John Doe&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"services"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token number">100</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ftp"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/subaccount&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token number">100</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"webdisk"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/bob&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">&quot;rw&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"private"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"special"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sub_account_exists"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"synced_password"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">&quot;example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"merge_candidates"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"alternate_email"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">&quot;</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_delete"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_password"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_quota"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dismissed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">&quot;N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_expired_invite"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_invite"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_siblings"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"invite_expiration"</span>: <span class="token number">1591718154</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issues"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"area"</span>: <span class="token string">&quot;quota&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"limit"</span>: <span class="token number">1500</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">&quot;Your account is over quota.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">&quot;email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;info&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"used"</span>: <span class="token number">2000</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parent_type"</span>: <span class="token string">&quot;hypothetical&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">&quot;+15551234567&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">&quot;John Doe&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"services"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token number">100</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ftp"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/subaccount&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token number">100</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"webdisk"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/bob&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">&quot;rw&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"private"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"special"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sub_account_exists"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"synced_password"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">&quot;example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"merge_candidates"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Subaccount-Management/operation/lookup_user" data-section-id="tag/Subaccount-Management/operation/lookup_user" class="sc-dntaoT ceciOs"><div data-section-id="operation/lookup_user" id="operation/lookup_user" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Subaccount-Management/operation/lookup_user" aria-label="tag/Subaccount-Management/operation/lookup_user"></a>Return Subaccount&#x27;s information </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists a single Subaccount&amp;#39;s information.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists a single Subaccount&#39;s information.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="guid" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">guid</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">guid=EXAMPLE1:EXAMPLE.COM:564CD663%3AFE50072F2620B50988EA4E5F46022546FBE6BDDE3C36C2F2534F4967C661EC37</span></div><div><div html="&lt;p&gt;The Subaccount&amp;#39;s unique identifier.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Subaccount&#39;s unique identifier.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/UserManager/lookup_user</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/UserManager/lookup_user</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiul3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiul3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiul3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiul3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riiul3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiul3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riiul3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiul3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiul3a:0" aria-labelledby="tab:Riiul3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  UserManager <span class="token punctuation">\</span>
  lookup_user <span class="token punctuation">\</span>
  <span class="token assign-left variable">guid</span><span class="token operator">=</span><span class="token string">'EXAMPLE1:EXAMPLE.COM:564CD663%3AFE50072F2620B50988EA4E5F46022546FBE6BDDE3C36C2F2534F4967C661EC37'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiul3a:1" aria-labelledby="tab:Riiul3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiul3a:2" aria-labelledby="tab:Riiul3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiul3a:3" aria-labelledby="tab:Riiul3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjiul3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiul3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiul3a:0" aria-labelledby="tab:Rjiul3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;lookup_user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;UserManager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"alternate_email"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">&quot;</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_delete"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_password"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_quota"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dismissed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">&quot;N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_siblings"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issues"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"area"</span>: <span class="token string">&quot;quota&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"limit"</span>: <span class="token number">1500</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">&quot;Your account is over quota.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">&quot;email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;info&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"used"</span>: <span class="token number">2000</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"merge_candidates"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parent_type"</span>: <span class="token string">&quot;hypothetical&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">&quot;+15551234567&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">&quot;John Doe&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"services"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token number">100</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ftp"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/subaccount&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token number">100</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"special"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"webdisk"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabledigest"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/bob&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">&quot;rw&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"private"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"special"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sub_account_exists"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"synced_password"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">&quot;example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dismissed_merge_candidates"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"alternate_email"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">&quot;</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_delete"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_password"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_quota"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dismissed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">&quot;N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_siblings"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issues"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"area"</span>: <span class="token string">&quot;quota&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"limit"</span>: <span class="token number">1500</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">&quot;Your account is over quota.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">&quot;email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;info&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"used"</span>: <span class="token number">2000</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"merge_candidates"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parent_type"</span>: <span class="token string">&quot;hypothetical&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">&quot;+15551234567&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">&quot;John Doe&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"services"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token number">100</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ftp"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/subaccount&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token number">100</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"special"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"webdisk"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabledigest"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/bob&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">&quot;rw&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"private"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"special"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sub_account_exists"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"synced_password"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">&quot;example&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_expired_invite"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_invite"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"invite_expiration"</span>: <span class="token number">1591718154</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Subaccount-Management/operation/unlink_service_account" data-section-id="tag/Subaccount-Management/operation/unlink_service_account" class="sc-dntaoT ceciOs"><div data-section-id="operation/unlink_service_account" id="operation/unlink_service_account" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Subaccount-Management/operation/unlink_service_account" aria-label="tag/Subaccount-Management/operation/unlink_service_account"></a>Unregister service account from Subaccount </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function unlinks a service account from a subaccount.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function unlinks a service account from a subaccount.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="dismiss" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">dismiss</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">dismiss=0</span></div><div><div html="&lt;p&gt;Whether to dismiss the service account as a merge candidate.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Dismiss as merge candidate.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Display as merge candidate.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; If any email, FTP, or Web Disk accounts use the same username, cPanel&amp;#39;s &lt;a href=&quot;https://go.cpanel.net/cpaneldocsUserManager&quot;&gt;&lt;em&gt;User Manager&lt;/em&gt;&lt;/a&gt; interface (&lt;em&gt;cPanel &amp;gt;&amp;gt; Home &amp;gt;&amp;gt; Preferences &amp;gt;&amp;gt; User Manager&lt;/em&gt;) allows you to merge those accounts into a subaccount.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to dismiss the service account as a merge candidate.</p>
<ul>
<li><code>1</code> - Dismiss as merge candidate.</li>
<li><code>0</code> - Display as merge candidate.</li>
</ul>
<p><strong>Note:</strong></p>
<p> If any email, FTP, or Web Disk accounts use the same username, cPanel&#39;s <a href="https://go.cpanel.net/cpaneldocsUserManager"><em>User Manager</em></a> interface (<em>cPanel &gt;&gt; Home &gt;&gt; Preferences &gt;&gt; User Manager</em>) allows you to merge those accounts into a subaccount.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The subaccount&amp;#39;s associated domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The subaccount&#39;s associated domain.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="service" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">service</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;email&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;ftp&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;webdisk&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">service=ftp</span></div><div><div html="&lt;p&gt;The service to unlink.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;email&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;ftp&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;webdisk&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The service to unlink.</p>
<ul>
<li><code>email</code></li>
<li><code>ftp</code></li>
<li><code>webdisk</code></li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="username" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">username</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;username&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">username=example</span></div><div><div html="&lt;p&gt;The subaccount&amp;#39;s username.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This value does &lt;strong&gt;not&lt;/strong&gt; include the domain name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The subaccount&#39;s username.</p>
<p><strong>Note:</strong></p>
<p>This value does <strong>not</strong> include the domain name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/UserManager/unlink_service_account</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/UserManager/unlink_service_account</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rij2l3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rij2l3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rij2l3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij2l3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rij2l3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij2l3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rij2l3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij2l3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rij2l3a:0" aria-labelledby="tab:Rij2l3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  UserManager <span class="token punctuation">\</span>
  unlink_service_account <span class="token punctuation">\</span>
  <span class="token assign-left variable">username</span><span class="token operator">=</span><span class="token string">'example'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">service</span><span class="token operator">=</span><span class="token string">'ftp'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij2l3a:1" aria-labelledby="tab:Rij2l3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij2l3a:2" aria-labelledby="tab:Rij2l3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij2l3a:3" aria-labelledby="tab:Rij2l3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjj2l3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj2l3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj2l3a:0" aria-labelledby="tab:Rjj2l3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;unlink_service_account&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;UserManager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Subaccount-Management/operation/merge_service_account" data-section-id="tag/Subaccount-Management/operation/merge_service_account" class="sc-dntaoT ceciOs"><div data-section-id="operation/merge_service_account" id="operation/merge_service_account" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Subaccount-Management/operation/merge_service_account" aria-label="tag/Subaccount-Management/operation/merge_service_account"></a>Register service account to Subaccount </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function links service accounts to subaccounts and creates a subaccount if one does not exist.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You can only link email, FTP, or Web Disk accounts.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You must use at least &lt;strong&gt;one&lt;/strong&gt; of the following parameters:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;services.email.merge&lt;/li&gt;
&lt;li&gt;services.ftp.merge&lt;/li&gt;
&lt;li&gt;services.webdisk.merge&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;To link multiple service accounts, the service accounts &lt;strong&gt;must&lt;/strong&gt; share the same username and domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function links service accounts to subaccounts and creates a subaccount if one does not exist.</p>
<p><strong>Note:</strong></p>
<p>You can only link email, FTP, or Web Disk accounts.</p>
<p><strong>Important</strong></p>
<p>You must use at least <strong>one</strong> of the following parameters:</p>
<ul>
<li>services.email.merge</li>
<li>services.ftp.merge</li>
<li>services.webdisk.merge</li>
</ul>
<p>To link multiple service accounts, the service accounts <strong>must</strong> share the same username and domain.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The service account&amp;#39;s associated domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The service account&#39;s associated domain.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.email.merge" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.email.merge</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.email.merge=1</span></div><div><div html="&lt;p&gt;Whether to link the email account to the subaccount.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Merge.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Do &lt;strong&gt;not&lt;/strong&gt; merge.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to link the email account to the subaccount.</p>
<ul>
<li><code>1</code> - Merge.</li>
<li><code>0</code> - Do <strong>not</strong> merge.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.ftp.merge" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.ftp.merge</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.ftp.merge=1</span></div><div><div html="&lt;p&gt;Whether to link the FTP account to the subaccount.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Merge.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Do &lt;strong&gt;not&lt;/strong&gt; merge.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to link the FTP account to the subaccount.</p>
<ul>
<li><code>1</code> - Merge.</li>
<li><code>0</code> - Do <strong>not</strong> merge.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.webdisk.merge" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.webdisk.merge</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.webdisk.merge=1</span></div><div><div html="&lt;p&gt;Whether to link the Web Disk account to the subaccount.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Merge.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Do &lt;strong&gt;not&lt;/strong&gt; merge.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to link the Web Disk account to the subaccount.</p>
<ul>
<li><code>1</code> - Merge.</li>
<li><code>0</code> - Do <strong>not</strong> merge.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="username" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">username</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;username&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">username=example</span></div><div><div html="&lt;p&gt;The username for the service account that meets the account name limitations.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;Length - 64 characters&lt;/li&gt;
&lt;li&gt;Characters — &lt;code&gt;a-z&lt;/code&gt;, &lt;code&gt;A-Z&lt;/code&gt;, &lt;code&gt;0-9&lt;/code&gt;, dot (&lt;code&gt;.&lt;/code&gt;), hyphen (&lt;code&gt;-&lt;/code&gt;), underscore (&lt;code&gt;_&lt;/code&gt;).&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This value does &lt;strong&gt;not&lt;/strong&gt; include the domain name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username for the service account that meets the account name limitations.</p>
<ul>
<li>Length - 64 characters</li>
<li>Characters — <code>a-z</code>, <code>A-Z</code>, <code>0-9</code>, dot (<code>.</code>), hyphen (<code>-</code>), underscore (<code>_</code>).</li>
</ul>
<p><strong>Note:</strong></p>
<p>This value does <strong>not</strong> include the domain name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/UserManager/merge_service_account</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/UserManager/merge_service_account</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rij6l3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rij6l3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rij6l3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij6l3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rij6l3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij6l3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rij6l3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij6l3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rij6l3a:0" aria-labelledby="tab:Rij6l3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  UserManager <span class="token punctuation">\</span>
  merge_service_account <span class="token punctuation">\</span>
  <span class="token assign-left variable">username</span><span class="token operator">=</span><span class="token string">'example'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij6l3a:1" aria-labelledby="tab:Rij6l3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij6l3a:2" aria-labelledby="tab:Rij6l3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij6l3a:3" aria-labelledby="tab:Rij6l3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjj6l3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj6l3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj6l3a:0" aria-labelledby="tab:Rjj6l3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;merge_service_account&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;UserManager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"alternate_email"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">&quot;</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_delete"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_password"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_quota"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dismissed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dismissed_merge_candidates"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"alternate_email"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">&quot;</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_delete"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_password"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_quota"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">&quot;N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_siblings"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issues"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"area"</span>: <span class="token string">&quot;quota&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"limit"</span>: <span class="token number">1500</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">&quot;Your account is over quota.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">&quot;email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;info&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"used"</span>: <span class="token number">2000</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parent_type"</span>: <span class="token string">&quot;hypothetical&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">&quot;+15551234567&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">&quot;John Doe&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"services"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token number">100</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ftp"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/subaccount&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token number">100</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"webdisk"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/bob&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">&quot;rw&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"private"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"special"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sub_account_exists"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"synced_password"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">&quot;example&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">&quot;N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_expired_invite"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_invite"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_siblings"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"invite_expiration"</span>: <span class="token number">1591718154</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issues"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"area"</span>: <span class="token string">&quot;quota&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"limit"</span>: <span class="token number">1500</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">&quot;Your account is over quota.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">&quot;email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;info&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"used"</span>: <span class="token number">2000</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"merge_candidates"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"alternate_email"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">&quot;</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_delete"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_password"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_quota"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">&quot;N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_siblings"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issues"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"area"</span>: <span class="token string">&quot;quota&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"limit"</span>: <span class="token number">1500</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">&quot;Your account is over quota.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">&quot;email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;info&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"used"</span>: <span class="token number">2000</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parent_type"</span>: <span class="token string">&quot;hypothetical&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">&quot;+15551234567&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">&quot;John Doe&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"services"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token number">100</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ftp"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/subaccount&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token number">100</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"webdisk"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/bob&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">&quot;rw&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"private"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"special"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sub_account_exists"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"synced_password"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">&quot;example&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parent_type"</span>: <span class="token string">&quot;hypothetical&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">&quot;+15551234567&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">&quot;John Doe&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"services"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token number">100</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ftp"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/subaccount&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token number">100</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"webdisk"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/bob&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">&quot;rw&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"private"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"special"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sub_account_exists"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"synced_password"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">&quot;example&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Subaccount-Management/operation/UserManager-list_users" data-section-id="tag/Subaccount-Management/operation/UserManager-list_users" class="sc-dntaoT ceciOs"><div data-section-id="operation/UserManager-list_users" id="operation/UserManager-list_users" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Subaccount-Management/operation/UserManager-list_users" aria-label="tag/Subaccount-Management/operation/UserManager-list_users"></a>Return cPanel account&#x27;s Subaccounts </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the cPanel account&amp;#39;s Subaccounts.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the cPanel account&#39;s Subaccounts.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="flat" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">flat</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">flat=0</span></div><div><div html="&lt;p&gt;Whether to return Subaccounts with the same name under the merge_candidates array.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Do &lt;strong&gt;not&lt;/strong&gt; return.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Return.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to return Subaccounts with the same name under the merge_candidates array.</p>
<ul>
<li><code>1</code> - Do <strong>not</strong> return.</li>
<li><code>0</code> - Return.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/UserManager/list_users</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/UserManager/list_users</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rijal3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rijal3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rijal3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijal3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rijal3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijal3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rijal3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijal3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rijal3a:0" aria-labelledby="tab:Rijal3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  UserManager <span class="token punctuation">\</span>
  list_users
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijal3a:1" aria-labelledby="tab:Rijal3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijal3a:2" aria-labelledby="tab:Rijal3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijal3a:3" aria-labelledby="tab:Rijal3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjjal3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjjal3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjjal3a:0" aria-labelledby="tab:Rjjal3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_users&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;UserManager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"alternate_email"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"avatar_url"</span>: <span class="token string">&quot;</span><a href="https://img.example.com/avatars/example.jpg">https://img.example.com/avatars/example.jpg</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_delete"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_password"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_set_quota"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dismissed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dismissed_merge_candidates"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_username"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">&quot;N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_expired_invite"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_invite"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_siblings"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"invite_expiration"</span>: <span class="token number">1591718154</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issues"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"area"</span>: <span class="token string">&quot;quota&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"limit"</span>: <span class="token number">1500</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">&quot;Your account is over quota.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">&quot;email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;info&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"used"</span>: <span class="token number">2000</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"merge_candidates"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parent_type"</span>: <span class="token string">&quot;hypothetical&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone_number"</span>: <span class="token string">&quot;+15551234567&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"real_name"</span>: <span class="token string">&quot;John Doe&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"services"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token number">100</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ftp"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/subaccount&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token number">100</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"special"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"webdisk"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/bob&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perms"</span>: <span class="token string">&quot;rw&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"private"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"special"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sub_account_exists"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"synced_password"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">&quot;example&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Team-Roles" data-section-id="tag/Team-Roles" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Team-Roles" aria-label="tag/Team-Roles"></a>Team Roles</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;The Team Roles module for UAPI.&lt;/p&gt;
"><p>The Team Roles module for UAPI.</p>
</div></div></div><div id="tag/Team-Roles/operation/list_feature_descriptions" data-section-id="tag/Team-Roles/operation/list_feature_descriptions" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_feature_descriptions" id="operation/list_feature_descriptions" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Team-Roles/operation/list_feature_descriptions" aria-label="tag/Team-Roles/operation/list_feature_descriptions"></a>List all role feature descriptions </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function gives a list of all team roles and their included features.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function gives a list of all team roles and their included features.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/TeamRoles/list_feature_descriptions</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/TeamRoles/list_feature_descriptions</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aen3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aen3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aen3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aen3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2aen3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aen3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2aen3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aen3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aen3a:0" aria-labelledby="tab:R2aen3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  TeamRoles <span class="token punctuation">\</span>
  list_feature_descriptions
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aen3a:1" aria-labelledby="tab:R2aen3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aen3a:2" aria-labelledby="tab:R2aen3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aen3a:3" aria-labelledby="tab:R2aen3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2een3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2een3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2een3a:0" aria-labelledby="tab:R2een3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_feature_descriptions&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;TeamRoles&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"features"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;Backup&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;MySQL® Databases&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;PHP&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;database&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"title"</span>: <span class="token string">&quot;Database&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Team-Users" data-section-id="tag/Team-Users" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Team-Users" aria-label="tag/Team-Users"></a>Team Users</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;The Team User module for UAPI.&lt;/p&gt;
"><p>The Team User module for UAPI.</p>
</div></div></div><div id="tag/Team-Users/operation/cancel_expire" data-section-id="tag/Team-Users/operation/cancel_expire" class="sc-dntaoT ceciOs"><div data-section-id="operation/cancel_expire" id="operation/cancel_expire" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Team-Users/operation/cancel_expire" aria-label="tag/Team-Users/operation/cancel_expire"></a>Stop a team user from expiring </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function stops a team user from expiring.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function stops a team user from expiring.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=teamUser</span></div><div><div html="&lt;p&gt;The username of the team user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username of the team user.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Team/cancel_expire</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Team/cancel_expire</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R1546p3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R1546p3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R1546p3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R1546p3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R1546p3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R1546p3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R1546p3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R1546p3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R1546p3a:0" aria-labelledby="tab:R1546p3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Team <span class="token punctuation">\</span>
  cancel_expire <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'teamUser'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1546p3a:1" aria-labelledby="tab:R1546p3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1546p3a:2" aria-labelledby="tab:R1546p3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1546p3a:3" aria-labelledby="tab:R1546p3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R1746p3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R1746p3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R1746p3a:0" aria-labelledby="tab:R1746p3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;expire_team_user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Team&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Team-Users/operation/reinstate_team_user" data-section-id="tag/Team-Users/operation/reinstate_team_user" class="sc-dntaoT ceciOs"><div data-section-id="operation/reinstate_team_user" id="operation/reinstate_team_user" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Team-Users/operation/reinstate_team_user" aria-label="tag/Team-Users/operation/reinstate_team_user"></a>Reinstate a team user </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function reinstates a team user by removing any suspended or expired statuses. The reason field is also cleared.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function reinstates a team user by removing any suspended or expired statuses. The reason field is also cleared.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=teamUser</span></div><div><div html="&lt;p&gt;The username of the team user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username of the team user.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Team/reinstate_team_user</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Team/reinstate_team_user</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R154ap3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R154ap3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R154ap3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R154ap3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R154ap3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R154ap3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R154ap3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R154ap3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R154ap3a:0" aria-labelledby="tab:R154ap3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Team <span class="token punctuation">\</span>
  reinstate_team_user <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'teamUser'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154ap3a:1" aria-labelledby="tab:R154ap3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154ap3a:2" aria-labelledby="tab:R154ap3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154ap3a:3" aria-labelledby="tab:R154ap3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R174ap3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R174ap3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R174ap3a:0" aria-labelledby="tab:R174ap3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;reinstate_team_user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Team&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Team-Users/operation/set_expire" data-section-id="tag/Team-Users/operation/set_expire" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_expire" id="operation/set_expire" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Team-Users/operation/set_expire" aria-label="tag/Team-Users/operation/set_expire"></a>Set a team user to expire </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function expires a team user after a specified amount of time.&lt;/p&gt;
&lt;p&gt;If the team user already has an expire date set, it&amp;#39;s replaced with a new date and reason.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function expires a team user after a specified amount of time.</p>
<p>If the team user already has an expire date set, it&#39;s replaced with a new date and reason.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="date" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand date"><span class="property-name">date</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer or string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">date=120days</span> - </li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">date=1649948169</span> - </li></ul><div><div html="&lt;p&gt;The epoch time on which the team user account expires, or the offset from the current time, in days. Integers are treated as Unix Epoch Time unless followed by &amp;#39;days&amp;#39;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The epoch time on which the team user account expires, or the offset from the current time, in days. Integers are treated as Unix Epoch Time unless followed by &#39;days&#39;.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="reason" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">reason</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">reason=teamUser gave a two week notice.</span></div><div><div html="&lt;p&gt;The reason for expiration.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The reason for expiration.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=teamUser</span></div><div><div html="&lt;p&gt;The username of the team user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username of the team user.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Team/set_expire</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Team/set_expire</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R154ep3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R154ep3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R154ep3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R154ep3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R154ep3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R154ep3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R154ep3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R154ep3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R154ep3a:0" aria-labelledby="tab:R154ep3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Team <span class="token punctuation">\</span>
  set_expire <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'teamUser'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">date</span><span class="token operator">=</span><span class="token string">'120days'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154ep3a:1" aria-labelledby="tab:R154ep3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154ep3a:2" aria-labelledby="tab:R154ep3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154ep3a:3" aria-labelledby="tab:R154ep3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R174ep3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R174ep3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R174ep3a:0" aria-labelledby="tab:R174ep3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_expire&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Team&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">1674575562</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Team-Users/operation/add_roles" data-section-id="tag/Team-Users/operation/add_roles" class="sc-dntaoT ceciOs"><div data-section-id="operation/add_roles" id="operation/add_roles" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Team-Users/operation/add_roles" aria-label="tag/Team-Users/operation/add_roles"></a>Add roles to a team user </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function adds roles to a team user.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  This action may result in team users gaining access to team owner level privileges.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function adds roles to a team user.</p>
<p><strong>Note:</strong></p>
<p>  This action may result in team users gaining access to team owner level privileges.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="role" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">role</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">role=database</span></div><div><div html="&lt;p&gt;The role or roles to add to the team user. Current roles include admin, database, email, web.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The role or roles to add to the team user. Current roles include admin, database, email, web.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=teamuser</span></div><div><div html="&lt;p&gt;The username of the team user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username of the team user.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Team/add_roles</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Team/add_roles</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R154ip3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R154ip3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R154ip3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R154ip3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R154ip3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R154ip3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R154ip3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R154ip3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R154ip3a:0" aria-labelledby="tab:R154ip3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Team <span class="token punctuation">\</span>
  add_roles <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'teamuser'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">role</span><span class="token operator">=</span><span class="token string">'database'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154ip3a:1" aria-labelledby="tab:R154ip3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154ip3a:2" aria-labelledby="tab:R154ip3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154ip3a:3" aria-labelledby="tab:R154ip3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R174ip3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R174ip3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R174ip3a:0" aria-labelledby="tab:R174ip3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;add_roles&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Team&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Team-Users/operation/password_reset_request" data-section-id="tag/Team-Users/operation/password_reset_request" class="sc-dntaoT ceciOs"><div data-section-id="operation/password_reset_request" id="operation/password_reset_request" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Team-Users/operation/password_reset_request" aria-label="tag/Team-Users/operation/password_reset_request"></a>Sends a password reset request link to team user. </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function enables a team user to reset the password by sending a password reset request link.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables a team user to reset the password by sending a password reset request link.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=teamuser</span></div><div><div html="&lt;p&gt;The username of the team user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username of the team user.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Team/password_reset_request</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Team/password_reset_request</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R154mp3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R154mp3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R154mp3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R154mp3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R154mp3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R154mp3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R154mp3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R154mp3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R154mp3a:0" aria-labelledby="tab:R154mp3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Team <span class="token punctuation">\</span>
  password_reset_request <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'teamuser'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154mp3a:1" aria-labelledby="tab:R154mp3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154mp3a:2" aria-labelledby="tab:R154mp3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154mp3a:3" aria-labelledby="tab:R154mp3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R174mp3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R174mp3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R174mp3a:0" aria-labelledby="tab:R174mp3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;password_reset_request&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Team&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Team-Users/operation/set_team_user_contact_email" data-section-id="tag/Team-Users/operation/set_team_user_contact_email" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_team_user_contact_email" id="operation/set_team_user_contact_email" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Team-Users/operation/set_team_user_contact_email" aria-label="tag/Team-Users/operation/set_team_user_contact_email"></a>Set a contact email address for a team user </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function sets or changes primary and secondary email addresses.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets or changes primary and secondary email addresses.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="email1" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email1</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email1=email1@example.com</span></div><div><div html="&lt;p&gt;The primary contact email address to set for the team user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The primary contact email address to set for the team user.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="email2" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email2</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email2=email2@example.com</span></div><div><div html="&lt;p&gt;The secondary contact email address to set for the team user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The secondary contact email address to set for the team user.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=teamUser</span></div><div><div html="&lt;p&gt;The username of the team user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username of the team user.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Team/set_contact_email</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Team/set_contact_email</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R154qp3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R154qp3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R154qp3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R154qp3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R154qp3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R154qp3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R154qp3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R154qp3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R154qp3a:0" aria-labelledby="tab:R154qp3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Team <span class="token punctuation">\</span>
  set_contact_email <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'teamUser'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154qp3a:1" aria-labelledby="tab:R154qp3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154qp3a:2" aria-labelledby="tab:R154qp3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154qp3a:3" aria-labelledby="tab:R154qp3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R174qp3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R174qp3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R174qp3a:0" aria-labelledby="tab:R174qp3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_contact_email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Team&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Team-Users/operation/set_team_user_password" data-section-id="tag/Team-Users/operation/set_team_user_password" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_team_user_password" id="operation/set_team_user_password" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Team-Users/operation/set_team_user_password" aria-label="tag/Team-Users/operation/set_team_user_password"></a>Set password for a team user </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function replaces the current password with a new one.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function replaces the current password with a new one.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="password" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">password</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">password=securepassword</span></div><div><div html="&lt;p&gt;The password to set for the team user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The password to set for the team user.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=teamuser</span></div><div><div html="&lt;p&gt;The username of the team user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username of the team user.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Team/set_password</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Team/set_password</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R154up3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R154up3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R154up3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R154up3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R154up3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R154up3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R154up3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R154up3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R154up3a:0" aria-labelledby="tab:R154up3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Team <span class="token punctuation">\</span>
  set_password <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'teamuser'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">password</span><span class="token operator">=</span><span class="token string">'securepassword'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154up3a:1" aria-labelledby="tab:R154up3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154up3a:2" aria-labelledby="tab:R154up3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154up3a:3" aria-labelledby="tab:R154up3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R174up3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R174up3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R174up3a:0" aria-labelledby="tab:R174up3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_password&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Team&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Team-Users/operation/remove_roles" data-section-id="tag/Team-Users/operation/remove_roles" class="sc-dntaoT ceciOs"><div data-section-id="operation/remove_roles" id="operation/remove_roles" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Team-Users/operation/remove_roles" aria-label="tag/Team-Users/operation/remove_roles"></a>Remove roles from a team user </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function removes roles from a team user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes roles from a team user.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="role" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">role</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">role=database</span></div><div><div html="&lt;p&gt;The role or roles to remove from the team user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The role or roles to remove from the team user.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=teamuser</span></div><div><div html="&lt;p&gt;The username of the team user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username of the team user.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Team/remove_roles</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Team/remove_roles</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R1552p3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R1552p3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R1552p3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R1552p3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R1552p3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R1552p3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R1552p3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R1552p3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R1552p3a:0" aria-labelledby="tab:R1552p3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Team <span class="token punctuation">\</span>
  remove_roles <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'teamuser'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">role</span><span class="token operator">=</span><span class="token string">'database'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1552p3a:1" aria-labelledby="tab:R1552p3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1552p3a:2" aria-labelledby="tab:R1552p3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1552p3a:3" aria-labelledby="tab:R1552p3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R1752p3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R1752p3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R1752p3a:0" aria-labelledby="tab:R1752p3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;remove_roles&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Team&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Team-Users/operation/add_team_user" data-section-id="tag/Team-Users/operation/add_team_user" class="sc-dntaoT ceciOs"><div data-section-id="operation/add_team_user" id="operation/add_team_user" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Team-Users/operation/add_team_user" aria-label="tag/Team-Users/operation/add_team_user"></a>Add a team user </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function creates and adds a new team user.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  This action may result in team users gaining access to team owner level privileges.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates and adds a new team user.</p>
<p><strong>Note:</strong></p>
<p>  This action may result in team users gaining access to team owner level privileges.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="activation_email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">activation_email</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">activation_email=1</span></div><div><div html="&lt;p&gt;Send an email to the team user that allows them to set their own password.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Enabled.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;You must pass either the &lt;code&gt;password&lt;/code&gt; or &lt;code&gt;activation_email&lt;/code&gt; parameter.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Send an email to the team user that allows them to set their own password.</p>
<ul>
<li><code>1</code> - Enabled.</li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li>You must pass either the <code>password</code> or <code>activation_email</code> parameter.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="email1" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email1</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email1=teamuser@example.com</span></div><div><div html="&lt;p&gt;The contact email for the new team user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The contact email for the new team user.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="email2" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email2</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email2=teamuser-backup@example.com</span></div><div><div html="&lt;p&gt;The secondary email for the new team user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The secondary email for the new team user.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="expire_date" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand expire_date"><span class="property-name">expire_date</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer or string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">expire_date=120days</span> - </li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">expire_date=1649948169</span> - </li></ul><div><div html="&lt;p&gt;The epoch time on which the team user account expires, or the offset from the current time, in days. Integers are treated as Unix Epoch Time unless followed by &amp;#39;days&amp;#39;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The epoch time on which the team user account expires, or the offset from the current time, in days. Integers are treated as Unix Epoch Time unless followed by &#39;days&#39;.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="expire_reason" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">expire_reason</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">expire_reason=teamUser gave a two week notice.</span></div><div><div html="&lt;p&gt;The reason for expiration.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The reason for expiration.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="notes" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">notes</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">notes=This is a note about teamuser</span></div><div><div html="&lt;p&gt;Notes about the new team user. This field should not contain private information. Maximum of 100 characters.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Notes about the new team user. This field should not contain private information. Maximum of 100 characters.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="password" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">password</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">password=securepassword</span></div><div><div html="&lt;p&gt;The password to set for the new team user.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;You must pass either the &lt;code&gt;password&lt;/code&gt; or &lt;code&gt;activation_email&lt;/code&gt; parameter.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The password to set for the new team user.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You must pass either the <code>password</code> or <code>activation_email</code> parameter.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="roles" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">roles</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">roles=email,database</span></div><div><div html="&lt;p&gt;A comma-separated list of roles assigned to the new team user. Current roles include admin, database, email, web.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A comma-separated list of roles assigned to the new team user. Current roles include admin, database, email, web.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.email.enabled" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.email.enabled</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.email.enabled=1</span></div><div><div html="&lt;p&gt;Whether to create an email subaccount for the team user. A subaccount is always created for a team user, but it does not have any associated service subaccounts by default.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Create an email subaccount.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - &lt;strong&gt;Do Not&lt;/strong&gt; create an email subaccount.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to create an email subaccount for the team user. A subaccount is always created for a team user, but it does not have any associated service subaccounts by default.</p>
<ul>
<li><code>1</code> - Create an email subaccount.</li>
<li><code>0</code> - <strong>Do Not</strong> create an email subaccount.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.email.quota" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.email.quota</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.email.quota=500</span></div><div><div html="&lt;p&gt;The maximum amount of disk space, in megabytes (MB), allocated to the team user&amp;#39;s email account.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; or &lt;code&gt;unlimited&lt;/code&gt; - The subaccount has unlimited disk space.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;This value defaults to the defined system value.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This value &lt;strong&gt;cannot&lt;/strong&gt; be larger than the system&amp;#39;s maximum email quota.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum amount of disk space, in megabytes (MB), allocated to the team user&#39;s email account.</p>
<ul>
<li><code>0</code> or <code>unlimited</code> - The subaccount has unlimited disk space.</li>
</ul>
<p>This value defaults to the defined system value.</p>
<p><strong>Note:</strong></p>
<p>This value <strong>cannot</strong> be larger than the system&#39;s maximum email quota.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.ftp.enabled" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.ftp.enabled</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.ftp.enabled=1</span></div><div><div html="&lt;p&gt;Whether to create an FTP subaccount for the team user. A subaccount is always created for a team user, but it does not have any associated service subaccounts by default.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Create an FTP subaccount.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - &lt;strong&gt;Do Not&lt;/strong&gt; create an FTP subaccount.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to create an FTP subaccount for the team user. A subaccount is always created for a team user, but it does not have any associated service subaccounts by default.</p>
<ul>
<li><code>1</code> - Create an FTP subaccount.</li>
<li><code>0</code> - <strong>Do Not</strong> create an FTP subaccount.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.ftp.homedir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.ftp.homedir</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.ftp.homedir=/Teamusername</span></div><div><div html="&lt;p&gt;The team user&amp;#39;s FTP home directory, relative to the cPanel account&amp;#39;s home directory.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;This parameter is &lt;strong&gt;required&lt;/strong&gt; if you enabled the &lt;code&gt;services.ftp.homedir&lt;/code&gt; parameter.&lt;/li&gt;
&lt;li&gt;The directory &lt;strong&gt;must&lt;/strong&gt; exist.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The team user&#39;s FTP home directory, relative to the cPanel account&#39;s home directory.</p>
<p><strong>Note:</strong></p>
<ul>
<li>This parameter is <strong>required</strong> if you enabled the <code>services.ftp.homedir</code> parameter.</li>
<li>The directory <strong>must</strong> exist.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.webdisk.enabled" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.webdisk.enabled</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.webdisk.enabled=1</span></div><div><div html="&lt;p&gt;Whether to create a Web Disk subaccount for the team user. A subaccount is always created for a team user, but it does not have any associated service subaccounts by default.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Create a Web Disk subaccount.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - &lt;strong&gt;Do Not&lt;/strong&gt; create a Web Disk subaccount.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to create a Web Disk subaccount for the team user. A subaccount is always created for a team user, but it does not have any associated service subaccounts by default.</p>
<ul>
<li><code>1</code> - Create a Web Disk subaccount.</li>
<li><code>0</code> - <strong>Do Not</strong> create a Web Disk subaccount.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.webdisk.enabledigest" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.webdisk.enabledigest</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.webdisk.enabledigest=0</span></div><div><div html="&lt;p&gt;Whether to enable the Web Disk Digest Authentication.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Enabled.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Disabled.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;strong&gt;Only&lt;/strong&gt; enable Digest Authentication for clients that require additional compatibility support on
certain versions of Windows® operating systems. This compatibility support is &lt;strong&gt;only&lt;/strong&gt; required on servers
that use a self-signed certificate for the &lt;code&gt;cpsrvd&lt;/code&gt; and &lt;code&gt;cpdavd&lt;/code&gt; daemons.&lt;/li&gt;
&lt;li&gt;We recommend that you do &lt;strong&gt;not&lt;/strong&gt; use Digest Authentication.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to enable the Web Disk Digest Authentication.</p>
<ul>
<li><code>1</code> - Enabled.</li>
<li><code>0</code> - Disabled.</li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li><strong>Only</strong> enable Digest Authentication for clients that require additional compatibility support on
certain versions of Windows® operating systems. This compatibility support is <strong>only</strong> required on servers
that use a self-signed certificate for the <code>cpsrvd</code> and <code>cpdavd</code> daemons.</li>
<li>We recommend that you do <strong>not</strong> use Digest Authentication.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.webdisk.homedir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.webdisk.homedir</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.webdisk.homedir=/Teamusername</span></div><div><div html="&lt;p&gt;The team user&amp;#39;s Web Disk home directory, relative to the cPanel account&amp;#39;s home directory.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This parameter is &lt;strong&gt;required&lt;/strong&gt; if you enable the &lt;code&gt;services.webdisk.enabled&lt;/code&gt; parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The team user&#39;s Web Disk home directory, relative to the cPanel account&#39;s home directory.</p>
<p><strong>Note:</strong></p>
<p>This parameter is <strong>required</strong> if you enable the <code>services.webdisk.enabled</code> parameter.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.webdisk.perms" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.webdisk.perms</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;rw&quot;</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.webdisk.perms=rw</span></div><div><div html="&lt;p&gt;The team user&amp;#39;s file permissions for its Web Disk home directory.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;ro&lt;/code&gt; - Read-only permissions.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;rw&lt;/code&gt; - Read and write permissions.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; The &lt;code&gt;services.webdisk.homedir&lt;/code&gt; parameter determines the team user&amp;#39;s Web Disk home directory.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The team user&#39;s file permissions for its Web Disk home directory.</p>
<ul>
<li><code>ro</code> - Read-only permissions.</li>
<li><code>rw</code> - Read and write permissions.</li>
</ul>
<p><strong>Note:</strong></p>
<p> The <code>services.webdisk.homedir</code> parameter determines the team user&#39;s Web Disk home directory.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.webdisk.private" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.webdisk.private</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.webdisk.private=1</span></div><div><div html="&lt;p&gt;Whether to set the directory&amp;#39;s permissions to public or private.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Private (&lt;code&gt;0700&lt;/code&gt;).&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Public (&lt;code&gt;0755&lt;/code&gt;).&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to set the directory&#39;s permissions to public or private.</p>
<ul>
<li><code>1</code> - Private (<code>0700</code>).</li>
<li><code>0</code> - Public (<code>0755</code>).</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=teamuser</span></div><div><div html="&lt;p&gt;The username of the team user. Follows cPanel standards.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username of the team user. Follows cPanel standards.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Team/add_team_user</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Team/add_team_user</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R1556p3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R1556p3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R1556p3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R1556p3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R1556p3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R1556p3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R1556p3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R1556p3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R1556p3a:0" aria-labelledby="tab:R1556p3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Team <span class="token punctuation">\</span>
  add_team_user <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'teamuser'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">email1</span><span class="token operator">=</span><span class="token string">'teamuser@example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1556p3a:1" aria-labelledby="tab:R1556p3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1556p3a:2" aria-labelledby="tab:R1556p3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1556p3a:3" aria-labelledby="tab:R1556p3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R1756p3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R1756p3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R1756p3a:0" aria-labelledby="tab:R1756p3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;add_team_user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Team&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">1674575562</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Team-Users/operation/list_team" data-section-id="tag/Team-Users/operation/list_team" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_team" id="operation/list_team" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Team-Users/operation/list_team" aria-label="tag/Team-Users/operation/list_team"></a>List Team Users </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the team users connected to a cPanel account.
This list is given in an array by default, but can be given in a hash.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the team users connected to a cPanel account.
This list is given in an array by default, but can be given in a hash.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="format" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">format</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">format=array</span></div><div><div html="&lt;p&gt;The format in which the team data is listed.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The format in which the team data is listed.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Team/list_team</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Team/list_team</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R155ap3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R155ap3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R155ap3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R155ap3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R155ap3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R155ap3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R155ap3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R155ap3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R155ap3a:0" aria-labelledby="tab:R155ap3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Team <span class="token punctuation">\</span>
  list_team
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155ap3a:1" aria-labelledby="tab:R155ap3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155ap3a:2" aria-labelledby="tab:R155ap3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155ap3a:3" aria-labelledby="tab:R155ap3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R175ap3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R175ap3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R175ap3a:0" aria-labelledby="tab:R175ap3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_team&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Team&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"contact-email"</span>: <span class="token string">&quot;team_user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token number">1650036110</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expire_date"</span>: <span class="token number">1674575562</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expire_reason"</span>: <span class="token string">&quot;team user 1 year&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastlogin"</span>: <span class="token number">1650046110</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"locale"</span>: <span class="token string">&quot;en&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"notes"</span>: <span class="token string">&quot;This is a note about team user.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"password"</span>: <span class="token string">&quot;encryptedpassword&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"roles"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;email,web&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"secondary-contact-email"</span>: <span class="token string">&quot;team_user_backup@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"services"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">&quot;500*2**20&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ftp"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"webdisk"</span>: <span class="token string">&quot;rw&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"suspend_date"</span>: <span class="token number">1650046210</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"suspend_reason"</span>: <span class="token string">&quot;team user is on vacation&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">&quot;teamuser&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Team-Users/operation/suspend_team_user" data-section-id="tag/Team-Users/operation/suspend_team_user" class="sc-dntaoT ceciOs"><div data-section-id="operation/suspend_team_user" id="operation/suspend_team_user" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Team-Users/operation/suspend_team_user" aria-label="tag/Team-Users/operation/suspend_team_user"></a>Suspend a team user </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function immediately suspends a team user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function immediately suspends a team user.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="reason" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">reason</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">reason=teamuser is on vacation</span></div><div><div html="&lt;p&gt;The reason for suspension.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The reason for suspension.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=teamuser</span></div><div><div html="&lt;p&gt;The username of the team user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username of the team user.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Team/suspend_team_user</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Team/suspend_team_user</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R155ep3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R155ep3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R155ep3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R155ep3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R155ep3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R155ep3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R155ep3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R155ep3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R155ep3a:0" aria-labelledby="tab:R155ep3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Team <span class="token punctuation">\</span>
  suspend_team_user <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'teamuser'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155ep3a:1" aria-labelledby="tab:R155ep3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155ep3a:2" aria-labelledby="tab:R155ep3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155ep3a:3" aria-labelledby="tab:R155ep3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R175ep3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R175ep3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R175ep3a:0" aria-labelledby="tab:R175ep3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;suspend_team_user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Team&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Team-Users/operation/edit_team_user" data-section-id="tag/Team-Users/operation/edit_team_user" class="sc-dntaoT ceciOs"><div data-section-id="operation/edit_team_user" id="operation/edit_team_user" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Team-Users/operation/edit_team_user" aria-label="tag/Team-Users/operation/edit_team_user"></a>Edit a team user </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function modifies a team user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function modifies a team user.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="add_role" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">add_role</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">add_role=database</span></div><div><div html="&lt;p&gt;The role or roles to add to the team user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The role or roles to add to the team user.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="email1" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email1</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email1=teamuser@example.com</span></div><div><div html="&lt;p&gt;The primary contact email address to set for the team user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The primary contact email address to set for the team user.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="email2" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email2</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email2=teamuser@example.com</span></div><div><div html="&lt;p&gt;The secondary contact email address to set for the team user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The secondary contact email address to set for the team user.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="expire_reason" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">expire_reason</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">expire_reason=teamUser gave a two week notice.</span></div><div><div html="&lt;p&gt;The reason for expiration.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The reason for expiration.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="notes" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">notes</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">notes=This is a note about teamUser</span></div><div><div html="&lt;p&gt;Notes about the new team user. This field should not contain private information.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Notes about the new team user. This field should not contain private information.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="password" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">password</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">password=securepassword</span></div><div><div html="&lt;p&gt;The password to set for the team user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The password to set for the team user.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="remove_role" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">remove_role</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">remove_role=database</span></div><div><div html="&lt;p&gt;The role or roles to remove from the team user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The role or roles to remove from the team user.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.email.enabled" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.email.enabled</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.email.enabled=1</span></div><div><div html="&lt;p&gt;Whether to create or remove an email subaccount for the team user. A subaccount is always created for a team user, but it does not have any associated service subaccounts by default.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Create and associate an email subaccount.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Remove any associated email subaccounts.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to create or remove an email subaccount for the team user. A subaccount is always created for a team user, but it does not have any associated service subaccounts by default.</p>
<ul>
<li><code>1</code> - Create and associate an email subaccount.</li>
<li><code>0</code> - Remove any associated email subaccounts.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.email.quota" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.email.quota</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.email.quota=500</span></div><div><div html="&lt;p&gt;The maximum amount of disk space, in megabytes (MB), allocated to the team user&amp;#39;s email account.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; or &lt;code&gt;unlimited&lt;/code&gt; - The subaccount has unlimited disk space.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;This value defaults to the defined system value.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This value &lt;strong&gt;cannot&lt;/strong&gt; be larger than the system&amp;#39;s maximum email quota.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum amount of disk space, in megabytes (MB), allocated to the team user&#39;s email account.</p>
<ul>
<li><code>0</code> or <code>unlimited</code> - The subaccount has unlimited disk space.</li>
</ul>
<p>This value defaults to the defined system value.</p>
<p><strong>Note:</strong></p>
<p>This value <strong>cannot</strong> be larger than the system&#39;s maximum email quota.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.ftp.enabled" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.ftp.enabled</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.ftp.enabled=1</span></div><div><div html="&lt;p&gt;Whether to create or remove an FTP subaccount for the team user. A subaccount is always created for a team user, but it does not have any associated service subaccounts by default.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Create and associate an FTP subaccount.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Remove any associated FTP subaccounts.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to create or remove an FTP subaccount for the team user. A subaccount is always created for a team user, but it does not have any associated service subaccounts by default.</p>
<ul>
<li><code>1</code> - Create and associate an FTP subaccount.</li>
<li><code>0</code> - Remove any associated FTP subaccounts.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.ftp.homedir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.ftp.homedir</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.ftp.homedir=/Teamusername</span></div><div><div html="&lt;p&gt;The team user&amp;#39;s FTP home directory, relative to the cPanel account&amp;#39;s home directory.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;This parameter is &lt;strong&gt;required&lt;/strong&gt; if you enabled the &lt;code&gt;services.ftp.homedir&lt;/code&gt; parameter.&lt;/li&gt;
&lt;li&gt;The directory &lt;strong&gt;must&lt;/strong&gt; exist.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The team user&#39;s FTP home directory, relative to the cPanel account&#39;s home directory.</p>
<p><strong>Note:</strong></p>
<ul>
<li>This parameter is <strong>required</strong> if you enabled the <code>services.ftp.homedir</code> parameter.</li>
<li>The directory <strong>must</strong> exist.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.webdisk.enabled" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.webdisk.enabled</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.webdisk.enabled=1</span></div><div><div html="&lt;p&gt;Whether to create or remove a Web Disk subaccount for the team user. A subaccount is always created for a team user, but it does not have any associated service subaccounts by default.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Create and associate a Web Disk subaccount.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Remove any associated Web Disk subaccounts.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to create or remove a Web Disk subaccount for the team user. A subaccount is always created for a team user, but it does not have any associated service subaccounts by default.</p>
<ul>
<li><code>1</code> - Create and associate a Web Disk subaccount.</li>
<li><code>0</code> - Remove any associated Web Disk subaccounts.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.webdisk.enabledigest" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.webdisk.enabledigest</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.webdisk.enabledigest=0</span></div><div><div html="&lt;p&gt;Whether to enable the Web Disk Digest Authentication.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Enabled.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Disabled.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;strong&gt;Only&lt;/strong&gt; enable Digest Authentication for clients that require additional compatibility support on
certain versions of Windows® operating systems. This compatibility support is &lt;strong&gt;only&lt;/strong&gt; required on servers
that use a self-signed certificate for the &lt;code&gt;cpsrvd&lt;/code&gt; and &lt;code&gt;cpdavd&lt;/code&gt; daemons.&lt;/li&gt;
&lt;li&gt;We recommend that you do &lt;strong&gt;not&lt;/strong&gt; use Digest Authentication.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to enable the Web Disk Digest Authentication.</p>
<ul>
<li><code>1</code> - Enabled.</li>
<li><code>0</code> - Disabled.</li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li><strong>Only</strong> enable Digest Authentication for clients that require additional compatibility support on
certain versions of Windows® operating systems. This compatibility support is <strong>only</strong> required on servers
that use a self-signed certificate for the <code>cpsrvd</code> and <code>cpdavd</code> daemons.</li>
<li>We recommend that you do <strong>not</strong> use Digest Authentication.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.webdisk.homedir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.webdisk.homedir</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.webdisk.homedir=/Teamusername</span></div><div><div html="&lt;p&gt;The team user&amp;#39;s Web Disk home directory, relative to the cPanel account&amp;#39;s home directory.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This parameter is &lt;strong&gt;required&lt;/strong&gt; if you enable the &lt;code&gt;services.webdisk.enabled&lt;/code&gt; parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The team user&#39;s Web Disk home directory, relative to the cPanel account&#39;s home directory.</p>
<p><strong>Note:</strong></p>
<p>This parameter is <strong>required</strong> if you enable the <code>services.webdisk.enabled</code> parameter.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.webdisk.perms" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.webdisk.perms</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;rw&quot;</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.webdisk.perms=rw</span></div><div><div html="&lt;p&gt;The team user&amp;#39;s file permissions for its Web Disk home directory.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;ro&lt;/code&gt; - Read-only permissions.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;rw&lt;/code&gt; - Read and write permissions.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; The &lt;code&gt;services.webdisk.homedir&lt;/code&gt; parameter determines the team user&amp;#39;s Web Disk home directory.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The team user&#39;s file permissions for its Web Disk home directory.</p>
<ul>
<li><code>ro</code> - Read-only permissions.</li>
<li><code>rw</code> - Read and write permissions.</li>
</ul>
<p><strong>Note:</strong></p>
<p> The <code>services.webdisk.homedir</code> parameter determines the team user&#39;s Web Disk home directory.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="services.webdisk.private" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">services.webdisk.private</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">services.webdisk.private=1</span></div><div><div html="&lt;p&gt;Whether to set the directory&amp;#39;s permissions to public or private.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Private (&lt;code&gt;0700&lt;/code&gt;).&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Public (&lt;code&gt;0755&lt;/code&gt;).&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to set the directory&#39;s permissions to public or private.</p>
<ul>
<li><code>1</code> - Private (<code>0700</code>).</li>
<li><code>0</code> - Public (<code>0755</code>).</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="set_expire" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand set_expire"><span class="property-name">set_expire</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer or string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">set_expire=120days</span> - </li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">set_expire=1649948169</span> - </li></ul><div><div html="&lt;p&gt;The epoch time the team user account expires on or the offset in days.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The epoch time the team user account expires on or the offset in days.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="set_role" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">set_role</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">set_role=email</span></div><div><div html="&lt;p&gt;The role or roles to set for the team user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The role or roles to set for the team user.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=teamUser</span></div><div><div html="&lt;p&gt;The username of the team user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username of the team user.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Team/edit_team_user</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Team/edit_team_user</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R155ip3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R155ip3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R155ip3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R155ip3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R155ip3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R155ip3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R155ip3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R155ip3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R155ip3a:0" aria-labelledby="tab:R155ip3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Team <span class="token punctuation">\</span>
  edit_team_user <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'teamUser'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155ip3a:1" aria-labelledby="tab:R155ip3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155ip3a:2" aria-labelledby="tab:R155ip3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155ip3a:3" aria-labelledby="tab:R155ip3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R175ip3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R175ip3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R175ip3a:0" aria-labelledby="tab:R175ip3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;edit_team_user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Team&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Team-Users/operation/set_team_user_notes" data-section-id="tag/Team-Users/operation/set_team_user_notes" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_team_user_notes" id="operation/set_team_user_notes" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Team-Users/operation/set_team_user_notes" aria-label="tag/Team-Users/operation/set_team_user_notes"></a>Set notes for a team user </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function replaces the current notes field with new text.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function replaces the current notes field with new text.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="notes" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">notes</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">notes=teamUser is a good employee</span></div><div><div html="&lt;p&gt;The content of the notes field.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The content of the notes field.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=teamUser</span></div><div><div html="&lt;p&gt;The username of the team user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username of the team user.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Team/set_notes</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Team/set_notes</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R155mp3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R155mp3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R155mp3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R155mp3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R155mp3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R155mp3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R155mp3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R155mp3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R155mp3a:0" aria-labelledby="tab:R155mp3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Team <span class="token punctuation">\</span>
  set_notes <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'teamUser'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">notes</span><span class="token operator">=</span><span class="token string">'teamUser '</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155mp3a:1" aria-labelledby="tab:R155mp3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155mp3a:2" aria-labelledby="tab:R155mp3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155mp3a:3" aria-labelledby="tab:R155mp3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R175mp3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R175mp3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R175mp3a:0" aria-labelledby="tab:R175mp3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_notes&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Team&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Team-Users/operation/Team::set_locale" data-section-id="tag/Team-Users/operation/Team::set_locale" class="sc-dntaoT ceciOs"><div data-section-id="operation/Team::set_locale" id="operation/Team::set_locale" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Team-Users/operation/Team::set_locale" aria-label="tag/Team-Users/operation/Team::set_locale"></a>Set locale for a team user </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function sets locale for a team user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets locale for a team user.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="locale" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">locale</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">locale=es_es</span></div><div><div html="&lt;p&gt;The new locale for the team user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new locale for the team user.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=teamuser</span></div><div><div html="&lt;p&gt;The username of the team user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username of the team user.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Team/set_locale</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Team/set_locale</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R155qp3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R155qp3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R155qp3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R155qp3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R155qp3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R155qp3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R155qp3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R155qp3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R155qp3a:0" aria-labelledby="tab:R155qp3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Team <span class="token punctuation">\</span>
  set_locale <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'teamuser'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">locale</span><span class="token operator">=</span><span class="token string">'es_es'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155qp3a:1" aria-labelledby="tab:R155qp3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155qp3a:2" aria-labelledby="tab:R155qp3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155qp3a:3" aria-labelledby="tab:R155qp3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R175qp3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R175qp3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R175qp3a:0" aria-labelledby="tab:R175qp3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_locale&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Team&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Team-Users/operation/get_team_users_with_roles_count" data-section-id="tag/Team-Users/operation/get_team_users_with_roles_count" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_team_users_with_roles_count" id="operation/get_team_users_with_roles_count" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Team-Users/operation/get_team_users_with_roles_count" aria-label="tag/Team-Users/operation/get_team_users_with_roles_count"></a>Get number of team users with roles </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the current and maximum number of team users with roles.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the current and maximum number of team users with roles.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Team/get_team_users_with_roles_count</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Team/get_team_users_with_roles_count</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R155up3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R155up3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R155up3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R155up3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R155up3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R155up3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R155up3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R155up3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R155up3a:0" aria-labelledby="tab:R155up3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Team <span class="token punctuation">\</span>
  get_team_users_with_roles_count
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155up3a:1" aria-labelledby="tab:R155up3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155up3a:2" aria-labelledby="tab:R155up3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155up3a:3" aria-labelledby="tab:R155up3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R175up3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R175up3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R175up3a:0" aria-labelledby="tab:R175up3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_team_users_with_roles_count&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Team&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"max"</span>: <span class="token number">7</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"used"</span>: <span class="token number">2</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Team-Users/operation/set_roles" data-section-id="tag/Team-Users/operation/set_roles" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_roles" id="operation/set_roles" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Team-Users/operation/set_roles" aria-label="tag/Team-Users/operation/set_roles"></a>Set roles for a team user </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function sets roles for a team user.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  This action may result in team users gaining access to team owner level privileges.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets roles for a team user.</p>
<p><strong>Note:</strong></p>
<p>  This action may result in team users gaining access to team owner level privileges.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="role" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">role</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">role=database</span></div><div><div html="&lt;p&gt;The role or roles to set for the team user. Current roles include admin, database, email, web.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The role or roles to set for the team user. Current roles include admin, database, email, web.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=teamuser</span></div><div><div html="&lt;p&gt;The username of the team user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username of the team user.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Team/set_roles</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Team/set_roles</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R1562p3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R1562p3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R1562p3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R1562p3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R1562p3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R1562p3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R1562p3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R1562p3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R1562p3a:0" aria-labelledby="tab:R1562p3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Team <span class="token punctuation">\</span>
  set_roles <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'teamuser'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1562p3a:1" aria-labelledby="tab:R1562p3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1562p3a:2" aria-labelledby="tab:R1562p3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1562p3a:3" aria-labelledby="tab:R1562p3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R1762p3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R1762p3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R1762p3a:0" aria-labelledby="tab:R1762p3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_roles&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Team&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Team-Users/operation/remove_team_user" data-section-id="tag/Team-Users/operation/remove_team_user" class="sc-dntaoT ceciOs"><div data-section-id="operation/remove_team_user" id="operation/remove_team_user" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Team-Users/operation/remove_team_user" aria-label="tag/Team-Users/operation/remove_team_user"></a>Remove a team user </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function removes a team user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes a team user.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=teamuser</span></div><div><div html="&lt;p&gt;The username of the team user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username of the team user.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Team/remove_team_user</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Team/remove_team_user</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R1566p3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R1566p3a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R1566p3a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R1566p3a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R1566p3a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R1566p3a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R1566p3a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R1566p3a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R1566p3a:0" aria-labelledby="tab:R1566p3a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Team <span class="token punctuation">\</span>
  remove_team_user <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'teamuser'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1566p3a:1" aria-labelledby="tab:R1566p3a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1566p3a:2" aria-labelledby="tab:R1566p3a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1566p3a:3" aria-labelledby="tab:R1566p3a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R1766p3a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R1766p3a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R1766p3a:0" aria-labelledby="tab:R1766p3a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;remove_team_user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Team&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Backup" data-section-id="tag/Backup" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Backup" aria-label="tag/Backup"></a>Backup</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;The Backup module for UAPI.&lt;/p&gt;
"><p>The Backup module for UAPI.</p>
</div></div></div><div id="tag/Backup/operation/fullbackup_to_scp_with_password" data-section-id="tag/Backup/operation/fullbackup_to_scp_with_password" class="sc-dntaoT ceciOs"><div data-section-id="operation/fullbackup_to_scp_with_password" id="operation/fullbackup_to_scp_with_password" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Backup/operation/fullbackup_to_scp_with_password" aria-label="tag/Backup/operation/fullbackup_to_scp_with_password"></a>Back up cPanel account via SCP with password </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function creates a full backup to a remote server via the secure copy protocol (&lt;code&gt;scp&lt;/code&gt;) command with a password. The system creates a file in the &lt;code&gt;backup-MM.DD.YYYY_HH-mm-ss.tar.gz&lt;/code&gt; filename format.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a full backup to a remote server via the secure copy protocol (<code>scp</code>) command with a password. The system creates a file in the <code>backup-MM.DD.YYYY_HH-mm-ss.tar.gz</code> filename format.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="directory" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">directory</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">directory=/user</span></div><div><div html="&lt;p&gt;The directory on the remote server that will store the backup.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This parameter defaults to the remote server account&amp;#39;s default login directory.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The directory on the remote server that will store the backup.</p>
<p><strong>Note:</strong></p>
<p>This parameter defaults to the remote server account&#39;s default login directory.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">null</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=username@example.com</span></div><div><div html="&lt;p&gt;The email address to receive a confirmation email when the backup completes.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;The system does &lt;strong&gt;not&lt;/strong&gt; provide confirmation if you do &lt;strong&gt;not&lt;/strong&gt; pass this parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email address to receive a confirmation email when the backup completes.</p>
<p><strong>Note:</strong></p>
<p>The system does <strong>not</strong> provide confirmation if you do <strong>not</strong> pass this parameter.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="homedir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">homedir</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;include&quot;</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;include&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;skip&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">homedir=include</span></div><div><div html="&lt;p&gt;How to manage the home directory in the backup.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;include&lt;/code&gt; — Include the home directory in the backup.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;skip&lt;/code&gt; — Omit the home directory from the backup.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>How to manage the home directory in the backup.</p>
<ul>
<li><code>include</code> — Include the home directory in the backup.</li>
<li><code>skip</code> — Omit the home directory from the backup.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="host" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand host"><span class="property-name">host</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">host=example.com</span></div><div><div html="&lt;p&gt;The remote server&amp;#39;s hostname or IP address.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The remote server&#39;s hostname or IP address.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="password" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">password</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">password=luggage123456</span></div><div><div html="&lt;p&gt;The remote server account&amp;#39;s password.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The remote server account&#39;s password.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="port" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">port</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> [ 1 .. 65335 ] </span></span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">22</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">port=22</span></div><div><div html="&lt;p&gt;The port to use during the transfer.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The port to use during the transfer.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="username" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">username</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">username=username</span></div><div><div html="&lt;p&gt;The remote server account&amp;#39;s username.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The remote server account&#39;s username.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Backup/fullbackup_to_scp_with_password</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Backup/fullbackup_to_scp_with_password</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a9j3q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9j3q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9j3q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9j3q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2a9j3q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9j3q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2a9j3q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9j3q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9j3q:0" aria-labelledby="tab:R2a9j3q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Backup <span class="token punctuation">\</span>
  fullbackup_to_scp_with_password <span class="token punctuation">\</span>
  <span class="token assign-left variable">host</span><span class="token operator">=</span><span class="token string">'example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">username</span><span class="token operator">=</span><span class="token string">'username'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">password</span><span class="token operator">=</span><span class="token string">'luggage123456'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9j3q:1" aria-labelledby="tab:R2a9j3q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9j3q:2" aria-labelledby="tab:R2a9j3q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9j3q:3" aria-labelledby="tab:R2a9j3q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2e9j3q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9j3q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9j3q:0" aria-labelledby="tab:R2e9j3q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;fullbackup_to_scp_with_password&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Backup&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"pid"</span>: <span class="token string">&quot;2857&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Backup/operation/fullbackup_to_ftp" data-section-id="tag/Backup/operation/fullbackup_to_ftp" class="sc-dntaoT ceciOs"><div data-section-id="operation/fullbackup_to_ftp" id="operation/fullbackup_to_ftp" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Backup/operation/fullbackup_to_ftp" aria-label="tag/Backup/operation/fullbackup_to_ftp"></a>Back up cPanel account via FTP </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function creates a full backup to the remote server via File Transfer Protocol (FTP). The system creates a file in the &lt;code&gt;backup-MM.DD.YYYY_HH-mm-ss.tar.gz&lt;/code&gt; filename format.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a full backup to the remote server via File Transfer Protocol (FTP). The system creates a file in the <code>backup-MM.DD.YYYY_HH-mm-ss.tar.gz</code> filename format.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="directory" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">directory</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">directory=/public_ftp</span></div><div><div html="&lt;p&gt;The directory on the remote server that will store the backup.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;This value defaults to the remote server account&amp;#39;s default login directory.&lt;/li&gt;
&lt;li&gt;Enter the directory relative to the FTP user&amp;#39;s login directory. For example, enter &lt;code&gt;/public_ftp&lt;/code&gt; not &lt;code&gt;/home/username/public_ftp&lt;/code&gt;.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The directory on the remote server that will store the backup.</p>
<p><strong>Note:</strong></p>
<ul>
<li>This value defaults to the remote server account&#39;s default login directory.</li>
<li>Enter the directory relative to the FTP user&#39;s login directory. For example, enter <code>/public_ftp</code> not <code>/home/username/public_ftp</code>.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">null</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=username@example.com</span></div><div><div html="&lt;p&gt;The email address to receive a confirmation email when the backup completes.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; The system does &lt;strong&gt;not&lt;/strong&gt; provide confirmation if you do &lt;strong&gt;not&lt;/strong&gt; pass this parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email address to receive a confirmation email when the backup completes.</p>
<p><strong>Note:</strong></p>
<p> The system does <strong>not</strong> provide confirmation if you do <strong>not</strong> pass this parameter.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="homedir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">homedir</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;include&quot;</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;include&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;skip&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">homedir=include</span></div><div><div html="&lt;p&gt;How to manage the home directory in the backup.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;include&lt;/code&gt; — Include the home directory in the backup.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;skip&lt;/code&gt; — Omit the home directory from the backup.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>How to manage the home directory in the backup.</p>
<ul>
<li><code>include</code> — Include the home directory in the backup.</li>
<li><code>skip</code> — Omit the home directory from the backup.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="host" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand host"><span class="property-name">host</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">host=example.com</span></div><div><div html="&lt;p&gt;The remote server&amp;#39;s hostname or IP address.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The remote server&#39;s hostname or IP address.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="password" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">password</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">password=luggage123456</span></div><div><div html="&lt;p&gt;The remote server account&amp;#39;s password.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The remote server account&#39;s password.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="port" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">port</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> [ 1 .. 65535 ] </span></span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">21</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">port=21</span></div><div><div html="&lt;p&gt;The port number to use during the transfer.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The port number to use during the transfer.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="username" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">username</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">username=username</span></div><div><div html="&lt;p&gt;The remote server account&amp;#39;s username.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The remote server account&#39;s username.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="variant" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">variant</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;active&quot;</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;active&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;passive&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">variant=active</span></div><div><div html="&lt;p&gt;Whether to use the &lt;code&gt;active&lt;/code&gt; or &lt;code&gt;passive&lt;/code&gt; FTP variant to connect to
the remote server. For more information about FTP variants, read our How
to &lt;a href=&quot;https://go.cpanel.net/HowtoEnableFTPPassiveMode&quot;&gt;Enable FTP Passive Mode&lt;/a&gt; documentation.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;active&lt;/code&gt; — The FTP server responds to the connection attempt and returns a connection request from a different port to the FTP client.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;passive&lt;/code&gt; — The FTP client initiates connection attempts.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to use the <code>active</code> or <code>passive</code> FTP variant to connect to
the remote server. For more information about FTP variants, read our How
to <a href="https://go.cpanel.net/HowtoEnableFTPPassiveMode">Enable FTP Passive Mode</a> documentation.</p>
<ul>
<li><code>active</code> — The FTP server responds to the connection attempt and returns a connection request from a different port to the FTP client.</li>
<li><code>passive</code> — The FTP client initiates connection attempts.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Backup/fullbackup_to_ftp</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Backup/fullbackup_to_ftp</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aaj3q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aaj3q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aaj3q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aaj3q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2aaj3q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aaj3q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2aaj3q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aaj3q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aaj3q:0" aria-labelledby="tab:R2aaj3q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Backup <span class="token punctuation">\</span>
  fullbackup_to_ftp <span class="token punctuation">\</span>
  <span class="token assign-left variable">username</span><span class="token operator">=</span><span class="token string">'username'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">password</span><span class="token operator">=</span><span class="token string">'luggage123456'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">host</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aaj3q:1" aria-labelledby="tab:R2aaj3q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aaj3q:2" aria-labelledby="tab:R2aaj3q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aaj3q:3" aria-labelledby="tab:R2aaj3q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eaj3q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eaj3q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eaj3q:0" aria-labelledby="tab:R2eaj3q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;fullbackup_to_ftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Backup&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"pid"</span>: <span class="token string">&quot;2857&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Backup/operation/fullbackup_to_homedir" data-section-id="tag/Backup/operation/fullbackup_to_homedir" class="sc-dntaoT ceciOs"><div data-section-id="operation/fullbackup_to_homedir" id="operation/fullbackup_to_homedir" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Backup/operation/fullbackup_to_homedir" aria-label="tag/Backup/operation/fullbackup_to_homedir"></a>Back up cPanel account to home directory </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function creates a full backup to the user&amp;#39;s home directory. The system creates a file in the &lt;code&gt;backup-MM.DD.YYYY_HH-mm-ss_username.tar.gz&lt;/code&gt; filename format.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a full backup to the user&#39;s home directory. The system creates a file in the <code>backup-MM.DD.YYYY_HH-mm-ss_username.tar.gz</code> filename format.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">null</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=username@example.com</span></div><div><div html="&lt;p&gt;The email address to receive a confirmation email when the backup process completes.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;The system does &lt;strong&gt;not&lt;/strong&gt; provide confirmation if you do not pass this parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email address to receive a confirmation email when the backup process completes.</p>
<p><strong>Note:</strong></p>
<p>The system does <strong>not</strong> provide confirmation if you do not pass this parameter.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="homedir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">homedir</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;include&quot;</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;include&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;skip&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">homedir=include</span></div><div><div html="&lt;p&gt;How to manage the home directory in the backup.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;include&lt;/code&gt; — Include the home directory in the backup.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;skip&lt;/code&gt; — Omit the home directory from the backup.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>How to manage the home directory in the backup.</p>
<ul>
<li><code>include</code> — Include the home directory in the backup.</li>
<li><code>skip</code> — Omit the home directory from the backup.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Backup/fullbackup_to_homedir</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Backup/fullbackup_to_homedir</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2abj3q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abj3q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abj3q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abj3q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2abj3q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abj3q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2abj3q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abj3q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abj3q:0" aria-labelledby="tab:R2abj3q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Backup <span class="token punctuation">\</span>
  fullbackup_to_homedir
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abj3q:1" aria-labelledby="tab:R2abj3q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abj3q:2" aria-labelledby="tab:R2abj3q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abj3q:3" aria-labelledby="tab:R2abj3q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ebj3q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebj3q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebj3q:0" aria-labelledby="tab:R2ebj3q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;fullbackup_to_homedir&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Backup&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"pid"</span>: <span class="token string">&quot;2857&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Backup/operation/fullbackup_to_scp_with_key" data-section-id="tag/Backup/operation/fullbackup_to_scp_with_key" class="sc-dntaoT ceciOs"><div data-section-id="operation/fullbackup_to_scp_with_key" id="operation/fullbackup_to_scp_with_key" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Backup/operation/fullbackup_to_scp_with_key" aria-label="tag/Backup/operation/fullbackup_to_scp_with_key"></a>Back up cPanel account via SCP with SSH key </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function creates a full backup to a remote server with a private SSH key via the secure copy protocol (scp) command. The system creates a file in the &lt;code&gt;backup-MM.DD.YYYY_HH-mm-ss_username.tar.gz&lt;/code&gt; filename format.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a full backup to a remote server with a private SSH key via the secure copy protocol (scp) command. The system creates a file in the <code>backup-MM.DD.YYYY_HH-mm-ss_username.tar.gz</code> filename format.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="directory" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">directory</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">directory=/user</span></div><div><div html="&lt;p&gt;The directory on the remote server that will store the backup.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This parameter defaults to the remote server account&amp;#39;s default login directory.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The directory on the remote server that will store the backup.</p>
<p><strong>Note:</strong></p>
<p>This parameter defaults to the remote server account&#39;s default login directory.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">null</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=username@example.com</span></div><div><div html="&lt;p&gt;The email address to receive a confirmation email when the backup completes.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;The system does &lt;strong&gt;not&lt;/strong&gt; provide confirmation if you do not pass this parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email address to receive a confirmation email when the backup completes.</p>
<p><strong>Note:</strong></p>
<p>The system does <strong>not</strong> provide confirmation if you do not pass this parameter.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="homedir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">homedir</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;include&quot;</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;include&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;skip&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">homedir=include</span></div><div><div html="&lt;p&gt;How to manage the home directory in the backup.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;include&lt;/code&gt; — Include the home directory in the backup.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;skip&lt;/code&gt; — Omit the home directory from the backup.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>How to manage the home directory in the backup.</p>
<ul>
<li><code>include</code> — Include the home directory in the backup.</li>
<li><code>skip</code> — Omit the home directory from the backup.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="host" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand host"><span class="property-name">host</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">host=example.com</span></div><div><div html="&lt;p&gt;The remote server&amp;#39;s hostname or IP address.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The remote server&#39;s hostname or IP address.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="key_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">key_name</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key_name=examplesshkey</span></div><div><div html="&lt;p&gt;The SSH key&amp;#39;s name.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Notes:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;To generate a private SSH key, use the UAPI &lt;code&gt;SSL::generate_key&lt;/code&gt;
function.&lt;/li&gt;
&lt;li&gt;To import an existing SSH key, use the cPanel API 2
&lt;code&gt;SSH::importkey&lt;/code&gt; function.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The SSH key&#39;s name.</p>
<p><strong>Notes:</strong></p>
<ul>
<li>To generate a private SSH key, use the UAPI <code>SSL::generate_key</code>
function.</li>
<li>To import an existing SSH key, use the cPanel API 2
<code>SSH::importkey</code> function.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="key_passphrase" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">key_passphrase</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= 4 characters </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key_passphrase=123456luggage</span></div><div><div html="&lt;p&gt;The SSH key&amp;#39;s password.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The SSH key&#39;s password.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="port" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">port</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> [ 1 .. 65335 ] </span></span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">22</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">port=22</span></div><div><div html="&lt;p&gt;The port to use during the transfer.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The port to use during the transfer.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Backup/fullbackup_to_scp_with_key</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Backup/fullbackup_to_scp_with_key</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2acj3q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2acj3q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2acj3q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acj3q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2acj3q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acj3q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2acj3q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acj3q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2acj3q:0" aria-labelledby="tab:R2acj3q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Backup <span class="token punctuation">\</span>
  fullbackup_to_scp_with_key <span class="token punctuation">\</span>
  <span class="token assign-left variable">host</span><span class="token operator">=</span><span class="token string">'example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">key_name</span><span class="token operator">=</span><span class="token string">'examplesshkey'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">key_passphrase</span><span class="token operator">=</span><span class="token string">'123456luggage'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acj3q:1" aria-labelledby="tab:R2acj3q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acj3q:2" aria-labelledby="tab:R2acj3q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acj3q:3" aria-labelledby="tab:R2acj3q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ecj3q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ecj3q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ecj3q:0" aria-labelledby="tab:R2ecj3q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;fullbackup_to_scp_with_key&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Backup&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"pid"</span>: <span class="token string">&quot;2857&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Backup/operation/list_backups" data-section-id="tag/Backup/operation/list_backups" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_backups" id="operation/list_backups" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Backup/operation/list_backups" aria-label="tag/Backup/operation/list_backups"></a>Return backup files </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the account&amp;#39;s backup files.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the account&#39;s backup files.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Backup/list_backups</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Backup/list_backups</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2adj3q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2adj3q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2adj3q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adj3q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2adj3q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adj3q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2adj3q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adj3q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2adj3q:0" aria-labelledby="tab:R2adj3q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Backup <span class="token punctuation">\</span>
  list_backups
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adj3q:1" aria-labelledby="tab:R2adj3q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adj3q:2" aria-labelledby="tab:R2adj3q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adj3q:3" aria-labelledby="tab:R2adj3q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2edj3q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2edj3q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2edj3q:0" aria-labelledby="tab:R2edj3q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_backups&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Backup&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;2014-12-02&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"cnt"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/File-Restoration" data-section-id="tag/File-Restoration" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/File-Restoration" aria-label="tag/File-Restoration"></a>File Restoration</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;cPanel Account Backups / File Restoration&lt;/p&gt;
"><p>cPanel Account Backups / File Restoration</p>
</div></div></div><div id="tag/File-Restoration/operation/directory_listing" data-section-id="tag/File-Restoration/operation/directory_listing" class="sc-dntaoT ceciOs"><div data-section-id="operation/directory_listing" id="operation/directory_listing" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/File-Restoration/operation/directory_listing" aria-label="tag/File-Restoration/operation/directory_listing"></a>Return backups in home directory </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists all of the backup files and directories in the user&amp;#39;s home directory.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;File Storage role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists all of the backup files and directories in the user&#39;s home directory.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">File Storage role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="path" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">path</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">path=/public_html/</span></div><div><div html="&lt;p&gt;A path to a subdirectory within the user&amp;#39;s home directory, or any level below it.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;The value of this parameter &lt;strong&gt;must&lt;/strong&gt; begin and end with a forward slash (&lt;code&gt;/&lt;/code&gt;) for security purposes.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A path to a subdirectory within the user&#39;s home directory, or any level below it.</p>
<p><strong>Note:</strong></p>
<p>The value of this parameter <strong>must</strong> begin and end with a forward slash (<code>/</code>) for security purposes.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Restore/directory_listing</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Restore/directory_listing</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4khl3q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4khl3q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4khl3q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4khl3q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4khl3q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4khl3q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4khl3q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4khl3q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4khl3q:0" aria-labelledby="tab:R4khl3q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Restore <span class="token punctuation">\</span>
  directory_listing <span class="token punctuation">\</span>
  <span class="token assign-left variable">path</span><span class="token operator">=</span><span class="token string">'/public_html/'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4khl3q:1" aria-labelledby="tab:R4khl3q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4khl3q:2" aria-labelledby="tab:R4khl3q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4khl3q:3" aria-labelledby="tab:R4khl3q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4shl3q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4shl3q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4shl3q:0" aria-labelledby="tab:R4shl3q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;directory_listing&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Restore&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"conflict"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"exists"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;public_html&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"onDiskType"</span>: <span class="token string">&quot;file&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;file&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/File-Restoration/operation/get_users" data-section-id="tag/File-Restoration/operation/get_users" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_users" id="operation/get_users" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/File-Restoration/operation/get_users" aria-label="tag/File-Restoration/operation/get_users"></a>Return cPanel accounts with backup metadata </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists a reseller&amp;#39;s users that have existing backup metadata.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;File Storage role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists a reseller&#39;s users that have existing backup metadata.</p>
<p><strong>Note:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">File Storage role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Restore/get_users</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Restore/get_users</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kil3q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kil3q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kil3q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kil3q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kil3q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kil3q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kil3q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kil3q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kil3q:0" aria-labelledby="tab:R4kil3q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Restore <span class="token punctuation">\</span>
  get_users
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kil3q:1" aria-labelledby="tab:R4kil3q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kil3q:2" aria-labelledby="tab:R4kil3q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kil3q:3" aria-labelledby="tab:R4kil3q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sil3q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sil3q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sil3q:0" aria-labelledby="tab:R4sil3q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_users&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Restore&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;username&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/File-Restoration/operation/query_file_info" data-section-id="tag/File-Restoration/operation/query_file_info" class="sc-dntaoT ceciOs"><div data-section-id="operation/query_file_info" id="operation/query_file_info" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/File-Restoration/operation/query_file_info" aria-label="tag/File-Restoration/operation/query_file_info"></a>Return backup storage locations </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists all of an item&amp;#39;s backup locations. An item can be a file, a directory, or a symlink.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles#roles&quot;&gt;File Storage role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists all of an item&#39;s backup locations. An item can be a file, a directory, or a symlink.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles#roles">File Storage role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="exists" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">exists</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">exists=0</span></div><div><div html="&lt;p&gt;Whether to show the &lt;code&gt;exist&lt;/code&gt; return, which indicates whether the item exists in the
local disk or only in the backup.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Show the &lt;code&gt;exist&lt;/code&gt; return&amp;#39;s value.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Do &lt;strong&gt;not&lt;/strong&gt; show the &lt;code&gt;exists&lt;/code&gt; return&amp;#39;s value.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to show the <code>exist</code> return, which indicates whether the item exists in the
local disk or only in the backup.</p>
<ul>
<li><code>1</code> — Show the <code>exist</code> return&#39;s value.</li>
<li><code>0</code> — Do <strong>not</strong> show the <code>exists</code> return&#39;s value.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="path" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">path</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">path=/public_html/index.php</span></div><div><div html="&lt;p&gt;A file, directory, or symlink in the user&amp;#39;s directory tree.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;The value of this parameter &lt;strong&gt;must&lt;/strong&gt; begin with a forward slash (&lt;code&gt;/&lt;/code&gt;).&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A file, directory, or symlink in the user&#39;s directory tree.</p>
<p><strong>Note:</strong></p>
<p>The value of this parameter <strong>must</strong> begin with a forward slash (<code>/</code>).</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Restore/query_file_info</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Restore/query_file_info</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kjl3q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kjl3q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kjl3q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kjl3q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kjl3q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kjl3q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kjl3q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kjl3q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kjl3q:0" aria-labelledby="tab:R4kjl3q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Restore <span class="token punctuation">\</span>
  query_file_info <span class="token punctuation">\</span>
  <span class="token assign-left variable">path</span><span class="token operator">=</span><span class="token string">'/public_html/index.php'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kjl3q:1" aria-labelledby="tab:R4kjl3q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kjl3q:2" aria-labelledby="tab:R4kjl3q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kjl3q:3" aria-labelledby="tab:R4kjl3q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sjl3q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sjl3q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sjl3q:0" aria-labelledby="tab:R4sjl3q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;query_file_info&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Restore&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"backupDate"</span>: <span class="token string">&quot;2020-07-01&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"backupID"</span>: <span class="token string">&quot;weekly/2017-07-01&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"backupType"</span>: <span class="token string">&quot;compressed&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"exists"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"fileSize"</span>: <span class="token number">199</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mtime"</span>: <span class="token number">1520043240</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/public_html/index.php&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;file&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/File-Restoration/operation/restore_file" data-section-id="tag/File-Restoration/operation/restore_file" class="sc-dntaoT ceciOs"><div data-section-id="operation/restore_file" id="operation/restore_file" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/File-Restoration/operation/restore_file" aria-label="tag/File-Restoration/operation/restore_file"></a>Restore file or directory </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function restores a file or directory from a backup to the file or directory&amp;#39;s original location.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles#roles&quot;&gt;File Storage role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function restores a file or directory from a backup to the file or directory&#39;s original location.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles#roles">File Storage role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="backupID" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand backupID"><span class="property-name">backupID</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or string or string or string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">backupID=weekly/2017-07-03</span></div><div><div html="&lt;p&gt;The backup&amp;#39;s identification.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;YYYY-MM-DD&lt;/code&gt; — Restore a daily backup from the specified backup date.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;incremental&lt;/code&gt; — Restore a daily incremental backup.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;weekly/YYYY-MM-DD&lt;/code&gt; — Restore a weekly backup from the specified backup date.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;monthly/YYYY-MM-DD&lt;/code&gt; — Restore a monthly backup from the specified backup date.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;weekly/incremental&lt;/code&gt; — Restore a weekly incremental backup.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;monthly/incremental&lt;/code&gt; — Restore a monthly incremental backup.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The backup&#39;s identification.</p>
<ul>
<li><code>YYYY-MM-DD</code> — Restore a daily backup from the specified backup date.</li>
<li><code>incremental</code> — Restore a daily incremental backup.</li>
<li><code>weekly/YYYY-MM-DD</code> — Restore a weekly backup from the specified backup date.</li>
<li><code>monthly/YYYY-MM-DD</code> — Restore a monthly backup from the specified backup date.</li>
<li><code>weekly/incremental</code> — Restore a weekly incremental backup.</li>
<li><code>monthly/incremental</code> — Restore a monthly incremental backup.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="overwrite" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">overwrite</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">overwrite=1</span></div><div><div html="&lt;p&gt;Whether to overwrite the file or directory on the disc with its backup replacement.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Overwrite the file or directory.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Do &lt;strong&gt;not&lt;/strong&gt; overwrite the file or directory.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to overwrite the file or directory on the disc with its backup replacement.</p>
<ul>
<li><code>1</code> — Overwrite the file or directory.</li>
<li><code>0</code> — Do <strong>not</strong> overwrite the file or directory.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="path" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">path</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">path=/public_html/index.php</span></div><div><div html="&lt;p&gt;The absolute file or directory&amp;#39;s path, within a backup, that you wish to restore.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;The value of this parameter &lt;strong&gt;must&lt;/strong&gt; begin with a forward slash (/).&lt;/li&gt;
&lt;li&gt;You &lt;strong&gt;must&lt;/strong&gt; parse filenames properly to prevent a cross-site scripting (XSS) attack.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The absolute file or directory&#39;s path, within a backup, that you wish to restore.</p>
<p><strong>Important:</strong></p>
<ul>
<li>The value of this parameter <strong>must</strong> begin with a forward slash (/).</li>
<li>You <strong>must</strong> parse filenames properly to prevent a cross-site scripting (XSS) attack.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Restore/restore_file</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Restore/restore_file</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kkl3q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kkl3q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kkl3q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kkl3q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kkl3q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kkl3q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kkl3q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kkl3q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kkl3q:0" aria-labelledby="tab:R4kkl3q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Restore <span class="token punctuation">\</span>
  restore_file <span class="token punctuation">\</span>
  <span class="token assign-left variable">backupID</span><span class="token operator">=</span><span class="token string">'weekly/2017-07-03'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">path</span><span class="token operator">=</span><span class="token string">'/public_html/index.php'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">overwrite</span><span class="token operator">=</span><span class="token string">'1'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kkl3q:1" aria-labelledby="tab:R4kkl3q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kkl3q:2" aria-labelledby="tab:R4kkl3q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kkl3q:3" aria-labelledby="tab:R4kkl3q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4skl3q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4skl3q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4skl3q:0" aria-labelledby="tab:R4skl3q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;restore_file&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Restore&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"success"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/File-Restoration/operation/restore_databases" data-section-id="tag/File-Restoration/operation/restore_databases" class="sc-dntaoT ceciOs"><div data-section-id="operation/restore_databases" id="operation/restore_databases" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/File-Restoration/operation/restore_databases" aria-label="tag/File-Restoration/operation/restore_databases"></a>Restore databases </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function restores a database&amp;#39;s backup files.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When the &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;MySQL Client role&lt;/a&gt; is disabled, the system also &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You &lt;strong&gt;must&lt;/strong&gt; pass either the &lt;code&gt;file&lt;/code&gt; &lt;strong&gt;or&lt;/strong&gt; &lt;code&gt;backup&lt;/code&gt; parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function restores a database&#39;s backup files.</p>
<p><strong>Important:</strong></p>
<p>When the <a href="https://go.cpanel.net/howtouseserverprofiles#roles">MySQL Client role</a> is disabled, the system also <strong>disables</strong> this function.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> pass either the <code>file</code> <strong>or</strong> <code>backup</code> parameter.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="backup" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">backup</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">backup=backup-1=home/user/user_db1.sql.gz backup-2=home/user/user_db2.sql.gz backup-3=home/user/user_db3.sql.gz</span> - Restore multiple database backup files.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">backup=home/user/user_db1.sql.gz</span> - Restore a single database backup file.</li></ul><div><div html="&lt;p&gt;The database backup file to restore.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Only&lt;/strong&gt; pass this parameter to restore files already on the server.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To restore multiple database backup files, increment the parameter name. For example: &lt;code&gt;backup-1&lt;/code&gt;, &lt;code&gt;backup-2&lt;/code&gt;, and &lt;code&gt;backup-3&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database backup file to restore.</p>
<p><strong>Important:</strong></p>
<p><strong>Only</strong> pass this parameter to restore files already on the server.</p>
<p><strong>Note:</strong></p>
<p>To restore multiple database backup files, increment the parameter name. For example: <code>backup-1</code>, <code>backup-2</code>, and <code>backup-3</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="timeout" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">timeout</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= 0 </span></span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">7200</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">timeout=3600</span></div><div><div html="&lt;p&gt;The maximum number of seconds to try to restore the file.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - The system will not time out the file restoration.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum number of seconds to try to restore the file.</p>
<ul>
<li><code>0</code> - The system will not time out the file restoration.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="verbose" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">verbose</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">verbose=1</span></div><div><div html="&lt;p&gt;Whether to return additional information from the &lt;code&gt;/usr/local/cpanel/logs/cpbackup&lt;/code&gt; log file.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Return additional information.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Do &lt;strong&gt;not&lt;/strong&gt; return additional information.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to return additional information from the <code>/usr/local/cpanel/logs/cpbackup</code> log file.</p>
<ul>
<li><code>1</code> - Return additional information.</li>
<li><code>0</code> - Do <strong>not</strong> return additional information.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-dpBQxM eJAAZj">Request Body schema: <span class="sc-dhCplO khtVmz">multipart/form-data</span></h5><div html="&lt;p&gt;The database backup file to upload and restore.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;strong&gt;Only&lt;/strong&gt; pass this parameter to upload files that don&amp;#39;t already exist on the server.&lt;/li&gt;
&lt;li&gt;You can &lt;strong&gt;not&lt;/strong&gt; pass this parameter on the command line.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;To upload multiple database backup files, increment the parameter name. For example: &lt;code&gt;file-1&lt;/code&gt;, &lt;code&gt;file-2&lt;/code&gt;, and &lt;code&gt;file-3&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;Pass this file in a multipart/form-data structure.&lt;/li&gt;
&lt;li&gt;For more information about this structure, read Mozilla&amp;#39;s &lt;a href=&quot;https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST&quot;&gt;POST Method&lt;/a&gt; documentation.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>The database backup file to upload and restore.</p>
<p><strong>Important:</strong></p>
<ul>
<li><strong>Only</strong> pass this parameter to upload files that don&#39;t already exist on the server.</li>
<li>You can <strong>not</strong> pass this parameter on the command line.</li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li>To upload multiple database backup files, increment the parameter name. For example: <code>file-1</code>, <code>file-2</code>, and <code>file-3</code>.</li>
<li>Pass this file in a multipart/form-data structure.</li>
<li>For more information about this structure, read Mozilla&#39;s <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST">POST Method</a> documentation.</li>
</ul>
</div><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="file" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">file</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;binary&gt; </span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="post" class="sc-txhaY dCeVuA http-verb post">post</span><span class="sc-etPtWW iqHzp">/Backup/restore_databases</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Backup/restore_databases</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kll3q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kll3q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kll3q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kll3q:1" data-rttab="true">HTTP Request (Wire Format)</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kll3q:0" aria-labelledby="tab:R4kll3q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--input</span><span class="token operator">=</span>json <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Backup <span class="token punctuation">\</span>
  restore_databases
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kll3q:1" aria-labelledby="tab:R4kll3q:1"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sll3q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sll3q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sll3q:0" aria-labelledby="tab:R4sll3q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;restore_databases&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Backup&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"log_id"</span>: <span class="token string">&quot;2019-08-13T15:10:07Z.1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"log_path"</span>: <span class="token string">&quot;/home/cptest/logs/restoredb/2019-08-13T15:10:07Z.1.log&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;The system successfully restored the database 'user_db1' from the backup file 'user_db1.sql.gz'&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/File-Restoration/operation/restore_email_forwarders" data-section-id="tag/File-Restoration/operation/restore_email_forwarders" class="sc-dntaoT ceciOs"><div data-section-id="operation/restore_email_forwarders" id="operation/restore_email_forwarders" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/File-Restoration/operation/restore_email_forwarders" aria-label="tag/File-Restoration/operation/restore_email_forwarders"></a>Restore email forwarders </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function restores an account&amp;#39;s email forwarders.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When the &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;Receive Mail role&lt;/a&gt; is disabled, the system also &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You &lt;strong&gt;must&lt;/strong&gt; use the &lt;code&gt;backup&lt;/code&gt; parameter when you call this function in one of the following formats:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;As part of a &lt;code&gt;multipart/form-data&lt;/code&gt; request body to upload and restore a backup file to the server. For more information about this structure, read Mozilla&amp;#39;s &lt;a href=&quot;https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST&quot;&gt;POST Method&lt;/a&gt; documentation.&lt;/li&gt;
&lt;li&gt;As a query parameter to restore an existing file on the server.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function restores an account&#39;s email forwarders.</p>
<p><strong>Important:</strong></p>
<p>When the <a href="https://go.cpanel.net/howtouseserverprofiles#roles">Receive Mail role</a> is disabled, the system also <strong>disables</strong> this function.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> use the <code>backup</code> parameter when you call this function in one of the following formats:</p>
<ul>
<li>As part of a <code>multipart/form-data</code> request body to upload and restore a backup file to the server. For more information about this structure, read Mozilla&#39;s <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST">POST Method</a> documentation.</li>
<li>As a query parameter to restore an existing file on the server.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="backup" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">backup</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">backup=backup-1=/home/user/aliases-example1.com.gz backup-2=/home/user/aliases-example2.com.gz backup-3=/home/user/aliases-example3.com.gz</span> - Restore multiple email forwarder files.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">backup=/home/user/aliases-example.com.gz</span> - Restore a single email forwarder file.</li></ul><div><div html="&lt;p&gt;The email forwarder file to restore.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Only&lt;/strong&gt; pass this parameter to restore email forwarder files that already exist on the server.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To restore multiple email filter files, increment the parameter name. For example: &lt;code&gt;backup-1&lt;/code&gt;, &lt;code&gt;backup-2&lt;/code&gt;, and &lt;code&gt;backup-3&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email forwarder file to restore.</p>
<p><strong>Important:</strong></p>
<p><strong>Only</strong> pass this parameter to restore email forwarder files that already exist on the server.</p>
<p><strong>Note:</strong></p>
<p>To restore multiple email filter files, increment the parameter name. For example: <code>backup-1</code>, <code>backup-2</code>, and <code>backup-3</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="timeout" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">timeout</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= 0 </span></span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">7200</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">timeout=3600</span></div><div><div html="&lt;p&gt;The maximum number of seconds to try to restore the file.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - The system will not time out the file restoration.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum number of seconds to try to restore the file.</p>
<ul>
<li><code>0</code> - The system will not time out the file restoration.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="verbose" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">verbose</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">verbose=1</span></div><div><div html="&lt;p&gt;Whether to return additional information from the &lt;code&gt;/home/cpuser/.cpanel/logs/restore-email-forwarders&lt;/code&gt; log files.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Return additional information.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Do not return additional information.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to return additional information from the <code>/home/cpuser/.cpanel/logs/restore-email-forwarders</code> log files.</p>
<ul>
<li><code>1</code> - Return additional information.</li>
<li><code>0</code> - Do not return additional information.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-dpBQxM eJAAZj">Request Body schema: <span class="sc-dhCplO khtVmz">multipart/form-data</span></h5><div html="&lt;p&gt;The email forwarder file to upload and restore.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;strong&gt;Only&lt;/strong&gt; pass this parameter to upload files that don&amp;#39;t already exist on the server.&lt;/li&gt;
&lt;li&gt;You can&amp;#39;t pass this parameter on the command line.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To upload multiple email filter files, increment the parameter name. For example: &lt;code&gt;backup-1&lt;/code&gt;, &lt;code&gt;backup-2&lt;/code&gt;, and &lt;code&gt;backup-3&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>The email forwarder file to upload and restore.</p>
<p><strong>Important:</strong></p>
<ul>
<li><strong>Only</strong> pass this parameter to upload files that don&#39;t already exist on the server.</li>
<li>You can&#39;t pass this parameter on the command line.</li>
</ul>
<p><strong>Note:</strong></p>
<p>To upload multiple email filter files, increment the parameter name. For example: <code>backup-1</code>, <code>backup-2</code>, and <code>backup-3</code>.</p>
</div><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="backup" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">backup</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;binary&gt; </span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="post" class="sc-txhaY dCeVuA http-verb post">post</span><span class="sc-etPtWW iqHzp">/Backup/restore_email_forwarders</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Backup/restore_email_forwarders</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kml3q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kml3q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kml3q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kml3q:1" data-rttab="true">HTTP Request (Wire Format)</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kml3q:0" aria-labelledby="tab:R4kml3q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--input</span><span class="token operator">=</span>json <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Backup <span class="token punctuation">\</span>
  restore_email_forwarders
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kml3q:1" aria-labelledby="tab:R4kml3q:1"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sml3q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sml3q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sml3q:0" aria-labelledby="tab:R4sml3q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;restore_email_forwarders&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Backup&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"log_id"</span>: <span class="token string">&quot;2019-08-13T15:10:07Z.1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"log_path"</span>: <span class="token string">&quot;/home/cpuser/.cpanel/logs/restore-email-forwarders/2019-09-11T18:30:49Z.1.log&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;The system successfully restored the email forwarders from the 'aliases-example.com.gz' backup.&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/File-Restoration/operation/restore_email_filters" data-section-id="tag/File-Restoration/operation/restore_email_filters" class="sc-dntaoT ceciOs"><div data-section-id="operation/restore_email_filters" id="operation/restore_email_filters" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/File-Restoration/operation/restore_email_filters" aria-label="tag/File-Restoration/operation/restore_email_filters"></a>Restore email filters </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function restores an account&amp;#39;s email filters.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When the &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;Receive Mail role&lt;/a&gt; is disabled, the system also &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You &lt;strong&gt;must&lt;/strong&gt; use the &lt;code&gt;backup&lt;/code&gt; parameter when you call this function in one of the following formats:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;As part of a &lt;code&gt;multipart/form-data&lt;/code&gt; request body to upload and restore a backup file to the server.&lt;/li&gt;
&lt;li&gt;As a query parameter to restore an existing file on the server.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function restores an account&#39;s email filters.</p>
<p><strong>Important:</strong></p>
<p>When the <a href="https://go.cpanel.net/howtouseserverprofiles#roles">Receive Mail role</a> is disabled, the system also <strong>disables</strong> this function.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> use the <code>backup</code> parameter when you call this function in one of the following formats:</p>
<ul>
<li>As part of a <code>multipart/form-data</code> request body to upload and restore a backup file to the server.</li>
<li>As a query parameter to restore an existing file on the server.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="backup" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">backup</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">backup=backup-1=/home/user/filter_info1.username.yaml.gz backup-2=/home/user/filter_info2.username.yaml.gz backup-3=/home/user/filter_info3.username.yaml.gz</span> - Restore multiple email filter files.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">backup=/home/user/filter_info.username.yaml.gz</span> - Restore a single email filter file.</li></ul><div><div html="&lt;p&gt;The email filter file to restore.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Only&lt;/strong&gt; pass this parameter to restore email filter files that already exist on the server.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To restore multiple email filter files, increment the parameter name. For example: &lt;code&gt;backup-1&lt;/code&gt;, &lt;code&gt;backup-2&lt;/code&gt;, and &lt;code&gt;backup-3&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email filter file to restore.</p>
<p><strong>Important:</strong></p>
<p><strong>Only</strong> pass this parameter to restore email filter files that already exist on the server.</p>
<p><strong>Note:</strong></p>
<p>To restore multiple email filter files, increment the parameter name. For example: <code>backup-1</code>, <code>backup-2</code>, and <code>backup-3</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="timeout" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">timeout</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= 0 </span></span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">7200</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">timeout=3600</span></div><div><div html="&lt;p&gt;The maximum number of seconds to try to restore the file.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - The system will not time out the file restoration.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum number of seconds to try to restore the file.</p>
<ul>
<li><code>0</code> - The system will not time out the file restoration.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="verbose" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">verbose</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">verbose=1</span></div><div><div html="&lt;p&gt;Whether to return additional information from the &lt;code&gt;/home/cpuser/.cpanel/logs/restore-email-filters&lt;/code&gt; log files.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Return additional information.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Do not return additional information.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to return additional information from the <code>/home/cpuser/.cpanel/logs/restore-email-filters</code> log files.</p>
<ul>
<li><code>1</code> - Return additional information.</li>
<li><code>0</code> - Do not return additional information.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-dpBQxM eJAAZj">Request Body schema: <span class="sc-dhCplO khtVmz">multipart/form-data</span></h5><div html="&lt;p&gt;The email filter file to upload and restore.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;strong&gt;Only&lt;/strong&gt; pass this parameter to upload files that don&amp;#39;t already exist on the server.&lt;/li&gt;
&lt;li&gt;You can&amp;#39;t pass this parameter on the command line.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;To upload multiple email filter files, increment the parameter name. For example: &lt;code&gt;backup-1&lt;/code&gt;, &lt;code&gt;backup-2&lt;/code&gt;, and &lt;code&gt;backup-3&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;Pass this file in a multipart/form-data structure.&lt;/li&gt;
&lt;li&gt;For more information about this structure, read Mozilla&amp;#39;s &lt;a href=&quot;https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST&quot;&gt;POST Method&lt;/a&gt; documentation.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>The email filter file to upload and restore.</p>
<p><strong>Important:</strong></p>
<ul>
<li><strong>Only</strong> pass this parameter to upload files that don&#39;t already exist on the server.</li>
<li>You can&#39;t pass this parameter on the command line.</li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li>To upload multiple email filter files, increment the parameter name. For example: <code>backup-1</code>, <code>backup-2</code>, and <code>backup-3</code>.</li>
<li>Pass this file in a multipart/form-data structure.</li>
<li>For more information about this structure, read Mozilla&#39;s <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST">POST Method</a> documentation.</li>
</ul>
</div><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="backup" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">backup</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;binary&gt; </span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="post" class="sc-txhaY dCeVuA http-verb post">post</span><span class="sc-etPtWW iqHzp">/Backup/restore_email_filters</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Backup/restore_email_filters</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4knl3q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4knl3q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4knl3q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4knl3q:1" data-rttab="true">HTTP Request (Wire Format)</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4knl3q:0" aria-labelledby="tab:R4knl3q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--input</span><span class="token operator">=</span>json <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Backup <span class="token punctuation">\</span>
  restore_email_filters
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4knl3q:1" aria-labelledby="tab:R4knl3q:1"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4snl3q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4snl3q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4snl3q:0" aria-labelledby="tab:R4snl3q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;restore_email_filters&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Backup&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"log_id"</span>: <span class="token string">&quot;2019-08-13T15:10:07Z.1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"log_path"</span>: <span class="token string">&quot;/home/cpuser/.cpanel/logs/restore-email-filters/2019-09-11T18:30:49Z.1.log&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;The system successfully restored the email filters from the 'filter-info.user.yaml.gz' backup.&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/File-Restoration/operation/restore_files" data-section-id="tag/File-Restoration/operation/restore_files" class="sc-dntaoT ceciOs"><div data-section-id="operation/restore_files" id="operation/restore_files" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/File-Restoration/operation/restore_files" aria-label="tag/File-Restoration/operation/restore_files"></a>Restore files </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function restores an account&amp;#39;s files.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When the &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;File Storage role&lt;/a&gt; is disabled, the system also &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You &lt;strong&gt;must&lt;/strong&gt; use the &lt;code&gt;backup&lt;/code&gt; parameter when you call this function in one of the following formats:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;As part of a &lt;code&gt;multipart/form-data&lt;/code&gt; request body to upload and restore a backup file to the server. For more information about this structure, read Mozilla&amp;#39;s &lt;a href=&quot;https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST&quot;&gt;POST Method&lt;/a&gt; documentation.&lt;/li&gt;
&lt;li&gt;As a query parameter to restore an existing file on the server.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function restores an account&#39;s files.</p>
<p><strong>Important:</strong></p>
<p>When the <a href="https://go.cpanel.net/howtouseserverprofiles#roles">File Storage role</a> is disabled, the system also <strong>disables</strong> this function.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> use the <code>backup</code> parameter when you call this function in one of the following formats:</p>
<ul>
<li>As part of a <code>multipart/form-data</code> request body to upload and restore a backup file to the server. For more information about this structure, read Mozilla&#39;s <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST">POST Method</a> documentation.</li>
<li>As a query parameter to restore an existing file on the server.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="backup" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">backup</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">backup=backup-1=/home/cpuser/backup-cpuser.tld-9-10-2019_1.tar.gz backup-2=/home/cpuser/backup-cpuser.tld-9-10-2019_2.tar.gz</span> - Restore multiple backup files.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">backup=/home/cpuser/backup-cpuser.tld-9-10-2019_1.tar.gz</span> - Restore a single backup file.</li></ul><div><div html="&lt;p&gt;The backup file to restore.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Only&lt;/strong&gt; pass this parameter to restore backup files that already exist on the server.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To restore multiple backup files, increment the parameter name. For example: &lt;code&gt;backup-1&lt;/code&gt;, &lt;code&gt;backup-2&lt;/code&gt;, and &lt;code&gt;backup-3&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The backup file to restore.</p>
<p><strong>Important:</strong></p>
<p><strong>Only</strong> pass this parameter to restore backup files that already exist on the server.</p>
<p><strong>Note:</strong></p>
<p>To restore multiple backup files, increment the parameter name. For example: <code>backup-1</code>, <code>backup-2</code>, and <code>backup-3</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="directory" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">directory</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">directory=/home/user/example</span></div><div><div html="&lt;p&gt;The directory to which to restore the file. The default is the user&amp;#39;s &lt;code&gt;home&lt;/code&gt; directory.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The directory to which to restore the file. The default is the user&#39;s <code>home</code> directory.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="timeout" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">timeout</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= 0 </span></span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">172800</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">timeout=7200</span></div><div><div html="&lt;p&gt;The maximum number of seconds to try to restore the file.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - The system will not time out the file restoration.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum number of seconds to try to restore the file.</p>
<ul>
<li><code>0</code> - The system will not time out the file restoration.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="verbose" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">verbose</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">verbose=1</span></div><div><div html="&lt;p&gt;Whether to return additional information from the &lt;code&gt;/home/cptest/.cpanel/logs/restorefiles&lt;/code&gt; log files.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Return additional information.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Do not return additional information.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to return additional information from the <code>/home/cptest/.cpanel/logs/restorefiles</code> log files.</p>
<ul>
<li><code>1</code> - Return additional information.</li>
<li><code>0</code> - Do not return additional information.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-dpBQxM eJAAZj">Request Body schema: <span class="sc-dhCplO khtVmz">multipart/form-data</span></h5><div html="&lt;p&gt;The backup file to upload and restore.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;strong&gt;Only&lt;/strong&gt; pass this parameter to upload files that don&amp;#39;t already exist on the server.&lt;/li&gt;
&lt;li&gt;You can&amp;#39;t pass this parameter on the command line.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To upload and restore multiple backup files, increment the parameter name. For example: &lt;code&gt;backup-1&lt;/code&gt;, &lt;code&gt;backup-2&lt;/code&gt;, and &lt;code&gt;backup-3&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>The backup file to upload and restore.</p>
<p><strong>Important:</strong></p>
<ul>
<li><strong>Only</strong> pass this parameter to upload files that don&#39;t already exist on the server.</li>
<li>You can&#39;t pass this parameter on the command line.</li>
</ul>
<p><strong>Note:</strong></p>
<p>To upload and restore multiple backup files, increment the parameter name. For example: <code>backup-1</code>, <code>backup-2</code>, and <code>backup-3</code>.</p>
</div><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="backup" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">backup</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;binary&gt; </span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="post" class="sc-txhaY dCeVuA http-verb post">post</span><span class="sc-etPtWW iqHzp">/Backup/restore_files</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Backup/restore_files</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kol3q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kol3q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kol3q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kol3q:1" data-rttab="true">HTTP Request (Wire Format)</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kol3q:0" aria-labelledby="tab:R4kol3q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--input</span><span class="token operator">=</span>json <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Backup <span class="token punctuation">\</span>
  restore_files
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kol3q:1" aria-labelledby="tab:R4kol3q:1"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sol3q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sol3q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sol3q:0" aria-labelledby="tab:R4sol3q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;restore_files&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Backup&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"log_id"</span>: <span class="token string">&quot;2019-08-13T15:10:07Z.1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"log_path"</span>: <span class="token string">&quot;/home/cptest/.cpanel/logs/restorefiles/2019-08-13T15:10:07Z.1.log&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;The system successfully restored the directory /home/cpuser/point2 from the backup file backup-cpuser.tld-9-10-2019_1.tar.gz&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Application-Information" data-section-id="tag/Application-Information" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Application-Information" aria-label="tag/Application-Information"></a>Application Information</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;cPanel Theme Management / Application Information&lt;/p&gt;
"><p>cPanel Theme Management / Application Information</p>
</div></div></div><div id="tag/Application-Information/operation/get_applications" data-section-id="tag/Application-Information/operation/get_applications" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_applications" id="operation/get_applications" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Application-Information/operation/get_applications" aria-label="tag/Application-Information/operation/get_applications"></a>Return multiple apps&#x27; info from dynamicui.conf </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves an application&amp;#39;s information from a specific theme&amp;#39;s &lt;code&gt;dynamicui.conf&lt;/code&gt; file.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves an application&#39;s information from a specific theme&#39;s <code>dynamicui.conf</code> file.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="app_keys" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">app_keys</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">app_keys=addon_domains,ftp_accounts,anonymous_ftp</span></div><div><div html="&lt;p&gt;A comma-separated list of an application feature names. If you do not specify this parameter,
the output will include all of the applications that the &lt;code&gt;dynamicui.conf&lt;/code&gt; file contains.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;This value must match an application&amp;#39;s &lt;code&gt;feature&lt;/code&gt; value in the &lt;code&gt;dynamicui.conf&lt;/code&gt; file.&lt;/li&gt;
&lt;li&gt;For more information, read our &lt;a href=&quot;https://go.cpanel.net/appkey&quot;&gt;Guide to cPanel Interface Customization - Appkeys&lt;/a&gt; documentation.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A comma-separated list of an application feature names. If you do not specify this parameter,
the output will include all of the applications that the <code>dynamicui.conf</code> file contains.</p>
<p><strong>Note:</strong></p>
<ul>
<li>This value must match an application&#39;s <code>feature</code> value in the <code>dynamicui.conf</code> file.</li>
<li>For more information, read our <a href="https://go.cpanel.net/appkey">Guide to cPanel Interface Customization - Appkeys</a> documentation.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Branding/get_applications</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Branding/get_applications</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kj34a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kj34a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kj34a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj34a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kj34a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj34a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kj34a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj34a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kj34a:0" aria-labelledby="tab:R4kj34a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Branding <span class="token punctuation">\</span>
  get_applications
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj34a:1" aria-labelledby="tab:R4kj34a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj34a:2" aria-labelledby="tab:R4kj34a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj34a:3" aria-labelledby="tab:R4kj34a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sj34a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sj34a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sj34a:0" aria-labelledby="tab:R4sj34a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_applications&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Branding&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"addon_domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"acontent"</span>: <span class="token string">&quot;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"base64_png_image"</span>: <span class="token string">&quot;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"feature"</span>: <span class="token string">&quot;addondomains&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file"</span>: <span class="token string">&quot;addon_domains&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group"</span>: <span class="token string">&quot;domains&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"height"</span>: <span class="token string">&quot;48&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"if"</span>: <span class="token string">&quot;$HASROLE{'WebServer'}&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"imgtype"</span>: <span class="token string">&quot;icon&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"implements"</span>: <span class="token string">&quot;Domains_AddonDomains&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"itemdesc"</span>: <span class="token string">&quot;Addon Domains&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"itemorder"</span>: <span class="token string">&quot;3&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">&quot;addon_domains&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"onclick"</span>: <span class="token string">&quot;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"plainitemdesc"</span>: <span class="token string">&quot;Addon Domains&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchtext"</span>: <span class="token string">&quot;Domains Addon domain Addon Domains&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subtype"</span>: <span class="token string">&quot;img&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"target"</span>: <span class="token string">&quot;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;image&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">&quot;addon/index.html&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"width"</span>: <span class="token string">&quot;48&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"anonymous_ftp"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"acontent"</span>: <span class="token string">&quot;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"base64_png_image"</span>: <span class="token string">&quot;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"feature"</span>: <span class="token string">&quot;ftpaccts&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file"</span>: <span class="token string">&quot;anonymous_ftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group"</span>: <span class="token string">&quot;files&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"height"</span>: <span class="token string">&quot;48&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"if"</span>: <span class="token string">&quot;$SERVICEPROVIDED{'ftp'} &amp;&amp; $hasanonftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"imgtype"</span>: <span class="token string">&quot;icon&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"itemdesc"</span>: <span class="token string">&quot;Anonymous FTP&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"itemorder"</span>: <span class="token string">&quot;8&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">&quot;anonymous_ftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"onclick"</span>: <span class="token string">&quot;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"plainitemdesc"</span>: <span class="token string">&quot;Anonymous FTP&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchtext"</span>: <span class="token string">&quot;Anonymous FTP anonymousftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subtype"</span>: <span class="token string">&quot;img&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"target"</span>: <span class="token string">&quot;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"touch"</span>: <span class="token string">&quot;ftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;image&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">&quot;ftp/anonymous.html&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"width"</span>: <span class="token string">&quot;48&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ftp_accounts"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"acontent"</span>: <span class="token string">&quot;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"base64_png_image"</span>: <span class="token string">&quot;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"feature"</span>: <span class="token string">&quot;ftpaccts&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file"</span>: <span class="token string">&quot;ftp_accounts&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group"</span>: <span class="token string">&quot;files&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"height"</span>: <span class="token string">&quot;48&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"if"</span>: <span class="token string">&quot;$SERVICEPROVIDED{'ftp'}&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"imgtype"</span>: <span class="token string">&quot;icon&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"itemdesc"</span>: <span class="token string">&quot;FTP Accounts&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"itemorder"</span>: <span class="token string">&quot;6&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">&quot;ftp_accounts&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"onclick"</span>: <span class="token string">&quot;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"plainitemdesc"</span>: <span class="token string">&quot;FTP Accounts&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchtext"</span>: <span class="token string">&quot;FTP Accounts ftp create&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subtype"</span>: <span class="token string">&quot;img&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"target"</span>: <span class="token string">&quot;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"touch"</span>: <span class="token string">&quot;ftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;image&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">&quot;ftp/accounts.html&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"width"</span>: <span class="token string">&quot;48&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Application-Information/operation/get_available_applications" data-section-id="tag/Application-Information/operation/get_available_applications" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_available_applications" id="operation/get_available_applications" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Application-Information/operation/get_available_applications" aria-label="tag/Application-Information/operation/get_available_applications"></a>Return current user&#x27;s cPanel application details </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves information about the groups and applications in the authenticated user&amp;#39;s cPanel interface.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves information about the groups and applications in the authenticated user&#39;s cPanel interface.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="nvarglist" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">nvarglist</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">nvarglist=pref|software|domains</span></div><div><div html="&lt;p&gt;A pipe-separated list of group names denoting the order in which to sort the
groups. If you do not supply a value, the function does not sort the groups.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;&lt;code&gt;arglist&lt;/code&gt; is an alias for this parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A pipe-separated list of group names denoting the order in which to sort the
groups. If you do not supply a value, the function does not sort the groups.</p>
<p><strong>Note:</strong></p>
<p><code>arglist</code> is an alias for this parameter.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Branding/get_available_applications</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Branding/get_available_applications</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kl34a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kl34a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kl34a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl34a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kl34a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl34a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kl34a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl34a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kl34a:0" aria-labelledby="tab:R4kl34a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Branding <span class="token punctuation">\</span>
  get_available_applications
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl34a:1" aria-labelledby="tab:R4kl34a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl34a:2" aria-labelledby="tab:R4kl34a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl34a:3" aria-labelledby="tab:R4kl34a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sl34a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sl34a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sl34a:0" aria-labelledby="tab:R4sl34a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_available_applications&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Branding&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"default_group_order"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"advanced"</span>: <span class="token number">7</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"databases"</span>: <span class="token number">2</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domains"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token number">4</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"files"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metrics"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"preferences"</span>: <span class="token number">8</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sample_apps"</span>: <span class="token number">9</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"security"</span>: <span class="token number">6</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"software"</span>: <span class="token number">6</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"grouporder"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;files&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;databases&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;domains&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;email&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;metrics&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;security&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;software&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;advanced&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;preferences&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;pref&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"groups"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"desc"</span>: <span class="token string">&quot;Files&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group"</span>: <span class="token string">&quot;files&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"items"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"acontent"</span>: <span class="token string">&quot;target=\&quot;file_manager\&quot;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"base64_png_image"</span>: <span class="token string">&quot;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"feature"</span>: <span class="token string">&quot;filemanager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file"</span>: <span class="token string">&quot;file_manager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group"</span>: <span class="token string">&quot;files&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"height"</span>: <span class="token string">&quot;48&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"if"</span>: <span class="token string">&quot;$HASROLE{'FileStorage'}&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"imgtype"</span>: <span class="token string">&quot;icon&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"implements"</span>: <span class="token string">&quot;FileManager_Home&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"itemdesc"</span>: <span class="token string">&quot;File Manager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"itemorder"</span>: <span class="token string">&quot;1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">&quot;file_manager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"onclick"</span>: <span class="token string">&quot;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"plainitemdesc"</span>: <span class="token string">&quot;File Manager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchtext"</span>: <span class="token string">&quot;File Manager file-manager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subtype"</span>: <span class="token string">&quot;img&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"target"</span>: <span class="token string">&quot;file_manager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;image&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">&quot;filemanager/index.html&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"width"</span>: <span class="token string">&quot;48&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"implements"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"API_Tokens_Manager"</span>: <span class="token string">&quot;api_tokens&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Backups_Home"</span>: <span class="token string">&quot;backup&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Calendar_Configure"</span>: <span class="token string">&quot;calendar_and_contacts&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ContactInfo_Change"</span>: <span class="token string">&quot;contact_information&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Cron_Home"</span>: <span class="token string">&quot;cron_jobs&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Database_MySQL"</span>: <span class="token string">&quot;mysql_databases&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Database_phpMyAdmin"</span>: <span class="token string">&quot;php_my_admin&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Domains_AddonDomains"</span>: <span class="token string">&quot;addon_domains&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Domains_SubDomains"</span>: <span class="token string">&quot;subdomains&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_AccountLevelFiltering"</span>: <span class="token string">&quot;global_email_filters&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_Accounts"</span>: <span class="token string">&quot;email_accounts&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_Authentication"</span>: <span class="token string">&quot;email_deliverability&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_AutoResponders"</span>: <span class="token string">&quot;autoresponders&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_BoxTrapper"</span>: <span class="token string">&quot;boxtrapper&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_DefaultAddress"</span>: <span class="token string">&quot;default_address&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_DeliveryReport"</span>: <span class="token string">&quot;track_delivery&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_Disk_Usage"</span>: <span class="token string">&quot;email_disk_usage&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_Forwarders"</span>: <span class="token string">&quot;forwarders&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_MailingLists"</span>: <span class="token string">&quot;mailing_lists&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_Routing"</span>: <span class="token string">&quot;email_routing&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_SpamFilter"</span>: <span class="token string">&quot;apache_spam_assassin&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Email_UserLevelFiltering"</span>: <span class="token string">&quot;email_filters&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"FileManager_Home"</span>: <span class="token string">&quot;file_manager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Locale_Change"</span>: <span class="token string">&quot;change_language&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Password_Change"</span>: <span class="token string">&quot;change_password&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"SSL_TLS_Manager"</span>: <span class="token string">&quot;ssl_tls&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"SSL_TLS_Status"</span>: <span class="token string">&quot;tls_status&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Site_Software"</span>: <span class="token string">&quot;site_software&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Stats_AWStats"</span>: <span class="token string">&quot;awstats&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"index"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"addon_domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">2</span>,</div></li><li><div class="hoverable "><span class="token number">2</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"address_importer"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">3</span>,</div></li><li><div class="hoverable "><span class="token number">10</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"aliases"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">2</span>,</div></li><li><div class="hoverable "><span class="token number">4</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"analog_stats"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">4</span>,</div></li><li><div class="hoverable "><span class="token number">5</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"apache_handlers"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">7</span>,</div></li><li><div class="hoverable "><span class="token number">5</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"apache_spam_assassin"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">3</span>,</div></li><li><div class="hoverable "><span class="token number">11</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"api_tokens"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">5</span>,</div></li><li><div class="hoverable "><span class="token number">3</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"autoresponders"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">3</span>,</div></li><li><div class="hoverable "><span class="token number">3</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"awstats"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">4</span>,</div></li><li><div class="hoverable "><span class="token number">4</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"backup"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">0</span>,</div></li><li><div class="hoverable "><span class="token number">5</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"backup_wizard"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">0</span>,</div></li><li><div class="hoverable "><span class="token number">6</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"bandwidth"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">4</span>,</div></li><li><div class="hoverable "><span class="token number">2</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"boxtrapper"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">3</span>,</div></li><li><div class="hoverable "><span class="token number">13</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"calendar_and_contacts"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">3</span>,</div></li><li><div class="hoverable "><span class="token number">14</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"change_language"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">8</span>,</div></li><li><div class="hoverable "><span class="token number">1</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"change_password"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">8</span>,</div></li><li><div class="hoverable "><span class="token number">0</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"change_style"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">8</span>,</div></li><li><div class="hoverable "><span class="token number">2</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"contact_information"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">8</span>,</div></li><li><div class="hoverable "><span class="token number">3</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cron_jobs"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">7</span>,</div></li><li><div class="hoverable "><span class="token number">1</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"default_address"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">3</span>,</div></li><li><div class="hoverable "><span class="token number">4</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"directory_privacy"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">0</span>,</div></li><li><div class="hoverable "><span class="token number">2</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"disk_usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">0</span>,</div></li><li><div class="hoverable "><span class="token number">3</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">2</span>,</div></li><li><div class="hoverable "><span class="token number">1</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email_accounts"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">3</span>,</div></li><li><div class="hoverable "><span class="token number">0</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email_deliverability"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">3</span>,</div></li><li><div class="hoverable "><span class="token number">9</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email_disk_usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">3</span>,</div></li><li><div class="hoverable "><span class="token number">15</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email_filters"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">3</span>,</div></li><li><div class="hoverable "><span class="token number">8</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email_routing"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">3</span>,</div></li><li><div class="hoverable "><span class="token number">2</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"encryption"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">3</span>,</div></li><li><div class="hoverable "><span class="token number">12</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error_pages"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">7</span>,</div></li><li><div class="hoverable "><span class="token number">4</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">4</span>,</div></li><li><div class="hoverable "><span class="token number">1</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file_manager"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">0</span>,</div></li><li><div class="hoverable "><span class="token number">0</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"forwarders"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">3</span>,</div></li><li><div class="hoverable "><span class="token number">1</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"global_email_filters"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">3</span>,</div></li><li><div class="hoverable "><span class="token number">7</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hotlink_protection"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">5</span>,</div></li><li><div class="hoverable "><span class="token number">4</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"images"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">0</span>,</div></li><li><div class="hoverable "><span class="token number">1</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"indexes"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">7</span>,</div></li><li><div class="hoverable "><span class="token number">3</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip_blocker"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">5</span>,</div></li><li><div class="hoverable "><span class="token number">1</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"leech_protection"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">5</span>,</div></li><li><div class="hoverable "><span class="token number">5</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mailing_lists"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">3</span>,</div></li><li><div class="hoverable "><span class="token number">5</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metrics_editor"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">4</span>,</div></li><li><div class="hoverable "><span class="token number">7</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mime_types"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">7</span>,</div></li><li><div class="hoverable "><span class="token number">6</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"multiphp_ini_editor"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">6</span>,</div></li><li><div class="hoverable "><span class="token number">5</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"multiphp_manager"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">6</span>,</div></li><li><div class="hoverable "><span class="token number">4</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_database_wizard"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">1</span>,</div></li><li><div class="hoverable "><span class="token number">2</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_databases"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">1</span>,</div></li><li><div class="hoverable "><span class="token number">1</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"optimize_website"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">6</span>,</div></li><li><div class="hoverable "><span class="token number">3</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"perl_modules"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">6</span>,</div></li><li><div class="hoverable "><span class="token number">1</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"php_my_admin"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">1</span>,</div></li><li><div class="hoverable "><span class="token number">0</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"php_pear_packages"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">6</span>,</div></li><li><div class="hoverable "><span class="token number">0</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"raw_access"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">4</span>,</div></li><li><div class="hoverable "><span class="token number">3</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"redirects"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">2</span>,</div></li><li><div class="hoverable "><span class="token number">5</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"remote_mysql"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">1</span>,</div></li><li><div class="hoverable "><span class="token number">3</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"site_publisher"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">2</span>,</div></li><li><div class="hoverable "><span class="token number">0</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"site_software"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">6</span>,</div></li><li><div class="hoverable "><span class="token number">2</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ssh_access"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">5</span>,</div></li><li><div class="hoverable "><span class="token number">0</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ssl_tls"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">5</span>,</div></li><li><div class="hoverable "><span class="token number">2</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subdomains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">2</span>,</div></li><li><div class="hoverable "><span class="token number">3</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"terminal"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">7</span>,</div></li><li><div class="hoverable "><span class="token number">0</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tls_status"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">5</span>,</div></li><li><div class="hoverable "><span class="token number">6</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"track_delivery"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">3</span>,</div></li><li><div class="hoverable "><span class="token number">6</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"track_dns"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">7</span>,</div></li><li><div class="hoverable "><span class="token number">2</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user_manager"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">8</span>,</div></li><li><div class="hoverable "><span class="token number">4</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version_control"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">0</span>,</div></li><li><div class="hoverable "><span class="token number">7</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"visitors"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">4</span>,</div></li><li><div class="hoverable "><span class="token number">0</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"web_disk"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">0</span>,</div></li><li><div class="hoverable "><span class="token number">4</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"webalizer"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">4</span>,</div></li><li><div class="hoverable "><span class="token number">6</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"zone_editor"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">2</span>,</div></li><li><div class="hoverable "><span class="token number">6</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Application-Information/operation/get_information_for_applications" data-section-id="tag/Application-Information/operation/get_information_for_applications" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_information_for_applications" id="operation/get_information_for_applications" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Application-Information/operation/get_information_for_applications" aria-label="tag/Application-Information/operation/get_information_for_applications"></a>Return app&#x27;s info from sitemap.json </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves an application&amp;#39;s information from a specific
theme&amp;#39;s &lt;code&gt;sitemap.json&lt;/code&gt; file.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves an application&#39;s information from a specific
theme&#39;s <code>sitemap.json</code> file.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="app_keys" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">app_keys</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">app_keys=email_filters</span></div><div><div html="&lt;p&gt;A comma-separated list of Appkey names. If you do &lt;strong&gt;not&lt;/strong&gt;
specify this parameter, the output will include all of the applications that the
&lt;code&gt;sitemap.json&lt;/code&gt; file contains.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This value &lt;strong&gt;must&lt;/strong&gt; match an application&amp;#39;s &lt;code&gt;key&lt;/code&gt; value in the &lt;code&gt;sitemap.json&lt;/code&gt; file.
For more information, read our
&lt;a href=&quot;https://go.cpanel.net/appkey&quot;&gt;Guide to cPanel Interface Customization - Appkeys&lt;/a&gt;
documentation.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A comma-separated list of Appkey names. If you do <strong>not</strong>
specify this parameter, the output will include all of the applications that the
<code>sitemap.json</code> file contains.</p>
<p><strong>Note:</strong></p>
<p>This value <strong>must</strong> match an application&#39;s <code>key</code> value in the <code>sitemap.json</code> file.
For more information, read our
<a href="https://go.cpanel.net/appkey">Guide to cPanel Interface Customization - Appkeys</a>
documentation.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="docroot" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">docroot</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">docroot=/usr/local/cpanel/base/webmail/jupiter</span></div><div><div html="&lt;p&gt;The absolute path to the directory containing the &lt;code&gt;sitemap.json&lt;/code&gt; file.
This is the path to your theme&amp;#39;s document root.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The absolute path to the directory containing the <code>sitemap.json</code> file.
This is the path to your theme&#39;s document root.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Branding/get_information_for_applications</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Branding/get_information_for_applications</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kn34a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kn34a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kn34a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn34a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kn34a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn34a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kn34a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn34a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kn34a:0" aria-labelledby="tab:R4kn34a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Branding <span class="token punctuation">\</span>
  get_information_for_applications <span class="token punctuation">\</span>
  <span class="token assign-left variable">docroot</span><span class="token operator">=</span><span class="token string">'/usr/local/cpanel/base/webmail/jupiter'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn34a:1" aria-labelledby="tab:R4kn34a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn34a:2" aria-labelledby="tab:R4kn34a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn34a:3" aria-labelledby="tab:R4kn34a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sn34a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sn34a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sn34a:0" aria-labelledby="tab:R4sn34a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_information_for_applications&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Branding&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"property1"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"condition"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"feature"</span>: <span class="token string">&quot;blockers&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"if"</span>: <span class="token string">&quot;!$isarchiveuser&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;string&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">&quot;Email Filters&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"height"</span>: <span class="token number">32</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">&quot;email_filters&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"width"</span>: <span class="token number">35</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"implements"</span>: <span class="token string">&quot;Email_UserLevelFiltering&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">&quot;email_filters&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;Email Filters&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"order"</span>: <span class="token number">4</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"terms"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;email&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;filter&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;filters&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;item&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">&quot;mail/filters/userfilters.html&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"property2"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"condition"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"feature"</span>: <span class="token string">&quot;blockers&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"if"</span>: <span class="token string">&quot;!$isarchiveuser&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;string&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">&quot;Email Filters&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"height"</span>: <span class="token number">32</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">&quot;email_filters&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"width"</span>: <span class="token number">35</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"implements"</span>: <span class="token string">&quot;Email_UserLevelFiltering&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">&quot;email_filters&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;Email Filters&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"order"</span>: <span class="token number">4</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"terms"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;email&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;filter&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;filters&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;item&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">&quot;mail/filters/userfilters.html&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Application-Information/operation/get_application_information" data-section-id="tag/Application-Information/operation/get_application_information" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_application_information" id="operation/get_application_information" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Application-Information/operation/get_application_information" aria-label="tag/Application-Information/operation/get_application_information"></a>Return single app&#x27;s info from dynamicui.conf </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves an application&amp;#39;s information from the &lt;code&gt;dynamicui.conf&lt;/code&gt; file.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves an application&#39;s information from the <code>dynamicui.conf</code> file.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="app_key" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">app_key</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">app_key=boxtrapper</span></div><div><div html="&lt;p&gt;The application&amp;#39;s feature name. This value &lt;strong&gt;must&lt;/strong&gt; match a feature&amp;#39;s &lt;code&gt;app_key&lt;/code&gt; value. For a list of app_key values, read our &lt;a href=&quot;https://go.cpanel.net/appkey&quot;&gt;Guide to cPanel Interface Customization - Appkeys&lt;/a&gt; documentation.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The application&#39;s feature name. This value <strong>must</strong> match a feature&#39;s <code>app_key</code> value. For a list of app_key values, read our <a href="https://go.cpanel.net/appkey">Guide to cPanel Interface Customization - Appkeys</a> documentation.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Branding/get_application_information</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Branding/get_application_information</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kp34a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kp34a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kp34a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp34a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kp34a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp34a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kp34a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp34a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kp34a:0" aria-labelledby="tab:R4kp34a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Branding <span class="token punctuation">\</span>
  get_application_information <span class="token punctuation">\</span>
  <span class="token assign-left variable">app_key</span><span class="token operator">=</span><span class="token string">'boxtrapper'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp34a:1" aria-labelledby="tab:R4kp34a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp34a:2" aria-labelledby="tab:R4kp34a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp34a:3" aria-labelledby="tab:R4kp34a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sp34a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sp34a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sp34a:0" aria-labelledby="tab:R4sp34a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_application_information&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Branding&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"feature"</span>: <span class="token string">&quot;boxtrapper&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file"</span>: <span class="token string">&quot;boxtrapper&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group"</span>: <span class="token string">&quot;mail&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"height"</span>: <span class="token number">32</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"if"</span>: <span class="token string">&quot;$hasboxtrapper&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"imgtype"</span>: <span class="token string">&quot;icon&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"itemdesc"</span>: <span class="token string">&quot;BoxTrapper&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"itemorder"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;BoxTrapper&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchtext"</span>: <span class="token string">&quot;boxtrapper&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subtype"</span>: <span class="token string">&quot;img&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;image&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">&quot;mail/boxtrapper.html&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"width"</span>: <span class="token number">35</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Brand-Management" data-section-id="tag/Brand-Management" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Brand-Management" aria-label="tag/Brand-Management"></a>Brand Management</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;cPanel Theme Management / Brand Management&lt;/p&gt;
"><p>cPanel Theme Management / Brand Management</p>
</div></div></div><div id="tag/Brand-Management/operation/get_dom" data-section-id="tag/Brand-Management/operation/get_dom" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_dom" id="operation/get_dom" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Brand-Management/operation/get_dom" aria-label="tag/Brand-Management/operation/get_dom"></a>Return cPanel theme header and footer HTML </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns header and footer HTML. You can use this HTML to create a page with the same visual appearance as your cPanel theme.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns header and footer HTML. You can use this HTML to create a page with the same visual appearance as your cPanel theme.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="page_title" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">page_title</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">page_title=Test</span></div><div><div html="&lt;p&gt;The title of the page to wrap in the theme&amp;#39;s headers and footers.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The title of the page to wrap in the theme&#39;s headers and footers.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Chrome/get_dom</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Chrome/get_dom</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R15754a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R15754a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R15754a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R15754a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R15754a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R15754a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R15754a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R15754a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R15754a:0" aria-labelledby="tab:R15754a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Chrome <span class="token punctuation">\</span>
  get_dom <span class="token punctuation">\</span>
  <span class="token assign-left variable">page_title</span><span class="token operator">=</span><span class="token string">'Test'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R15754a:1" aria-labelledby="tab:R15754a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R15754a:2" aria-labelledby="tab:R15754a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R15754a:3" aria-labelledby="tab:R15754a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R17754a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R17754a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R17754a:0" aria-labelledby="tab:R17754a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_dom&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Chrome&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"footer"</span>: <span class="token string">&quot;\n&lt;!-- The Footer HTML of the user's assigned theme --&gt;\n&lt;/html&gt;\n\n&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"header"</span>: <span class="token string">&quot;\n\n&lt;!DOCTYPE html&gt;\n\n&lt;html lang=\&quot;en\&quot; dir=\&quot;ltr\&quot;&gt;\n&lt;!-- The Header HTML of the user's assigned theme --&gt;&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Browser-Cache-Management" data-section-id="tag/Browser-Cache-Management" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Browser-Cache-Management" aria-label="tag/Browser-Cache-Management"></a>Browser Cache Management</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;cPanel Theme Management / Browser Cache Management&lt;/p&gt;
"><p>cPanel Theme Management / Browser Cache Management</p>
</div></div></div><div id="tag/Browser-Cache-Management/operation/update" data-section-id="tag/Browser-Cache-Management/operation/update" class="sc-dntaoT ceciOs"><div data-section-id="operation/update" id="operation/update" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Browser-Cache-Management/operation/update" aria-label="tag/Browser-Cache-Management/operation/update"></a>Create web browser cached file override ID </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function generates a random integer (the CacheBuster ID). Use this ID to work with and around a browser&amp;#39;s caching mechanism.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function generates a random integer (the CacheBuster ID). Use this ID to work with and around a browser&#39;s caching mechanism.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/CacheBuster/update</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/CacheBuster/update</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ab74a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ab74a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ab74a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab74a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2ab74a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab74a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2ab74a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab74a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ab74a:0" aria-labelledby="tab:R2ab74a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  CacheBuster <span class="token punctuation">\</span>
  update
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab74a:1" aria-labelledby="tab:R2ab74a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab74a:2" aria-labelledby="tab:R2ab74a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab74a:3" aria-labelledby="tab:R2ab74a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eb74a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eb74a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eb74a:0" aria-labelledby="tab:R2eb74a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;update&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;CacheBuster&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"cache_id"</span>: <span class="token number">11381138</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Browser-Cache-Management/operation/CacheBuster-read" data-section-id="tag/Browser-Cache-Management/operation/CacheBuster-read" class="sc-dntaoT ceciOs"><div data-section-id="operation/CacheBuster-read" id="operation/CacheBuster-read" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Browser-Cache-Management/operation/CacheBuster-read" aria-label="tag/Browser-Cache-Management/operation/CacheBuster-read"></a>Return web browser cached file override ID </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the current &lt;code&gt;CacheBuster&lt;/code&gt; id. The system uses this ID to force the browser to fetch a new resource when that resource already exists in the web browser cache. This is useful when an application has updated the resource on the server. You should append this ID to the end of the url in the query-string. For example, if you are accessing a url like:&lt;/p&gt;
&lt;p&gt;&lt;code&gt;https://example.com/styled/basic/sprites/icon_spritemap.css&lt;/code&gt;&lt;/p&gt;
&lt;p&gt; To force the browser to fetch the updated version, you would append the following:&lt;/p&gt;
&lt;p&gt; &lt;code&gt;https://example.com/styled/basic/sprites/icon_spritemap.css?&amp;lt;CacheBusterID&amp;gt;&lt;/code&gt;&lt;/p&gt;
&lt;p&gt; &lt;strong&gt;Note&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; The application that updates the resource at this url on the server &lt;strong&gt;must&lt;/strong&gt; call the &lt;code&gt;CacheBuster::update&lt;/code&gt; function when it updates the resource to signify that update.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the current <code>CacheBuster</code> id. The system uses this ID to force the browser to fetch a new resource when that resource already exists in the web browser cache. This is useful when an application has updated the resource on the server. You should append this ID to the end of the url in the query-string. For example, if you are accessing a url like:</p>
<p><code>https://example.com/styled/basic/sprites/icon_spritemap.css</code></p>
<p> To force the browser to fetch the updated version, you would append the following:</p>
<p> <code>https://example.com/styled/basic/sprites/icon_spritemap.css?&lt;CacheBusterID&gt;</code></p>
<p> <strong>Note</strong></p>
<p> The application that updates the resource at this url on the server <strong>must</strong> call the <code>CacheBuster::update</code> function when it updates the resource to signify that update.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/CacheBuster/read</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/CacheBuster/read</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ad74a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ad74a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ad74a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ad74a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2ad74a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ad74a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2ad74a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ad74a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ad74a:0" aria-labelledby="tab:R2ad74a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  CacheBuster <span class="token punctuation">\</span>
  <span class="token builtin class-name">read</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ad74a:1" aria-labelledby="tab:R2ad74a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ad74a:2" aria-labelledby="tab:R2ad74a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ad74a:3" aria-labelledby="tab:R2ad74a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ed74a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ed74a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ed74a:0" aria-labelledby="tab:R2ed74a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;read&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;CacheBuster&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"cache_id"</span>: <span class="token number">11381138</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Language" data-section-id="tag/Language" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Language" aria-label="tag/Language"></a>Language</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;cPanel Theme Management / Language&lt;/p&gt;
"><p>cPanel Theme Management / Language</p>
</div></div></div><div id="tag/Language/operation/set_locale" data-section-id="tag/Language/operation/set_locale" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_locale" id="operation/set_locale" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Language/operation/set_locale" aria-label="tag/Language/operation/set_locale"></a>Update cPanel account locale </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function sets the account&amp;#39;s locale.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets the account&#39;s locale.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="locale" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">locale</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">locale=en</span></div><div><div html="&lt;p&gt;The locale&amp;#39;s abbreviated name according to UAPI&amp;#39;s &lt;code&gt;Locale::list_locales&lt;/code&gt; function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The locale&#39;s abbreviated name according to UAPI&#39;s <code>Locale::list_locales</code> function.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Locale/set_locale</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Locale/set_locale</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ab94a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ab94a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ab94a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab94a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2ab94a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab94a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2ab94a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab94a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ab94a:0" aria-labelledby="tab:R2ab94a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Locale <span class="token punctuation">\</span>
  set_locale <span class="token punctuation">\</span>
  <span class="token assign-left variable">locale</span><span class="token operator">=</span><span class="token string">'en'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab94a:1" aria-labelledby="tab:R2ab94a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab94a:2" aria-labelledby="tab:R2ab94a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab94a:3" aria-labelledby="tab:R2ab94a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eb94a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eb94a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eb94a:0" aria-labelledby="tab:R2eb94a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_locale&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Locale&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Language/operation/list_locales" data-section-id="tag/Language/operation/list_locales" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_locales" id="operation/list_locales" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Language/operation/list_locales" aria-label="tag/Language/operation/list_locales"></a>Return available locales </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists an account&amp;#39;s available interface languages.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists an account&#39;s available interface languages.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Locale/list_locales</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Locale/list_locales</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ad94a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ad94a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ad94a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ad94a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2ad94a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ad94a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2ad94a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ad94a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ad94a:0" aria-labelledby="tab:R2ad94a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Locale <span class="token punctuation">\</span>
  list_locales
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ad94a:1" aria-labelledby="tab:R2ad94a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ad94a:2" aria-labelledby="tab:R2ad94a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ad94a:3" aria-labelledby="tab:R2ad94a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ed94a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ed94a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ed94a:0" aria-labelledby="tab:R2ed94a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_locales&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Locale&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"direction"</span>: <span class="token string">&quot;ltr&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"local_name"</span>: <span class="token string">&quot;Deutsch&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"locale"</span>: <span class="token string">&quot;de&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;German&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Language/operation/get_attributes" data-section-id="tag/Language/operation/get_attributes" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_attributes" id="operation/get_attributes" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Language/operation/get_attributes" aria-label="tag/Language/operation/get_attributes"></a>Return current locale settings </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves information about the user&amp;#39;s current locale setting.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves information about the user&#39;s current locale setting.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Locale/get_attributes</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Locale/get_attributes</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2af94a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2af94a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2af94a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2af94a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2af94a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2af94a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2af94a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2af94a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2af94a:0" aria-labelledby="tab:R2af94a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Locale <span class="token punctuation">\</span>
  get_attributes
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2af94a:1" aria-labelledby="tab:R2af94a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2af94a:2" aria-labelledby="tab:R2af94a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2af94a:3" aria-labelledby="tab:R2af94a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ef94a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ef94a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ef94a:0" aria-labelledby="tab:R2ef94a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_attributes&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Locale&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"direction"</span>: <span class="token string">&quot;ltr&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"encoding"</span>: <span class="token string">&quot;utf-8&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"locale"</span>: <span class="token string">&quot;en&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;English&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Theme-Settings" data-section-id="tag/Theme-Settings" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Theme-Settings" aria-label="tag/Theme-Settings"></a>Theme Settings</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;cPanel Theme Management / Theme Settings&lt;/p&gt;
"><p>cPanel Theme Management / Theme Settings</p>
</div></div></div><div id="tag/Theme-Settings/operation/get_theme_base" data-section-id="tag/Theme-Settings/operation/get_theme_base" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_theme_base" id="operation/get_theme_base" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Theme-Settings/operation/get_theme_base" aria-label="tag/Theme-Settings/operation/get_theme_base"></a>Return current theme <span type="warning" class="sc-jtQUzJ jmDXKf"> Deprecated </span></h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function is deprecated and does not return useful output.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function is deprecated and does not return useful output.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Themes/get_theme_base</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Themes/get_theme_base</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2abb4a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abb4a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abb4a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abb4a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2abb4a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abb4a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2abb4a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abb4a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abb4a:0" aria-labelledby="tab:R2abb4a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Themes <span class="token punctuation">\</span>
  get_theme_base
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abb4a:1" aria-labelledby="tab:R2abb4a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abb4a:2" aria-labelledby="tab:R2abb4a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abb4a:3" aria-labelledby="tab:R2abb4a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ebb4a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebb4a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebb4a:0" aria-labelledby="tab:R2ebb4a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_theme_base&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Themes&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token string">&quot;jupiter&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Theme-Settings/operation/Themes::update" data-section-id="tag/Theme-Settings/operation/Themes::update" class="sc-dntaoT ceciOs"><div data-section-id="operation/Themes::update" id="operation/Themes::update" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Theme-Settings/operation/Themes::update" aria-label="tag/Theme-Settings/operation/Themes::update"></a>Update current theme </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function applies a new theme to the cPanel interface.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  The &lt;code&gt;/usr/local/cpanel/scripts/modify_accounts&lt;/code&gt; script allows you to modify the theme for many or all accounts on the server. For more information, read our &lt;a href=&quot;https://go.cpanel.net/modifyaccounts&quot;&gt;The modify_accounts Script&lt;/a&gt; documentation.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function applies a new theme to the cPanel interface.</p>
<p><strong>Note:</strong></p>
<p>  The <code>/usr/local/cpanel/scripts/modify_accounts</code> script allows you to modify the theme for many or all accounts on the server. For more information, read our <a href="https://go.cpanel.net/modifyaccounts">The modify_accounts Script</a> documentation.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="theme" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">theme</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">theme=jupiter</span></div><div><div html="&lt;p&gt;The theme name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The theme name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Themes/update</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Themes/update</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2adb4a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2adb4a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2adb4a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adb4a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2adb4a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adb4a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2adb4a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adb4a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2adb4a:0" aria-labelledby="tab:R2adb4a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Themes <span class="token punctuation">\</span>
  update <span class="token punctuation">\</span>
  <span class="token assign-left variable">theme</span><span class="token operator">=</span><span class="token string">'jupiter'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adb4a:1" aria-labelledby="tab:R2adb4a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adb4a:2" aria-labelledby="tab:R2adb4a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adb4a:3" aria-labelledby="tab:R2adb4a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2edb4a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2edb4a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2edb4a:0" aria-labelledby="tab:R2edb4a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;update&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Themes&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Theme-Settings/operation/Themes::list" data-section-id="tag/Theme-Settings/operation/Themes::list" class="sc-dntaoT ceciOs"><div data-section-id="operation/Themes::list" id="operation/Themes::list" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Theme-Settings/operation/Themes::list" aria-label="tag/Theme-Settings/operation/Themes::list"></a>Return available themes </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists available themes.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  The &lt;code&gt;/usr/local/cpanel/scripts/modify_accounts&lt;/code&gt; script allows you to modify the style and theme for many or all accounts on the server. For more information, read our &lt;a href=&quot;https://go.cpanel.net/modifyaccounts&quot;&gt;The modify_accounts Script&lt;/a&gt; documentation.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists available themes.</p>
<p><strong>Note:</strong></p>
<p>  The <code>/usr/local/cpanel/scripts/modify_accounts</code> script allows you to modify the style and theme for many or all accounts on the server. For more information, read our <a href="https://go.cpanel.net/modifyaccounts">The modify_accounts Script</a> documentation.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="show_mail_themes" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">show_mail_themes</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">show_mail_themes=1</span></div><div><div html="&lt;p&gt;Whether to list the account&amp;#39;s mail themes.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — List mail themes.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Do &lt;strong&gt;not&lt;/strong&gt; list mail themes.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to list the account&#39;s mail themes.</p>
<ul>
<li><code>1</code> — List mail themes.</li>
<li><code>0</code> — Do <strong>not</strong> list mail themes.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Themes/list</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Themes/list</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2afb4a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2afb4a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2afb4a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2afb4a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2afb4a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2afb4a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2afb4a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2afb4a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2afb4a:0" aria-labelledby="tab:R2afb4a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Themes <span class="token punctuation">\</span>
  list
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2afb4a:1" aria-labelledby="tab:R2afb4a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2afb4a:2" aria-labelledby="tab:R2afb4a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2afb4a:3" aria-labelledby="tab:R2afb4a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2efb4a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2efb4a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2efb4a:0" aria-labelledby="tab:R2efb4a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Themes&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;jupiter&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Directory-Indexes" data-section-id="tag/Directory-Indexes" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Directory-Indexes" aria-label="tag/Directory-Indexes"></a>Directory Indexes</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Directory Management / Directory Indexes&lt;/p&gt;
"><p>Directory Management / Directory Indexes</p>
</div></div></div><div id="tag/Directory-Indexes/operation/get_indexing" data-section-id="tag/Directory-Indexes/operation/get_indexing" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_indexing" id="operation/get_indexing" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Directory-Indexes/operation/get_indexing" aria-label="tag/Directory-Indexes/operation/get_indexing"></a>Return directory indexing settings </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the directory indexing settings for a directory on the cPanel account and its subdirectories.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the directory indexing settings for a directory on the cPanel account and its subdirectories.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="dir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">dir</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">dir=/home/example/example.com</span></div><div><div html="&lt;p&gt;The directory for which to check the indexing type.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The directory for which to check the indexing type.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DirectoryIndexes/get_indexing</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DirectoryIndexes/get_indexing</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R155j4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R155j4q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R155j4q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R155j4q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R155j4q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R155j4q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R155j4q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R155j4q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R155j4q:0" aria-labelledby="tab:R155j4q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DirectoryIndexes <span class="token punctuation">\</span>
  get_indexing <span class="token punctuation">\</span>
  <span class="token assign-left variable">dir</span><span class="token operator">=</span><span class="token string">'/home/example/example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155j4q:1" aria-labelledby="tab:R155j4q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155j4q:2" aria-labelledby="tab:R155j4q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155j4q:3" aria-labelledby="tab:R155j4q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R175j4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R175j4q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R175j4q:0" aria-labelledby="tab:R175j4q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_indexing&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DirectoryIndexes&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token string">&quot;disabled&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Directory-Indexes/operation/DirectoryIndexes-list_directories" data-section-id="tag/Directory-Indexes/operation/DirectoryIndexes-list_directories" class="sc-dntaoT ceciOs"><div data-section-id="operation/DirectoryIndexes-list_directories" id="operation/DirectoryIndexes-list_directories" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Directory-Indexes/operation/DirectoryIndexes-list_directories" aria-label="tag/Directory-Indexes/operation/DirectoryIndexes-list_directories"></a>Return subdirectories directory indexing settings </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the &lt;a href=&quot;https://go.cpanel.net/cpaneldocsIndexes&quot;&gt;directory indexing&lt;/a&gt; settings of the subdirectories in a directory.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the <a href="https://go.cpanel.net/cpaneldocsIndexes">directory indexing</a> settings of the subdirectories in a directory.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="dir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">dir</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">dir=/home/example/example.com</span></div><div><div html="&lt;p&gt;The absolute path of the directory for which to return indexing information.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The absolute path of the directory for which to return indexing information.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DirectoryIndexes/list_directories</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DirectoryIndexes/list_directories</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R156j4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R156j4q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R156j4q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R156j4q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R156j4q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R156j4q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R156j4q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R156j4q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R156j4q:0" aria-labelledby="tab:R156j4q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DirectoryIndexes <span class="token punctuation">\</span>
  list_directories <span class="token punctuation">\</span>
  <span class="token assign-left variable">dir</span><span class="token operator">=</span><span class="token string">'/home/example/example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R156j4q:1" aria-labelledby="tab:R156j4q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R156j4q:2" aria-labelledby="tab:R156j4q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R156j4q:3" aria-labelledby="tab:R156j4q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R176j4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R176j4q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R176j4q:0" aria-labelledby="tab:R176j4q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_directories&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DirectoryIndexes&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"children"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/home/example/example.com/cgi-bin&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"index_type"</span>: <span class="token string">&quot;inherit&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"current"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/home/example/example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"index_type"</span>: <span class="token string">&quot;inherit&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"home"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/home/example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"index_type"</span>: <span class="token string">&quot;inherit&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parent"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/home/example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"index_type"</span>: <span class="token string">&quot;inherit&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Directory-Indexes/operation/set_indexing" data-section-id="tag/Directory-Indexes/operation/set_indexing" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_indexing" id="operation/set_indexing" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Directory-Indexes/operation/set_indexing" aria-label="tag/Directory-Indexes/operation/set_indexing"></a>Update directory indexing settings </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function configures the &lt;a href=&quot;https://go.cpanel.net/cpaneldocsIndexes&quot;&gt;directory indexing&lt;/a&gt; settings for a directory on the cPanel account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function configures the <a href="https://go.cpanel.net/cpaneldocsIndexes">directory indexing</a> settings for a directory on the cPanel account.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="dir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">dir</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">dir=/home/example/example.com</span></div><div><div html="&lt;p&gt;The directory for which to manage directory indexing.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The directory for which to manage directory indexing.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="type" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">type</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;standard&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;disabled&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;inherit&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;fancy&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">type=inherit</span></div><div><div html="&lt;p&gt;The type of directory indexing.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;standard&lt;/code&gt; — The directory uses directory indexing with standard formatting.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;disabled&lt;/code&gt; — The directory doesn&amp;#39;t use directory indexing.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;inherit&lt;/code&gt; — The directory uses the system&amp;#39;s default settings.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;fancy&lt;/code&gt; — The directory uses directory indexing with Apache FancyIndexing directive. The directory will include additional information such as file size and the date of the file&amp;#39;s last update.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The type of directory indexing.</p>
<ul>
<li><code>standard</code> — The directory uses directory indexing with standard formatting.</li>
<li><code>disabled</code> — The directory doesn&#39;t use directory indexing.</li>
<li><code>inherit</code> — The directory uses the system&#39;s default settings.</li>
<li><code>fancy</code> — The directory uses directory indexing with Apache FancyIndexing directive. The directory will include additional information such as file size and the date of the file&#39;s last update.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DirectoryIndexes/set_indexing</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DirectoryIndexes/set_indexing</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R157j4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R157j4q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R157j4q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R157j4q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R157j4q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R157j4q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R157j4q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R157j4q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R157j4q:0" aria-labelledby="tab:R157j4q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DirectoryIndexes <span class="token punctuation">\</span>
  set_indexing <span class="token punctuation">\</span>
  <span class="token assign-left variable">dir</span><span class="token operator">=</span><span class="token string">'/home/example/example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">type</span><span class="token operator">=</span><span class="token string">'inherit'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R157j4q:1" aria-labelledby="tab:R157j4q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R157j4q:2" aria-labelledby="tab:R157j4q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R157j4q:3" aria-labelledby="tab:R157j4q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R177j4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R177j4q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R177j4q:0" aria-labelledby="tab:R177j4q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_indexing&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DirectoryIndexes&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token string">&quot;disabled&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Directory-Privacy" data-section-id="tag/Directory-Privacy" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Directory-Privacy" aria-label="tag/Directory-Privacy"></a>Directory Privacy</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Directory Management / Directory Privacy&lt;/p&gt;
"><p>Directory Management / Directory Privacy</p>
</div></div></div><div id="tag/Directory-Privacy/operation/is_directory_protected" data-section-id="tag/Directory-Privacy/operation/is_directory_protected" class="sc-dntaoT ceciOs"><div data-section-id="operation/is_directory_protected" id="operation/is_directory_protected" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Directory-Privacy/operation/is_directory_protected" aria-label="tag/Directory-Privacy/operation/is_directory_protected"></a>Return whether directory uses password protection </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function confirms whether a directory uses password protection.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function confirms whether a directory uses password protection.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="dir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">dir</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">dir=/home/example/example.com</span></div><div><div html="&lt;p&gt;The absolute directory path on the cPanel account to check for password protection.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The absolute directory path on the cPanel account to check for password protection.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DirectoryPrivacy/is_directory_protected</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DirectoryPrivacy/is_directory_protected</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a9l4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9l4q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9l4q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9l4q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2a9l4q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9l4q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2a9l4q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9l4q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9l4q:0" aria-labelledby="tab:R2a9l4q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DirectoryPrivacy <span class="token punctuation">\</span>
  is_directory_protected <span class="token punctuation">\</span>
  <span class="token assign-left variable">dir</span><span class="token operator">=</span><span class="token string">'/home/example/example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9l4q:1" aria-labelledby="tab:R2a9l4q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9l4q:2" aria-labelledby="tab:R2a9l4q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9l4q:3" aria-labelledby="tab:R2a9l4q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2e9l4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9l4q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9l4q:0" aria-labelledby="tab:R2e9l4q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;is_directory_protected&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DirectoryPrivacy&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"auth_name"</span>: <span class="token string">&quot;Protected 'example.com'&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auth_type"</span>: <span class="token string">&quot;Basic&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"passwd_file"</span>: <span class="token string">&quot;/home/example/.htpasswds/example.com/passwd&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"protected"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Directory-Privacy/operation/DirectoryPrivacy::list_users" data-section-id="tag/Directory-Privacy/operation/DirectoryPrivacy::list_users" class="sc-dntaoT ceciOs"><div data-section-id="operation/DirectoryPrivacy::list_users" id="operation/DirectoryPrivacy::list_users" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Directory-Privacy/operation/DirectoryPrivacy::list_users" aria-label="tag/Directory-Privacy/operation/DirectoryPrivacy::list_users"></a>Return authorized users for protected directory </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the users who can access a password-protected directory on the cPanel account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the users who can access a password-protected directory on the cPanel account.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="dir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">dir</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">dir=/home/example/example.com</span></div><div><div html="&lt;p&gt;The password-protected directory for which to return authorized users.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The password-protected directory for which to return authorized users.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DirectoryPrivacy/list_users</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DirectoryPrivacy/list_users</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aal4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aal4q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aal4q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aal4q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2aal4q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aal4q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2aal4q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aal4q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aal4q:0" aria-labelledby="tab:R2aal4q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DirectoryPrivacy <span class="token punctuation">\</span>
  list_users <span class="token punctuation">\</span>
  <span class="token assign-left variable">dir</span><span class="token operator">=</span><span class="token string">'/home/example/example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aal4q:1" aria-labelledby="tab:R2aal4q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aal4q:2" aria-labelledby="tab:R2aal4q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aal4q:3" aria-labelledby="tab:R2aal4q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eal4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eal4q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eal4q:0" aria-labelledby="tab:R2eal4q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_users&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DirectoryPrivacy&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example1&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;example2&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Directory-Privacy/operation/DirectoryPrivacy-list_directories" data-section-id="tag/Directory-Privacy/operation/DirectoryPrivacy-list_directories" class="sc-dntaoT ceciOs"><div data-section-id="operation/DirectoryPrivacy-list_directories" id="operation/DirectoryPrivacy-list_directories" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Directory-Privacy/operation/DirectoryPrivacy-list_directories" aria-label="tag/Directory-Privacy/operation/DirectoryPrivacy-list_directories"></a>Return privacy status of subdirectories </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the privacy status of the subdirectories in a directory.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the privacy status of the subdirectories in a directory.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="dir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">dir</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">dir=/home/example/example.com</span></div><div><div html="&lt;p&gt;The directory path for which to return the subdirectories&amp;#39; privacy information.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The directory path for which to return the subdirectories&#39; privacy information.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DirectoryPrivacy/list_directories</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DirectoryPrivacy/list_directories</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2abl4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abl4q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abl4q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abl4q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2abl4q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abl4q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2abl4q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abl4q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abl4q:0" aria-labelledby="tab:R2abl4q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DirectoryPrivacy <span class="token punctuation">\</span>
  list_directories <span class="token punctuation">\</span>
  <span class="token assign-left variable">dir</span><span class="token operator">=</span><span class="token string">'/home/example/example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abl4q:1" aria-labelledby="tab:R2abl4q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abl4q:2" aria-labelledby="tab:R2abl4q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abl4q:3" aria-labelledby="tab:R2abl4q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ebl4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebl4q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebl4q:0" aria-labelledby="tab:R2ebl4q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_directories&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DirectoryPrivacy&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"children"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/home/example/example.com/cgi-bin&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"auth_name"</span>: <span class="token string">&quot;Protected 'example.com'&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auth_type"</span>: <span class="token string">&quot;Basic&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"passwd_file"</span>: <span class="token string">&quot;/home/example/.htpasswds/example.com/passwd&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"protected"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"current"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/home/example/example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"auth_name"</span>: <span class="token string">&quot;protected&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auth_type"</span>: <span class="token string">&quot;Basic&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"passwd_file"</span>: <span class="token string">&quot;/home/example/.htpasswds/example.com/passwd&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"protected"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"home"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/home/example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"auth_name"</span>: <span class="token string">&quot;protected&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auth_type"</span>: <span class="token string">&quot;Basic&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"passwd_file"</span>: <span class="token string">&quot;/home/example/.htpasswds/example.com/passwd&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"protected"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parent"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/home/example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"auth_name"</span>: <span class="token string">&quot;protected&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auth_type"</span>: <span class="token string">&quot;Basic&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"passwd_file"</span>: <span class="token string">&quot;/home/example/.htpasswds/example.com/passwd&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"protected"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Directory-Privacy/operation/configure_directory_protection" data-section-id="tag/Directory-Privacy/operation/configure_directory_protection" class="sc-dntaoT ceciOs"><div data-section-id="operation/configure_directory_protection" id="operation/configure_directory_protection" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Directory-Privacy/operation/configure_directory_protection" aria-label="tag/Directory-Privacy/operation/configure_directory_protection"></a>Enable or disable protected directory </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function enables or disables password protection for a directory on the cPanel account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables or disables password protection for a directory on the cPanel account.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="authname" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">authname</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">authname=protectandserve</span></div><div><div html="&lt;p&gt;The name of the directory protection authorization instance.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Only&lt;/strong&gt; use this parameter when you enable password protection.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the directory protection authorization instance.</p>
<p><strong>Note:</strong></p>
<p><strong>Only</strong> use this parameter when you enable password protection.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="dir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">dir</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">dir=/home/example/example.com</span></div><div><div html="&lt;p&gt;The absolute or relative directory path for which to enable or disable password protection.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The absolute or relative directory path for which to enable or disable password protection.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="enabled" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">enabled</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">enabled=1</span></div><div><div html="&lt;p&gt;Whether to enable password protection for the directory.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Enable.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Disable.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to enable password protection for the directory.</p>
<ul>
<li><code>1</code> - Enable.</li>
<li><code>0</code> - Disable.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DirectoryPrivacy/configure_directory_protection</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DirectoryPrivacy/configure_directory_protection</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2acl4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2acl4q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2acl4q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acl4q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2acl4q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acl4q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2acl4q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acl4q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2acl4q:0" aria-labelledby="tab:R2acl4q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DirectoryPrivacy <span class="token punctuation">\</span>
  configure_directory_protection <span class="token punctuation">\</span>
  <span class="token assign-left variable">dir</span><span class="token operator">=</span><span class="token string">'/home/example/example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">enabled</span><span class="token operator">=</span><span class="token string">'1'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">authname</span><span class="token operator">=</span><span class="token string">'protectandserve'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acl4q:1" aria-labelledby="tab:R2acl4q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acl4q:2" aria-labelledby="tab:R2acl4q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acl4q:3" aria-labelledby="tab:R2acl4q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ecl4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ecl4q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ecl4q:0" aria-labelledby="tab:R2ecl4q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;configure_directory_protection&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DirectoryPrivacy&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"auth_name"</span>: <span class="token string">&quot;protectandserve&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auth_type"</span>: <span class="token string">&quot;Basic&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"passwd_file"</span>: <span class="token string">&quot;/home/example/.htpasswds/example.com/passwd&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"protected"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Directory-Privacy/operation/delete_user" data-section-id="tag/Directory-Privacy/operation/delete_user" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete_user" id="operation/delete_user" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Directory-Privacy/operation/delete_user" aria-label="tag/Directory-Privacy/operation/delete_user"></a>Delete authorized user for protected directory </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function deletes a user who can access a protected directory on the cPanel account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes a user who can access a protected directory on the cPanel account.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="dir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">dir</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">dir=/home/example/example.com</span></div><div><div html="&lt;p&gt;The absolute directory path on the cPanel account from which to remove a user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The absolute directory path on the cPanel account from which to remove a user.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;username&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=example1</span></div><div><div html="&lt;p&gt;The username to remove from the directory.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username to remove from the directory.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DirectoryPrivacy/delete_user</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DirectoryPrivacy/delete_user</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2adl4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2adl4q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2adl4q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adl4q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2adl4q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adl4q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2adl4q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adl4q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2adl4q:0" aria-labelledby="tab:R2adl4q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DirectoryPrivacy <span class="token punctuation">\</span>
  delete_user <span class="token punctuation">\</span>
  <span class="token assign-left variable">dir</span><span class="token operator">=</span><span class="token string">'/home/example/example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'example1'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adl4q:1" aria-labelledby="tab:R2adl4q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adl4q:2" aria-labelledby="tab:R2adl4q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adl4q:3" aria-labelledby="tab:R2adl4q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2edl4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2edl4q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2edl4q:0" aria-labelledby="tab:R2edl4q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;delete_user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DirectoryPrivacy&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Directory-Privacy/operation/add_user" data-section-id="tag/Directory-Privacy/operation/add_user" class="sc-dntaoT ceciOs"><div data-section-id="operation/add_user" id="operation/add_user" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Directory-Privacy/operation/add_user" aria-label="tag/Directory-Privacy/operation/add_user"></a>Add authorized user for protected directory </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function adds a user who can access a protected directory on the cPanel account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function adds a user who can access a protected directory on the cPanel account.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="dir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">dir</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">dir=/home/example/example.com</span></div><div><div html="&lt;p&gt;The directory to add users to.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The directory to add users to.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="password" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">password</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">password=123456luggage</span></div><div><div html="&lt;p&gt;The password for the user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The password for the user.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=example1</span></div><div><div html="&lt;p&gt;The username of the user who can access the directory.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username of the user who can access the directory.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DirectoryPrivacy/add_user</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DirectoryPrivacy/add_user</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ael4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ael4q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ael4q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ael4q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2ael4q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ael4q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2ael4q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ael4q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ael4q:0" aria-labelledby="tab:R2ael4q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DirectoryPrivacy <span class="token punctuation">\</span>
  add_user <span class="token punctuation">\</span>
  <span class="token assign-left variable">dir</span><span class="token operator">=</span><span class="token string">'/home/example/example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'example1'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">password</span><span class="token operator">=</span><span class="token string">'123456luggage'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ael4q:1" aria-labelledby="tab:R2ael4q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ael4q:2" aria-labelledby="tab:R2ael4q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ael4q:3" aria-labelledby="tab:R2ael4q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eel4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eel4q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eel4q:0" aria-labelledby="tab:R2eel4q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;add_user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DirectoryPrivacy&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Directory-Protection" data-section-id="tag/Directory-Protection" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Directory-Protection" aria-label="tag/Directory-Protection"></a>Directory Protection</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Directory Management / Directory Protection&lt;/p&gt;
"><p>Directory Management / Directory Protection</p>
</div></div></div><div id="tag/Directory-Protection/operation/DirectoryProtection-list_directories" data-section-id="tag/Directory-Protection/operation/DirectoryProtection-list_directories" class="sc-dntaoT ceciOs"><div data-section-id="operation/DirectoryProtection-list_directories" id="operation/DirectoryProtection-list_directories" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Directory-Protection/operation/DirectoryProtection-list_directories" aria-label="tag/Directory-Protection/operation/DirectoryProtection-list_directories"></a>Return Directory Protection settings </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the
&lt;a href=&quot;https://go.cpanel.net/cpaneldocsLeechProtection&quot;&gt;leech protection&lt;/a&gt;
settings of the subdirectories in a directory.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the
<a href="https://go.cpanel.net/cpaneldocsLeechProtection">leech protection</a>
settings of the subdirectories in a directory.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="dir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">dir</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">dir=/home/example/example.com</span></div><div><div html="&lt;p&gt;The absolute or relative file path in the user&amp;#39;s &lt;code&gt;home&lt;/code&gt; directory for which to return leech protection information.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The absolute or relative file path in the user&#39;s <code>home</code> directory for which to return leech protection information.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DirectoryProtection/list_directories</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DirectoryProtection/list_directories</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rijn4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rijn4q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rijn4q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijn4q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rijn4q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijn4q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rijn4q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijn4q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rijn4q:0" aria-labelledby="tab:Rijn4q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DirectoryProtection <span class="token punctuation">\</span>
  list_directories <span class="token punctuation">\</span>
  <span class="token assign-left variable">dir</span><span class="token operator">=</span><span class="token string">'/home/example/example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijn4q:1" aria-labelledby="tab:Rijn4q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijn4q:2" aria-labelledby="tab:Rijn4q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijn4q:3" aria-labelledby="tab:Rijn4q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjjn4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjjn4q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjjn4q:0" aria-labelledby="tab:Rjjn4q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_directories&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DirectoryProtection&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"children"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/home/example/example.com/cgi-bin&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"has_leech_protection"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"current"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/home/example/example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"has_leech_protection"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"home"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/home/example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"has_leech_protection"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parent"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/home/example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"has_leech_protection"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/DNS" data-section-id="tag/DNS" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS" aria-label="tag/DNS"></a>DNS</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;The DNS module for UAPI.&lt;/p&gt;
"><p>The DNS module for UAPI.</p>
</div></div></div><div id="tag/DNS/operation/ensure_domains_reside_only_locally" data-section-id="tag/DNS/operation/ensure_domains_reside_only_locally" class="sc-dntaoT ceciOs"><div data-section-id="operation/ensure_domains_reside_only_locally" id="operation/ensure_domains_reside_only_locally" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS/operation/ensure_domains_reside_only_locally" aria-label="tag/DNS/operation/ensure_domains_reside_only_locally"></a>Return whether domains only resolve locally </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function indicates whether the account&amp;#39;s domains resolve exclusively to this server.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function indicates whether the account&#39;s domains resolve exclusively to this server.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain=example.com&amp;domain-1=example1.com&amp;domain-2=example2.com</span> - Multiple domains</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain=example.com&amp;domain=example1.com&amp;domain=example2.com</span> - Multiple domains</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> - A single domain.</li></ul><div><div html="&lt;p&gt;The domain to check.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To check multiple domains, duplicate or increment the parameter name. For example, to exclude three domains, you could:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;Use the &lt;code&gt;domain&lt;/code&gt; parameter multiple times.&lt;/li&gt;
&lt;li&gt;Use the &lt;code&gt;domain&lt;/code&gt;, &lt;code&gt;domain-1&lt;/code&gt;, and &lt;code&gt;domain-2&lt;/code&gt; parameters.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain to check.</p>
<p><strong>Note:</strong></p>
<p>To check multiple domains, duplicate or increment the parameter name. For example, to exclude three domains, you could:</p>
<ul>
<li>Use the <code>domain</code> parameter multiple times.</li>
<li>Use the <code>domain</code>, <code>domain-1</code>, and <code>domain-2</code> parameters.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DNS/ensure_domains_reside_only_locally</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DNS/ensure_domains_reside_only_locally</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kj35a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kj35a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kj35a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj35a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kj35a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj35a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kj35a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj35a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kj35a:0" aria-labelledby="tab:R4kj35a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DNS <span class="token punctuation">\</span>
  ensure_domains_reside_only_locally <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj35a:1" aria-labelledby="tab:R4kj35a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj35a:2" aria-labelledby="tab:R4kj35a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj35a:3" aria-labelledby="tab:R4kj35a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sj35a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sj35a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sj35a:0" aria-labelledby="tab:R4sj35a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;ensure_domains_reside_only_locally&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DNS&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;The domain resolves to Mars. Beep beep beep.&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/DNS/operation/DNS::is_alias_available" data-section-id="tag/DNS/operation/DNS::is_alias_available" class="sc-dntaoT ceciOs"><div data-section-id="operation/DNS::is_alias_available" id="operation/DNS::is_alias_available" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS/operation/DNS::is_alias_available" aria-label="tag/DNS/operation/DNS::is_alias_available"></a>Return `ALIAS` DNS record availability &amp; resolver </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns whether &lt;code&gt;ALIAS&lt;/code&gt; and &lt;code&gt;ANAME&lt;/code&gt; records are available and the value of the running PowerDNS (PDNS) &lt;code&gt;resolver&lt;/code&gt; setting, if any exists.
For more information, read our &lt;a href=&quot;https://go.cpanel.net/dns-alias-record&quot;&gt;&lt;code&gt;ALIAS&lt;/code&gt; documentation&lt;/a&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns whether <code>ALIAS</code> and <code>ANAME</code> records are available and the value of the running PowerDNS (PDNS) <code>resolver</code> setting, if any exists.
For more information, read our <a href="https://go.cpanel.net/dns-alias-record"><code>ALIAS</code> documentation</a>.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DNS/is_alias_available</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DNS/is_alias_available</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kl35a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kl35a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kl35a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl35a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kl35a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl35a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kl35a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl35a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kl35a:0" aria-labelledby="tab:R4kl35a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token parameter variable">--user</span><span class="token operator">=</span>username DNS is_alias_available
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl35a:1" aria-labelledby="tab:R4kl35a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl35a:2" aria-labelledby="tab:R4kl35a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl35a:3" aria-labelledby="tab:R4kl35a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sl35a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sl35a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sl35a:0" aria-labelledby="tab:R4sl35a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;is_alias_available&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DNS&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"alias"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"aname"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"resolver"</span>: <span class="token string">&quot;8.8.8.8&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/DNS/operation/dns-lookup" data-section-id="tag/DNS/operation/dns-lookup" class="sc-dntaoT ceciOs"><div data-section-id="operation/dns-lookup" id="operation/dns-lookup" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS/operation/dns-lookup" aria-label="tag/DNS/operation/dns-lookup"></a>Return domain&#x27;s DNS information </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns DNS zone information about a domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns DNS zone information about a domain.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;A fully qualified domain name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A fully qualified domain name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DNS/lookup</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DNS/lookup</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kn35a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kn35a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kn35a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn35a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kn35a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn35a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kn35a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn35a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kn35a:0" aria-labelledby="tab:R4kn35a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DNS <span class="token punctuation">\</span>
  lookup <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn35a:1" aria-labelledby="tab:R4kn35a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn35a:2" aria-labelledby="tab:R4kn35a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn35a:3" aria-labelledby="tab:R4kn35a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sn35a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sn35a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sn35a:0" aria-labelledby="tab:R4sn35a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;lookup&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DNS&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example.com has address 93.184.216.34&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;example.com has IPv6 address 2606:2800:220:1:248:1893:25c8:1946&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;example.com mail is handled by 0 .&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/DNS/operation/dns-parse_zone" data-section-id="tag/DNS/operation/dns-parse_zone" class="sc-dntaoT ceciOs"><div data-section-id="operation/dns-parse_zone" id="operation/dns-parse_zone" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS/operation/dns-parse_zone" aria-label="tag/DNS/operation/dns-parse_zone"></a>Return a parsed DNS zone </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function parses a given DNS zone.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;Most DNS zones contain only 7-bit ASCII. However, it is possible for
DNS zones to contain any binary sequence. An application that decodes
this function&amp;#39;s base64 output &lt;strong&gt;must&lt;/strong&gt; be able to handle cases
where the decoded octets do not match any specific character
encoding.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function parses a given DNS zone.</p>
<p><strong>Important:</strong></p>
<p>Most DNS zones contain only 7-bit ASCII. However, it is possible for
DNS zones to contain any binary sequence. An application that decodes
this function&#39;s base64 output <strong>must</strong> be able to handle cases
where the decoded octets do not match any specific character
encoding.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="zone" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">zone</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">zone=example.com</span></div><div><div html="&lt;p&gt;The name of one of the user’s DNS zones.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of one of the user’s DNS zones.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DNS/parse_zone</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DNS/parse_zone</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kp35a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kp35a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kp35a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp35a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kp35a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp35a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kp35a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp35a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kp35a:0" aria-labelledby="tab:R4kp35a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DNS <span class="token punctuation">\</span>
  parse_zone <span class="token punctuation">\</span>
  <span class="token assign-left variable">zone</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp35a:1" aria-labelledby="tab:R4kp35a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp35a:2" aria-labelledby="tab:R4kp35a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp35a:3" aria-labelledby="tab:R4kp35a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sp35a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sp35a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sp35a:0" aria-labelledby="tab:R4sp35a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;parse_zone&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DNS&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"line_index"</span>: <span class="token number">22</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;record&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data_b64"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;dGV4YXMuY29tLg==&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dname_b64"</span>: <span class="token string">&quot;dGV4YXMuY29tLg==&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"record_type"</span>: <span class="token string">&quot;MX&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ttl"</span>: <span class="token number">14400</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/DNS/operation/dns-mass_edit_zone" data-section-id="tag/DNS/operation/dns-mass_edit_zone" class="sc-dntaoT ceciOs"><div data-section-id="operation/dns-mass_edit_zone" id="operation/dns-mass_edit_zone" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS/operation/dns-mass_edit_zone" aria-label="tag/DNS/operation/dns-mass_edit_zone"></a>Update a DNS zone </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function updates a given DNS zone. It can add, edit,
and remove many records in a single call. It also ensures
that each record not removed will occupy the same
number of lines after the edit as it did before the edit.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function updates a given DNS zone. It can add, edit,
and remove many records in a single call. It also ensures
that each record not removed will occupy the same
number of lines after the edit as it did before the edit.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="add" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">add</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">strings</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;json&gt; </span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR gjyOxn kpFoWb">[ items<span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;json &gt;</span> ]</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">add=&#x27;{&quot;dname&quot;:&quot;example&quot;, &quot;ttl&quot;:14400, &quot;record_type&quot;:&quot;A&quot;, &quot;data&quot;:[&quot;11.22.33.44&quot;]}&#x27;</span> - An A record.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">add=&#x27;{&quot;dname&quot;:&quot;example&quot;, &quot;ttl&quot;:14400, &quot;record_type&quot;:&quot;TXT&quot;, &quot;data&quot;:[&quot;string1&quot;, &quot;string2&quot;]}&#x27;</span> - A TXT record.</li></ul><div><div html="&lt;p&gt;The records to add to the zone. Each item must be a serialized
JSON object that contains:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;dname&lt;/code&gt; — The record’s name.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;ttl&lt;/code&gt; — The record’s TTL (Time-To-Live) value.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;record_type&lt;/code&gt; — The record’s type. For example, &lt;code&gt;A&lt;/code&gt; or &lt;code&gt;TXT&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;data&lt;/code&gt; — An array of strings. The format and number of the
strings depend on the &lt;code&gt;record_type&lt;/code&gt; value.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The records to add to the zone. Each item must be a serialized
JSON object that contains:</p>
<ul>
<li><code>dname</code> — The record’s name.</li>
<li><code>ttl</code> — The record’s TTL (Time-To-Live) value.</li>
<li><code>record_type</code> — The record’s type. For example, <code>A</code> or <code>TXT</code>.</li>
<li><code>data</code> — An array of strings. The format and number of the
strings depend on the <code>record_type</code> value.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="edit" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">edit</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">strings</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;json&gt; </span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR gjyOxn kpFoWb">[ items<span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;json &gt;</span> ]</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">edit=&#x27;{&quot;line_index&quot;: 9, &quot;dname&quot;:&quot;example&quot;, &quot;ttl&quot;:14400, &quot;record_type&quot;:&quot;TXT&quot;, &quot;data&quot;:[&quot;string1&quot;, &quot;string2&quot;]}&#x27;</span></div><div><div html="&lt;p&gt;The records to edit in the zone. Each item must be a serialized
JSON object that contains:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;line_index&lt;/code&gt; — The line number in the DNS zone where the record starts.
This is a 0-based index, so to edit the first line in the file
use the &lt;code&gt;0&lt;/code&gt; value. To edit the second line, give &lt;code&gt;1&lt;/code&gt;, and so forth.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;dname&lt;/code&gt; — The record’s name.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;ttl&lt;/code&gt; — The record’s TTL (Time-To-Live) value.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;record_type&lt;/code&gt; — The record’s new type. For example, &lt;code&gt;A&lt;/code&gt; or &lt;code&gt;TXT&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;data&lt;/code&gt; — An array of strings. The format and number of the
strings depend on the &lt;code&gt;record_type&lt;/code&gt; value.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The records to edit in the zone. Each item must be a serialized
JSON object that contains:</p>
<ul>
<li><code>line_index</code> — The line number in the DNS zone where the record starts.
This is a 0-based index, so to edit the first line in the file
use the <code>0</code> value. To edit the second line, give <code>1</code>, and so forth.</li>
<li><code>dname</code> — The record’s name.</li>
<li><code>ttl</code> — The record’s TTL (Time-To-Live) value.</li>
<li><code>record_type</code> — The record’s new type. For example, <code>A</code> or <code>TXT</code>.</li>
<li><code>data</code> — An array of strings. The format and number of the
strings depend on the <code>record_type</code> value.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="remove" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">remove</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integers</span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR gjyOxn kpFoWb">[ items<span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= 0 </span></span> ]</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">remove=22</span></div><div><div html="&lt;p&gt;The line indexes of records to remove from the zone.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The line indexes of records to remove from the zone.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="serial" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">serial</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= 0 </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">serial=202001010100</span></div><div><div html="&lt;p&gt;The current serial number in the DNS zone’s SOA (Start of Authority)
record. If this value does not match the zone’s current state, the
request fails.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The current serial number in the DNS zone’s SOA (Start of Authority)
record. If this value does not match the zone’s current state, the
request fails.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="zone" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">zone</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">zone=example.com</span></div><div><div html="&lt;p&gt;The name of one of the user’s DNS zones.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of one of the user’s DNS zones.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DNS/mass_edit_zone</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DNS/mass_edit_zone</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kr35a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kr35a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kr35a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kr35a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kr35a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kr35a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kr35a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kr35a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kr35a:0" aria-labelledby="tab:R4kr35a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token parameter variable">--user</span><span class="token operator">=</span>username DNS mass_edit_zone <span class="token assign-left variable">zone</span><span class="token operator">=</span><span class="token string">'example.com'</span> <span class="token assign-left variable">serial</span><span class="token operator">=</span><span class="token string">'202001010100'</span> <span class="token assign-left variable">remove</span><span class="token operator">=</span><span class="token number">23</span> <span class="token assign-left variable">add</span><span class="token operator">=</span><span class="token string">'{"dname":"example","ttl":14400,"record_type":"A","data":["127.0.0.1"]}'</span></pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kr35a:1" aria-labelledby="tab:R4kr35a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kr35a:2" aria-labelledby="tab:R4kr35a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kr35a:3" aria-labelledby="tab:R4kr35a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sr35a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sr35a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sr35a:0" aria-labelledby="tab:R4sr35a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;mass_edit_zone&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DNS&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"new_serial"</span>: <span class="token number">2021031903</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/DNS/operation/DNS-swap_ip_in_zones" data-section-id="tag/DNS/operation/DNS-swap_ip_in_zones" class="sc-dntaoT ceciOs"><div data-section-id="operation/DNS-swap_ip_in_zones" id="operation/DNS-swap_ip_in_zones" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS/operation/DNS-swap_ip_in_zones" aria-label="tag/DNS/operation/DNS-swap_ip_in_zones"></a>Update IP addresses in zone files </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function replaces a domain&amp;#39;s IPv4 address in the DNS zone
file with the specified destination IPv4 address.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function replaces a domain&#39;s IPv4 address in the DNS zone
file with the specified destination IPv4 address.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="dest_ip" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">dest_ip</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;ipv4&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">dest_ip=192.0.2.1</span></div><div><div html="&lt;p&gt;The IPv4 address to use as the replacement in the zone files.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The IPv4 address to use as the replacement in the zone files.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com domain-1=example1.com domain-2=example2.com</span> - Update multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com domain=example1.com domain=example2.com</span> - Update multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> - Update a single domain.</li></ul><div><div html="&lt;p&gt;The domain to perform the zone file updates on.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To update multiple domains, increment or duplicate the parameter name. For
example, &lt;code&gt;domain-0&lt;/code&gt;, &lt;code&gt;domain-1&lt;/code&gt;, and &lt;code&gt;domain-2&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain to perform the zone file updates on.</p>
<p><strong>Note:</strong></p>
<p>To update multiple domains, increment or duplicate the parameter name. For
example, <code>domain-0</code>, <code>domain-1</code>, and <code>domain-2</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="ftp_ip" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">ftp_ip</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;ipv4&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ftp_ip=192.0.2.1</span></div><div><div html="&lt;p&gt;The IPv4 address to use as the replacement for FTP records in the zone files.&lt;/p&gt;
&lt;p&gt;If this parameter is &lt;strong&gt;not&lt;/strong&gt; provided, then the system will use the &lt;code&gt;dest_ip&lt;/code&gt; value.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The IPv4 address to use as the replacement for FTP records in the zone files.</p>
<p>If this parameter is <strong>not</strong> provided, then the system will use the <code>dest_ip</code> value.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="source_ip" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">source_ip</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;ipv4&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">source_ip=192.0.2.0</span></div><div><div html="&lt;p&gt;The IPv4 address to replace in the zone files. The detected source IPv4 address is one of:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;If there is an A record for the root of the zone &lt;strong&gt;and&lt;/strong&gt; the IP address is &lt;strong&gt;not&lt;/strong&gt; a loopback address, then the system will use its address.&lt;/li&gt;
&lt;li&gt;If there are any A records in the zone whose addresses are &lt;strong&gt;not&lt;/strong&gt; loopback addresses, then the system will use the address of the first such A record in the zone file.&lt;/li&gt;
&lt;li&gt;If no A records exist in the zone &lt;strong&gt;or&lt;/strong&gt; all A records have loopback addresses, then the system will &lt;strong&gt;not&lt;/strong&gt; update the zone file.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;If you do &lt;strong&gt;not&lt;/strong&gt; call this parameter, the system will automatically detect the IP addresses in the zone files.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The IPv4 address to replace in the zone files. The detected source IPv4 address is one of:</p>
<ul>
<li>If there is an A record for the root of the zone <strong>and</strong> the IP address is <strong>not</strong> a loopback address, then the system will use its address.</li>
<li>If there are any A records in the zone whose addresses are <strong>not</strong> loopback addresses, then the system will use the address of the first such A record in the zone file.</li>
<li>If no A records exist in the zone <strong>or</strong> all A records have loopback addresses, then the system will <strong>not</strong> update the zone file.</li>
</ul>
<p>If you do <strong>not</strong> call this parameter, the system will automatically detect the IP addresses in the zone files.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DNS/swap_ip_in_zones</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DNS/swap_ip_in_zones</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kt35a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kt35a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kt35a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kt35a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kt35a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kt35a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kt35a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kt35a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kt35a:0" aria-labelledby="tab:R4kt35a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--user</span><span class="token operator">=</span>username DNS swap_ip_in_zones <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span> <span class="token assign-left variable">source_ip</span><span class="token operator">=</span><span class="token string">'192.0.2.0'</span> <span class="token assign-left variable">dest_ip</span><span class="token operator">=</span><span class="token string">'192.0.2.1'</span></pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kt35a:1" aria-labelledby="tab:R4kt35a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kt35a:2" aria-labelledby="tab:R4kt35a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kt35a:3" aria-labelledby="tab:R4kt35a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4st35a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4st35a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4st35a:0" aria-labelledby="tab:R4st35a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;swap_ip_in_zones&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DNS&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"zone_name"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"record_name"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"record_type"</span>: <span class="token string">&quot;A&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"old_value"</span>: <span class="token string">&quot;192.0.2.0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"new_value"</span>: <span class="token string">&quot;192.0.2.1&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/DNS/operation/has_local_authority" data-section-id="tag/DNS/operation/has_local_authority" class="sc-dntaoT ceciOs"><div data-section-id="operation/has_local_authority" id="operation/has_local_authority" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS/operation/has_local_authority" aria-label="tag/DNS/operation/has_local_authority"></a>Return whether local DNS server is authoritative </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function checks whether the local server is authoritative for the domain&amp;#39;s DNS records.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether the local server is authoritative for the domain&#39;s DNS records.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain-0=example.com domain-1=example1.com domain-2=example2.com</span> - Check multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain=example.com domain=example1.com domain=example2.com</span> - Check multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> - Check a single domain.</li></ul><div><div html="&lt;p&gt;The domain to check whether the local server is authoritative for the domain&amp;#39;s
DNS records.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To check multiple domains, increment or duplicate the parameter name. For
example, &lt;code&gt;domain-0&lt;/code&gt;, &lt;code&gt;domain-1&lt;/code&gt;, and &lt;code&gt;domain-2&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain to check whether the local server is authoritative for the domain&#39;s
DNS records.</p>
<p><strong>Note:</strong></p>
<p>To check multiple domains, increment or duplicate the parameter name. For
example, <code>domain-0</code>, <code>domain-1</code>, and <code>domain-2</code>.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DNS/has_local_authority</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DNS/has_local_authority</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kv35a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kv35a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kv35a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kv35a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kv35a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kv35a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kv35a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kv35a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kv35a:0" aria-labelledby="tab:R4kv35a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DNS <span class="token punctuation">\</span>
  has_local_authority <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kv35a:1" aria-labelledby="tab:R4kv35a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kv35a:2" aria-labelledby="tab:R4kv35a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kv35a:3" aria-labelledby="tab:R4kv35a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sv35a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sv35a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sv35a:0" aria-labelledby="tab:R4sv35a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;has_local_authority&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DNS&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"local_authority"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nameservers"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;ns1.example.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;ns2.example.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"zone"</span>: <span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example2.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"local_authority"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nameservers"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example3.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <span class="token string">&quot;(XID 3z756a) DNS query (example3.com/SOA) timeout!&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"local_authority"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nameservers"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"zone"</span>: <span class="token string">&quot;example3.com&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/DNS-Information" data-section-id="tag/DNS-Information" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS-Information" aria-label="tag/DNS-Information"></a>DNS Information</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;DNS / DNS Information&lt;/p&gt;
"><p>DNS / DNS Information</p>
</div></div></div><div id="tag/DNS-Information/operation/ensure_domains_reside_only_locally" data-section-id="tag/DNS-Information/operation/ensure_domains_reside_only_locally" class="sc-dntaoT ceciOs"><div data-section-id="operation/ensure_domains_reside_only_locally" id="operation/ensure_domains_reside_only_locally" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS-Information/operation/ensure_domains_reside_only_locally" aria-label="tag/DNS-Information/operation/ensure_domains_reside_only_locally"></a>Return whether domains only resolve locally </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function indicates whether the account&amp;#39;s domains resolve exclusively to this server.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function indicates whether the account&#39;s domains resolve exclusively to this server.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain=example.com&amp;domain-1=example1.com&amp;domain-2=example2.com</span> - Multiple domains</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain=example.com&amp;domain=example1.com&amp;domain=example2.com</span> - Multiple domains</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> - A single domain.</li></ul><div><div html="&lt;p&gt;The domain to check.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To check multiple domains, duplicate or increment the parameter name. For example, to exclude three domains, you could:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;Use the &lt;code&gt;domain&lt;/code&gt; parameter multiple times.&lt;/li&gt;
&lt;li&gt;Use the &lt;code&gt;domain&lt;/code&gt;, &lt;code&gt;domain-1&lt;/code&gt;, and &lt;code&gt;domain-2&lt;/code&gt; parameters.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain to check.</p>
<p><strong>Note:</strong></p>
<p>To check multiple domains, duplicate or increment the parameter name. For example, to exclude three domains, you could:</p>
<ul>
<li>Use the <code>domain</code> parameter multiple times.</li>
<li>Use the <code>domain</code>, <code>domain-1</code>, and <code>domain-2</code> parameters.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DNS/ensure_domains_reside_only_locally</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DNS/ensure_domains_reside_only_locally</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kj55a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kj55a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kj55a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj55a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kj55a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj55a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kj55a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj55a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kj55a:0" aria-labelledby="tab:R4kj55a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DNS <span class="token punctuation">\</span>
  ensure_domains_reside_only_locally <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj55a:1" aria-labelledby="tab:R4kj55a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj55a:2" aria-labelledby="tab:R4kj55a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj55a:3" aria-labelledby="tab:R4kj55a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sj55a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sj55a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sj55a:0" aria-labelledby="tab:R4sj55a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;ensure_domains_reside_only_locally&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DNS&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;The domain resolves to Mars. Beep beep beep.&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/DNS-Information/operation/DNS::is_alias_available" data-section-id="tag/DNS-Information/operation/DNS::is_alias_available" class="sc-dntaoT ceciOs"><div data-section-id="operation/DNS::is_alias_available" id="operation/DNS::is_alias_available" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS-Information/operation/DNS::is_alias_available" aria-label="tag/DNS-Information/operation/DNS::is_alias_available"></a>Return `ALIAS` DNS record availability &amp; resolver </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns whether &lt;code&gt;ALIAS&lt;/code&gt; and &lt;code&gt;ANAME&lt;/code&gt; records are available and the value of the running PowerDNS (PDNS) &lt;code&gt;resolver&lt;/code&gt; setting, if any exists.
For more information, read our &lt;a href=&quot;https://go.cpanel.net/dns-alias-record&quot;&gt;&lt;code&gt;ALIAS&lt;/code&gt; documentation&lt;/a&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns whether <code>ALIAS</code> and <code>ANAME</code> records are available and the value of the running PowerDNS (PDNS) <code>resolver</code> setting, if any exists.
For more information, read our <a href="https://go.cpanel.net/dns-alias-record"><code>ALIAS</code> documentation</a>.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DNS/is_alias_available</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DNS/is_alias_available</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kl55a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kl55a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kl55a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl55a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kl55a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl55a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kl55a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl55a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kl55a:0" aria-labelledby="tab:R4kl55a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token parameter variable">--user</span><span class="token operator">=</span>username DNS is_alias_available
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl55a:1" aria-labelledby="tab:R4kl55a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl55a:2" aria-labelledby="tab:R4kl55a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl55a:3" aria-labelledby="tab:R4kl55a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sl55a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sl55a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sl55a:0" aria-labelledby="tab:R4sl55a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;is_alias_available&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DNS&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"alias"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"aname"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"resolver"</span>: <span class="token string">&quot;8.8.8.8&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/DNS-Information/operation/dns-lookup" data-section-id="tag/DNS-Information/operation/dns-lookup" class="sc-dntaoT ceciOs"><div data-section-id="operation/dns-lookup" id="operation/dns-lookup" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS-Information/operation/dns-lookup" aria-label="tag/DNS-Information/operation/dns-lookup"></a>Return domain&#x27;s DNS information </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns DNS zone information about a domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns DNS zone information about a domain.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;A fully qualified domain name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A fully qualified domain name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DNS/lookup</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DNS/lookup</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kn55a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kn55a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kn55a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn55a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kn55a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn55a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kn55a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn55a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kn55a:0" aria-labelledby="tab:R4kn55a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DNS <span class="token punctuation">\</span>
  lookup <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn55a:1" aria-labelledby="tab:R4kn55a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn55a:2" aria-labelledby="tab:R4kn55a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn55a:3" aria-labelledby="tab:R4kn55a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sn55a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sn55a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sn55a:0" aria-labelledby="tab:R4sn55a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;lookup&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DNS&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example.com has address 93.184.216.34&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;example.com has IPv6 address 2606:2800:220:1:248:1893:25c8:1946&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;example.com mail is handled by 0 .&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/DNS-Information/operation/dns-parse_zone" data-section-id="tag/DNS-Information/operation/dns-parse_zone" class="sc-dntaoT ceciOs"><div data-section-id="operation/dns-parse_zone" id="operation/dns-parse_zone" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS-Information/operation/dns-parse_zone" aria-label="tag/DNS-Information/operation/dns-parse_zone"></a>Return a parsed DNS zone </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function parses a given DNS zone.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;Most DNS zones contain only 7-bit ASCII. However, it is possible for
DNS zones to contain any binary sequence. An application that decodes
this function&amp;#39;s base64 output &lt;strong&gt;must&lt;/strong&gt; be able to handle cases
where the decoded octets do not match any specific character
encoding.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function parses a given DNS zone.</p>
<p><strong>Important:</strong></p>
<p>Most DNS zones contain only 7-bit ASCII. However, it is possible for
DNS zones to contain any binary sequence. An application that decodes
this function&#39;s base64 output <strong>must</strong> be able to handle cases
where the decoded octets do not match any specific character
encoding.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="zone" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">zone</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">zone=example.com</span></div><div><div html="&lt;p&gt;The name of one of the user’s DNS zones.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of one of the user’s DNS zones.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DNS/parse_zone</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DNS/parse_zone</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kp55a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kp55a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kp55a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp55a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kp55a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp55a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kp55a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp55a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kp55a:0" aria-labelledby="tab:R4kp55a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DNS <span class="token punctuation">\</span>
  parse_zone <span class="token punctuation">\</span>
  <span class="token assign-left variable">zone</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp55a:1" aria-labelledby="tab:R4kp55a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp55a:2" aria-labelledby="tab:R4kp55a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp55a:3" aria-labelledby="tab:R4kp55a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sp55a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sp55a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sp55a:0" aria-labelledby="tab:R4sp55a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;parse_zone&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DNS&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"line_index"</span>: <span class="token number">22</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;record&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data_b64"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;dGV4YXMuY29tLg==&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dname_b64"</span>: <span class="token string">&quot;dGV4YXMuY29tLg==&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"record_type"</span>: <span class="token string">&quot;MX&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ttl"</span>: <span class="token number">14400</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/DNS-Information/operation/dns-mass_edit_zone" data-section-id="tag/DNS-Information/operation/dns-mass_edit_zone" class="sc-dntaoT ceciOs"><div data-section-id="operation/dns-mass_edit_zone" id="operation/dns-mass_edit_zone" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS-Information/operation/dns-mass_edit_zone" aria-label="tag/DNS-Information/operation/dns-mass_edit_zone"></a>Update a DNS zone </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function updates a given DNS zone. It can add, edit,
and remove many records in a single call. It also ensures
that each record not removed will occupy the same
number of lines after the edit as it did before the edit.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function updates a given DNS zone. It can add, edit,
and remove many records in a single call. It also ensures
that each record not removed will occupy the same
number of lines after the edit as it did before the edit.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="add" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">add</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">strings</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;json&gt; </span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR gjyOxn kpFoWb">[ items<span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;json &gt;</span> ]</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">add=&#x27;{&quot;dname&quot;:&quot;example&quot;, &quot;ttl&quot;:14400, &quot;record_type&quot;:&quot;A&quot;, &quot;data&quot;:[&quot;11.22.33.44&quot;]}&#x27;</span> - An A record.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">add=&#x27;{&quot;dname&quot;:&quot;example&quot;, &quot;ttl&quot;:14400, &quot;record_type&quot;:&quot;TXT&quot;, &quot;data&quot;:[&quot;string1&quot;, &quot;string2&quot;]}&#x27;</span> - A TXT record.</li></ul><div><div html="&lt;p&gt;The records to add to the zone. Each item must be a serialized
JSON object that contains:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;dname&lt;/code&gt; — The record’s name.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;ttl&lt;/code&gt; — The record’s TTL (Time-To-Live) value.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;record_type&lt;/code&gt; — The record’s type. For example, &lt;code&gt;A&lt;/code&gt; or &lt;code&gt;TXT&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;data&lt;/code&gt; — An array of strings. The format and number of the
strings depend on the &lt;code&gt;record_type&lt;/code&gt; value.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The records to add to the zone. Each item must be a serialized
JSON object that contains:</p>
<ul>
<li><code>dname</code> — The record’s name.</li>
<li><code>ttl</code> — The record’s TTL (Time-To-Live) value.</li>
<li><code>record_type</code> — The record’s type. For example, <code>A</code> or <code>TXT</code>.</li>
<li><code>data</code> — An array of strings. The format and number of the
strings depend on the <code>record_type</code> value.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="edit" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">edit</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">strings</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;json&gt; </span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR gjyOxn kpFoWb">[ items<span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;json &gt;</span> ]</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">edit=&#x27;{&quot;line_index&quot;: 9, &quot;dname&quot;:&quot;example&quot;, &quot;ttl&quot;:14400, &quot;record_type&quot;:&quot;TXT&quot;, &quot;data&quot;:[&quot;string1&quot;, &quot;string2&quot;]}&#x27;</span></div><div><div html="&lt;p&gt;The records to edit in the zone. Each item must be a serialized
JSON object that contains:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;line_index&lt;/code&gt; — The line number in the DNS zone where the record starts.
This is a 0-based index, so to edit the first line in the file
use the &lt;code&gt;0&lt;/code&gt; value. To edit the second line, give &lt;code&gt;1&lt;/code&gt;, and so forth.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;dname&lt;/code&gt; — The record’s name.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;ttl&lt;/code&gt; — The record’s TTL (Time-To-Live) value.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;record_type&lt;/code&gt; — The record’s new type. For example, &lt;code&gt;A&lt;/code&gt; or &lt;code&gt;TXT&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;data&lt;/code&gt; — An array of strings. The format and number of the
strings depend on the &lt;code&gt;record_type&lt;/code&gt; value.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The records to edit in the zone. Each item must be a serialized
JSON object that contains:</p>
<ul>
<li><code>line_index</code> — The line number in the DNS zone where the record starts.
This is a 0-based index, so to edit the first line in the file
use the <code>0</code> value. To edit the second line, give <code>1</code>, and so forth.</li>
<li><code>dname</code> — The record’s name.</li>
<li><code>ttl</code> — The record’s TTL (Time-To-Live) value.</li>
<li><code>record_type</code> — The record’s new type. For example, <code>A</code> or <code>TXT</code>.</li>
<li><code>data</code> — An array of strings. The format and number of the
strings depend on the <code>record_type</code> value.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="remove" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">remove</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integers</span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR gjyOxn kpFoWb">[ items<span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= 0 </span></span> ]</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">remove=22</span></div><div><div html="&lt;p&gt;The line indexes of records to remove from the zone.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The line indexes of records to remove from the zone.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="serial" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">serial</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= 0 </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">serial=202001010100</span></div><div><div html="&lt;p&gt;The current serial number in the DNS zone’s SOA (Start of Authority)
record. If this value does not match the zone’s current state, the
request fails.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The current serial number in the DNS zone’s SOA (Start of Authority)
record. If this value does not match the zone’s current state, the
request fails.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="zone" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">zone</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">zone=example.com</span></div><div><div html="&lt;p&gt;The name of one of the user’s DNS zones.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of one of the user’s DNS zones.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DNS/mass_edit_zone</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DNS/mass_edit_zone</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kr55a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kr55a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kr55a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kr55a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kr55a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kr55a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kr55a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kr55a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kr55a:0" aria-labelledby="tab:R4kr55a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token parameter variable">--user</span><span class="token operator">=</span>username DNS mass_edit_zone <span class="token assign-left variable">zone</span><span class="token operator">=</span><span class="token string">'example.com'</span> <span class="token assign-left variable">serial</span><span class="token operator">=</span><span class="token string">'202001010100'</span> <span class="token assign-left variable">remove</span><span class="token operator">=</span><span class="token number">23</span> <span class="token assign-left variable">add</span><span class="token operator">=</span><span class="token string">'{"dname":"example","ttl":14400,"record_type":"A","data":["127.0.0.1"]}'</span></pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kr55a:1" aria-labelledby="tab:R4kr55a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kr55a:2" aria-labelledby="tab:R4kr55a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kr55a:3" aria-labelledby="tab:R4kr55a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sr55a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sr55a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sr55a:0" aria-labelledby="tab:R4sr55a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;mass_edit_zone&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DNS&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"new_serial"</span>: <span class="token number">2021031903</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/DNS-Information/operation/has_local_authority" data-section-id="tag/DNS-Information/operation/has_local_authority" class="sc-dntaoT ceciOs"><div data-section-id="operation/has_local_authority" id="operation/has_local_authority" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS-Information/operation/has_local_authority" aria-label="tag/DNS-Information/operation/has_local_authority"></a>Return whether local DNS server is authoritative </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function checks whether the local server is authoritative for the domain&amp;#39;s DNS records.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether the local server is authoritative for the domain&#39;s DNS records.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain-0=example.com domain-1=example1.com domain-2=example2.com</span> - Check multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain=example.com domain=example1.com domain=example2.com</span> - Check multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> - Check a single domain.</li></ul><div><div html="&lt;p&gt;The domain to check whether the local server is authoritative for the domain&amp;#39;s
DNS records.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To check multiple domains, increment or duplicate the parameter name. For
example, &lt;code&gt;domain-0&lt;/code&gt;, &lt;code&gt;domain-1&lt;/code&gt;, and &lt;code&gt;domain-2&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain to check whether the local server is authoritative for the domain&#39;s
DNS records.</p>
<p><strong>Note:</strong></p>
<p>To check multiple domains, increment or duplicate the parameter name. For
example, <code>domain-0</code>, <code>domain-1</code>, and <code>domain-2</code>.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DNS/has_local_authority</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DNS/has_local_authority</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kt55a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kt55a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kt55a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kt55a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kt55a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kt55a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kt55a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kt55a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kt55a:0" aria-labelledby="tab:R4kt55a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DNS <span class="token punctuation">\</span>
  has_local_authority <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kt55a:1" aria-labelledby="tab:R4kt55a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kt55a:2" aria-labelledby="tab:R4kt55a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kt55a:3" aria-labelledby="tab:R4kt55a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4st55a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4st55a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4st55a:0" aria-labelledby="tab:R4st55a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;has_local_authority&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DNS&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"local_authority"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nameservers"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;ns1.example.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;ns2.example.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"zone"</span>: <span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example2.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"local_authority"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nameservers"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example3.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <span class="token string">&quot;(XID 3z756a) DNS query (example3.com/SOA) timeout!&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"local_authority"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nameservers"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"zone"</span>: <span class="token string">&quot;example3.com&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/DNS-Security" data-section-id="tag/DNS-Security" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS-Security" aria-label="tag/DNS-Security"></a>DNS Security</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;DNS / DNS Security&lt;/p&gt;
"><p>DNS / DNS Security</p>
</div></div></div><div id="tag/DNS-Security/operation/unset_nsec3" data-section-id="tag/DNS-Security/operation/unset_nsec3" class="sc-dntaoT ceciOs"><div data-section-id="operation/unset_nsec3" id="operation/unset_nsec3" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS-Security/operation/unset_nsec3" aria-label="tag/DNS-Security/operation/unset_nsec3"></a>Update domain to use NSEC </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function configures the domain to use &lt;a href=&quot;https://tools.ietf.org/html/rfc4470&quot;&gt;Next Secure Record&lt;/a&gt; (NSEC) semantics instead of Next Secure Record 3 (NSEC3) semantics.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;DNS role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function configures the domain to use <a href="https://tools.ietf.org/html/rfc4470">Next Secure Record</a> (NSEC) semantics instead of Next Secure Record 3 (NSEC3) semantics.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">DNS role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The domain on which to disable NSEC3 semantics and use NSEC semantics.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain on which to disable NSEC3 semantics and use NSEC semantics.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DNSSEC/unset_nsec3</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DNSSEC/unset_nsec3</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99375a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99375a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99375a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99375a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99375a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99375a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99375a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99375a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99375a:0" aria-labelledby="tab:R99375a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DNSSEC <span class="token punctuation">\</span>
  unset_nsec3 <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99375a:1" aria-labelledby="tab:R99375a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99375a:2" aria-labelledby="tab:R99375a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99375a:3" aria-labelledby="tab:R99375a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p375a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p375a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p375a:0" aria-labelledby="tab:R9p375a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;unset_nsec3&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DNSSEC&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"disabled"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"example.com"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/DNS-Security/operation/export_zone_key" data-section-id="tag/DNS-Security/operation/export_zone_key" class="sc-dntaoT ceciOs"><div data-section-id="operation/export_zone_key" id="operation/export_zone_key" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS-Security/operation/export_zone_key" aria-label="tag/DNS-Security/operation/export_zone_key"></a>Export DNSSEC security key </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function exports a DNSSEC security key.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;DNS&lt;/a&gt; role, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function exports a DNSSEC security key.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">DNS</a> role, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The security key&amp;#39;s domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The security key&#39;s domain.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="key_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">key_id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= 1 </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key_id=12345</span></div><div><div html="&lt;p&gt;The security key&amp;#39;s ID.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The security key&#39;s ID.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DNSSEC/export_zone_key</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DNSSEC/export_zone_key</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99575a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99575a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99575a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99575a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99575a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99575a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99575a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99575a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99575a:0" aria-labelledby="tab:R99575a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DNSSEC <span class="token punctuation">\</span>
  export_zone_key <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">key_id</span><span class="token operator">=</span><span class="token string">'12345'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99575a:1" aria-labelledby="tab:R99575a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99575a:2" aria-labelledby="tab:R99575a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99575a:3" aria-labelledby="tab:R99575a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p575a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p575a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p575a:0" aria-labelledby="tab:R9p575a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;export_zone_key&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DNSSEC&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_content"</span>: <span class="token string">&quot;Private-key-format: v1.2\nAlgorithm: 8 (RSASHA256)\nModulus: 9i8AlGZkwKJj6HYZX+9OcOyCMQ0L9eHBaTg2Y83cVBSaIyiIWo54QpuiJykiuFYYHihOi+LW8vfU9A9jXLBs7DaeDkXO49OqYxfgD1vwmztJeXCQlmgxqUeD181gtSTNO43uUMkCisZft+OsJ96bdUof1UeJ1+IuSENBr1TZgYjmzBgIkmjdv8T5muPaaDfeOISLJKGOG2gI0xlyQ39ppd3CeB90cpIvFpCGjNC8nGvIqN4oyny6NftcEhaRFudbEhB6t2gI362wS5ohERK1F1rBTt+mqUwszCv46Y6p3Za3PsebWK7fR6ITnsW7KGyn3r8BxpJTHlHMwOtBPosaXw==\nPublicExponent: AQAB\nPrivateExponent: MZO5nCkatSh+0jumVImO1HLsrRAhjnzORHBLk8HLUytq9xWckBAM6+0HtLc2BMVhygD4AHfILdn3CsdmjS4CYXeGUP2B8qOXtqkCOFWdmMVRwKEInSGSjrKWPIlhplko84tbqO0yE9xrPk8dRlIwIGizDHKBsfYct/TDb5m4y7rvEHcBSm2DZz7AQL1qqC/WYI54qxHFXTId+nKsYMx/alRUV3AOSL20VSgL56VcM1luFS76ylDIWEOrQVyTFCtEcHvw3FLIOEVCM/CAErLFNlFdXHnYcRYnG/oXcsPW0DjpPNrqx8iaAOuhYFd/pu9CvKQnxYLLqXByOkSUIO3ggQ==\nPrime1: /mtiBD3gJ5Yu5ARsLew4eohRAobl4c3Bt9Gw62wmHiOJfgjbnY91H/bxc/ilnQh92yZUfxfm5z6FXEqluh0ZN3BOQTwzUEuTT9Pn00FhRfemL0UMpHn0BkoXCLwjs1XRyI0hXTOhGhH7XVczuYw/S7kWT5Cmfo4MODZ6cooR8SE=\nPrime2: 97aFfZxJcTYTKkZTc7yeUQVWTtKF25L780TRuCiG83hTSNKlmuWE2bAU/Cl2CX2NdW5sBmO5z9fEI5rA8LhuWHlKF82cXg1h50CsXkaAhFKrThMmb6SRSjIksxlz7rtK777z4En/V9v3l1yKcQ5eSQYQRHg1cCkn6NNlZPZ2G38=\nExponent1: LoHarQPSken2MGBOliZ0PJHmnRujsh82pi+Cs8ZVQXUlkRB1dNvggTNW9+gf/hCrUQA0ufbYkrTvE+vhV6AyF9xDsdEbYDYwe4s0+X0eFvgqPMHWicpxPSUWCNa7f/DUJGEIFE13yZg35twl7GkiuOjglzLN/Jxix3PN9loe5YE=\nExponent2: Mya4iAimzb7p1DfzcZnIY1ijyuEEDSRb7I8Qc2PDAjGdmRMOaV7twPnwS2XQXwNTG6Wyntsm+nlGokeJgevDtXdOSn4FxRIkXllnfow2a5yajSO9Mx6bdePG2kjuPKTmQ3195JnDJYRhqxrL566c351l7I2aE1AcUqKcdG3EU8c=\nCoefficient: T4dFDz5pQhVUQSjV0hhKHHZ1wBxiXdZeCFIfbyypWEdxGXdX2lIN264u9cGQhI+iExTEjZCaYASMBzOqnIhkHhj0M1DGYrhRCdTpgxmDwdcHniRl/XMxPGqpmsP4WFCBxmIbr3SdnqoiPMXix0SjWkHTisq5i09DBMNGIGQyqS8=\n\n&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_id"</span>: <span class="token number">12345</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_tag"</span>: <span class="token number">51640</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_type"</span>: <span class="token string">&quot;KSK&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"success"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/DNS-Security/operation/enable_dnssec" data-section-id="tag/DNS-Security/operation/enable_dnssec" class="sc-dntaoT ceciOs"><div data-section-id="operation/enable_dnssec" id="operation/enable_dnssec" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS-Security/operation/enable_dnssec" aria-label="tag/DNS-Security/operation/enable_dnssec"></a>Enable DNSSEC </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function enables DNSSEC on the domain.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;After you enable DNSSEC on the domain, you &lt;strong&gt;must&lt;/strong&gt; add the DNS records to your registrar.&lt;/li&gt;
&lt;li&gt;You &lt;strong&gt;cannot&lt;/strong&gt; modify the DNSSEC security key. To make any changes, you &lt;strong&gt;must&lt;/strong&gt; disable (and delete) and re-create the DNSSEC security key.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;DNS role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables DNSSEC on the domain.</p>
<p><strong>Note:</strong></p>
<ul>
<li>After you enable DNSSEC on the domain, you <strong>must</strong> add the DNS records to your registrar.</li>
<li>You <strong>cannot</strong> modify the DNSSEC security key. To make any changes, you <strong>must</strong> disable (and delete) and re-create the DNSSEC security key.</li>
</ul>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">DNS role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="active" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">active</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">active=1</span></div><div><div html="&lt;p&gt;Whether to activate the newly-created key.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Activate the key.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Do &lt;strong&gt;not&lt;/strong&gt; activate the key.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to activate the newly-created key.</p>
<ul>
<li><code>1</code> — Activate the key.</li>
<li><code>0</code> — Do <strong>not</strong> activate the key.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="algo_num" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">algo_num</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> [ 0 .. 255 ] </span></span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">8</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">algo_num=8</span></div><div><div html="&lt;p&gt;The algorithm that the system uses to generate the security key.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;5&lt;/code&gt; — RSA/SHA-1&lt;/li&gt;
&lt;li&gt;&lt;code&gt;6&lt;/code&gt; — DSA-NSEC3-SHA1&lt;/li&gt;
&lt;li&gt;&lt;code&gt;7&lt;/code&gt; — RSASHA1-NSEC3-SHA1&lt;/li&gt;
&lt;li&gt;&lt;code&gt;8&lt;/code&gt; — RSA/SHA-256&lt;/li&gt;
&lt;li&gt;&lt;code&gt;10&lt;/code&gt; — RSA/SHA-512&lt;/li&gt;
&lt;li&gt;&lt;code&gt;13&lt;/code&gt; — ECDSA Curve P-256 with SHA-256&lt;/li&gt;
&lt;li&gt;&lt;code&gt;14&lt;/code&gt; — ECDSA Curve P-384 with SHA-384&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; We recommend that you use &lt;code&gt;ECDSA Curve P-256 with SHA-256&lt;/code&gt; if your registrar supports it.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The algorithm that the system uses to generate the security key.</p>
<ul>
<li><code>5</code> — RSA/SHA-1</li>
<li><code>6</code> — DSA-NSEC3-SHA1</li>
<li><code>7</code> — RSASHA1-NSEC3-SHA1</li>
<li><code>8</code> — RSA/SHA-256</li>
<li><code>10</code> — RSA/SHA-512</li>
<li><code>13</code> — ECDSA Curve P-256 with SHA-256</li>
<li><code>14</code> — ECDSA Curve P-384 with SHA-384</li>
</ul>
<p><strong>Note:</strong></p>
<p> We recommend that you use <code>ECDSA Curve P-256 with SHA-256</code> if your registrar supports it.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain-0=example0.com&amp;domain-1=example1.com&amp;domain-2=example2.com</span> - To enable DNSSEC on multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> - To enable DNSSEC on a single domain.</li></ul><div><div html="&lt;p&gt;The domain on which to enable DNSSEC.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; To enable DNSSEC on multiple domains, increment the parameter name. For example: &lt;code&gt;domain-0&lt;/code&gt;, &lt;code&gt;domain-1&lt;/code&gt;, &lt;code&gt;domain-2&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain on which to enable DNSSEC.</p>
<p><strong>Note:</strong></p>
<p> To enable DNSSEC on multiple domains, increment the parameter name. For example: <code>domain-0</code>, <code>domain-1</code>, <code>domain-2</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="key_setup" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">key_setup</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;classic&quot;</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;simple&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;classic&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key_setup=classic</span></div><div><div html="&lt;p&gt;The manner in which the system creates the security key.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;simple&lt;/code&gt; — Use a single key for both KSK and ZSK. Use this value when the &lt;code&gt;algo_nom&lt;/code&gt; parameter is greater than &lt;code&gt;8&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;classic&lt;/code&gt; — Use separate keys for KSK and ZSK. Use this value when the &lt;code&gt;algo_nom&lt;/code&gt; parameter is equal to or less than &lt;code&gt;8&lt;/code&gt;.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The manner in which the system creates the security key.</p>
<ul>
<li><code>simple</code> — Use a single key for both KSK and ZSK. Use this value when the <code>algo_nom</code> parameter is greater than <code>8</code>.</li>
<li><code>classic</code> — Use separate keys for KSK and ZSK. Use this value when the <code>algo_nom</code> parameter is equal to or less than <code>8</code>.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="nsec3_iterations" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">nsec3_iterations</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> [ 1 .. 500 ] </span></span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">7</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">nsec3_iterations=7</span></div><div><div html="&lt;p&gt;The number of times that the system rehashes the first resource record hash operation.&lt;/p&gt;
&lt;p&gt;A positive integer less than &lt;code&gt;501&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The number of times that the system rehashes the first resource record hash operation.</p>
<p>A positive integer less than <code>501</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="nsec3_narrow" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">nsec3_narrow</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">nsec3_narrow=1</span></div><div><div html="&lt;p&gt;Whether NSEC3 will operate in Narrow or Inclusive mode.&lt;/p&gt;
&lt;p&gt;In Narrow mode, PowerDNS sends out white lies about the next secure record. Rather than query the resource record in the database, PowerDNS sends the hash plus &lt;code&gt;1&lt;/code&gt; as the next secure record.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Narrow mode.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Inclusive mode.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether NSEC3 will operate in Narrow or Inclusive mode.</p>
<p>In Narrow mode, PowerDNS sends out white lies about the next secure record. Rather than query the resource record in the database, PowerDNS sends the hash plus <code>1</code> as the next secure record.</p>
<ul>
<li><code>1</code> — Narrow mode.</li>
<li><code>0</code> — Inclusive mode.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="nsec3_opt_out" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">nsec3_opt_out</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">nsec3_opt_out=0</span></div><div><div html="&lt;p&gt;Whether the system will create records for all delegations.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Create records for all delegations.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Create records only for secure delegations.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; &lt;strong&gt;Only&lt;/strong&gt; select &lt;code&gt;1&lt;/code&gt; if you &lt;strong&gt;must&lt;/strong&gt; create records for all delegations.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the system will create records for all delegations.</p>
<ul>
<li><code>1</code> — Create records for all delegations.</li>
<li><code>0</code> — Create records only for secure delegations.</li>
</ul>
<p><strong>Note:</strong></p>
<p> <strong>Only</strong> select <code>1</code> if you <strong>must</strong> create records for all delegations.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="nsec3_salt" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">nsec3_salt</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;hex&gt; </span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &lt;= 255 characters </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">nsec3_salt=1A2B3C4D5E6F</span></div><div><div html="&lt;p&gt;A hexadecimal string that the system appends to the domain name before it applies the hash function to the name. For more information about the salt value, read the &lt;a href=&quot;https://tools.ietf.org/html/rfc5155#section-3.1.5&quot;&gt;RFC 5155&lt;/a&gt; documentation.&lt;/p&gt;
&lt;p&gt;If you do not declare a value, the system defaults to a random 64-bit value.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A hexadecimal string that the system appends to the domain name before it applies the hash function to the name. For more information about the salt value, read the <a href="https://tools.ietf.org/html/rfc5155#section-3.1.5">RFC 5155</a> documentation.</p>
<p>If you do not declare a value, the system defaults to a random 64-bit value.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="use_nsec3" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">use_nsec3</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">use_nsec3=1</span></div><div><div html="&lt;p&gt;Whether the domain will use &lt;a href=&quot;https://tools.ietf.org/html/rfc4470&quot;&gt;Next Secure Record&lt;/a&gt; (NSEC) or NSEC3 semantics.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Use NSEC3 semantics.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Use NSEC semantics.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; If you use NSEC semantics (&lt;code&gt;0&lt;/code&gt;), the system ignores the other NSEC3 options.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the domain will use <a href="https://tools.ietf.org/html/rfc4470">Next Secure Record</a> (NSEC) or NSEC3 semantics.</p>
<ul>
<li><code>1</code> — Use NSEC3 semantics.</li>
<li><code>0</code> — Use NSEC semantics.</li>
</ul>
<p><strong>Note:</strong></p>
<p> If you use NSEC semantics (<code>0</code>), the system ignores the other NSEC3 options.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DNSSEC/enable_dnssec</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DNSSEC/enable_dnssec</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99775a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99775a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99775a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99775a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99775a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99775a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99775a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99775a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99775a:0" aria-labelledby="tab:R99775a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DNSSEC <span class="token punctuation">\</span>
  enable_dnssec <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99775a:1" aria-labelledby="tab:R99775a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99775a:2" aria-labelledby="tab:R99775a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99775a:3" aria-labelledby="tab:R99775a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p775a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p775a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p775a:0" aria-labelledby="tab:R9p775a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;enable_dnssec&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DNSSEC&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"example.com"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"new_key_id"</span>: <span class="token string">&quot;1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nsec_version"</span>: <span class="token string">&quot;NSEC3&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/DNS-Security/operation/import_zone_key" data-section-id="tag/DNS-Security/operation/import_zone_key" class="sc-dntaoT ceciOs"><div data-section-id="operation/import_zone_key" id="operation/import_zone_key" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS-Security/operation/import_zone_key" aria-label="tag/DNS-Security/operation/import_zone_key"></a>Add DNSSEC security key </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function imports a DNSSEC security key.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;DNS role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function imports a DNSSEC security key.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">DNS role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The security key&amp;#39;s domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The security key&#39;s domain.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="key_data" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">key_data</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key_data=Private-key-format:%20v1.2%0AAlgorithm:%2013%20$ECDSAP256SHA256$%0APrivateKey:%20xCM281KtWE9oCsUX8fP1hDZ02/X7JCjp4QZA/DZjfX0=%0A%0A</span></div><div><div html="&lt;p&gt;The security key data that the &lt;a href=&quot;https://doc.powerdns.com/authoritative/manpages/pdnsutil.1.html&quot;&gt;&lt;code&gt;pdnsutil&lt;/code&gt;&lt;/a&gt;
utility&amp;#39;s &lt;code&gt;export-zone-key&lt;/code&gt; call returns.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The security key data that the <a href="https://doc.powerdns.com/authoritative/manpages/pdnsutil.1.html"><code>pdnsutil</code></a>
utility&#39;s <code>export-zone-key</code> call returns.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="key_type" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">key_type</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;ksk&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;zsk&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key_type=ksk</span></div><div><div html="&lt;p&gt;The security key&amp;#39;s type.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;ksk&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;zsk&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The security key&#39;s type.</p>
<ul>
<li><code>ksk</code></li>
<li><code>zsk</code></li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DNSSEC/import_zone_key</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DNSSEC/import_zone_key</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99975a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99975a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99975a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99975a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99975a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99975a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99975a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99975a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99975a:0" aria-labelledby="tab:R99975a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DNSSEC <span class="token punctuation">\</span>
  import_zone_key <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">key_type</span><span class="token operator">=</span><span class="token string">'ksk'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">key_data</span><span class="token operator">=</span><span class="token string">$'Private-key-format:%20v1.2%0AAlgorithm:%2013%20<span class="token entity" title="\\">\\</span>(ECDSAP256SHA256<span class="token entity" title="\\">\\</span>)%0APrivateKey:%20xCM281KtWE9oCsUX8fP1hDZ02/X7JCjp4QZA/DZjfX0=%0A%0A'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99975a:1" aria-labelledby="tab:R99975a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99975a:2" aria-labelledby="tab:R99975a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99975a:3" aria-labelledby="tab:R99975a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p975a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p975a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p975a:0" aria-labelledby="tab:R9p975a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;import_zone_key&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DNSSEC&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"new_key_id"</span>: <span class="token string">&quot;1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"success"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/DNS-Security/operation/export_zone_dnskey" data-section-id="tag/DNS-Security/operation/export_zone_dnskey" class="sc-dntaoT ceciOs"><div data-section-id="operation/export_zone_dnskey" id="operation/export_zone_dnskey" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS-Security/operation/export_zone_dnskey" aria-label="tag/DNS-Security/operation/export_zone_dnskey"></a>Export DNSKEY record value </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function exports a domain&amp;#39;s DNSKEY record value.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;DNS&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function exports a domain&#39;s DNSKEY record value.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles"><em>DNS</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The domain from which to fetch the DNSKEY record value.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain from which to fetch the DNSKEY record value.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="key_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">key_id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= 1 </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key_id=12345</span></div><div><div html="&lt;p&gt;The DNSSEC record&amp;#39;s ID.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The DNSSEC record&#39;s ID.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DNSSEC/export_zone_dnskey</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DNSSEC/export_zone_dnskey</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99b75a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99b75a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99b75a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b75a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99b75a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b75a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99b75a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b75a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99b75a:0" aria-labelledby="tab:R99b75a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DNSSEC <span class="token punctuation">\</span>
  export_zone_dnskey <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">key_id</span><span class="token operator">=</span><span class="token string">'12345'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b75a:1" aria-labelledby="tab:R99b75a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b75a:2" aria-labelledby="tab:R99b75a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b75a:3" aria-labelledby="tab:R99b75a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pb75a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pb75a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pb75a:0" aria-labelledby="tab:R9pb75a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;export_zone_dnskey&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DNSSEC&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dnskey"</span>: <span class="token string">&quot;AwEAAch8SGW4vE6PjFWA9rbUm0AfTq+gJ0HC/nLu+2axdWHBIStt9lsOzKDorAr4vlmhlJzEzA62s96xp6mZ7XHUyWnkFwLs8obo6upL2in4h1ToOxzVl3lTs8O+kWtDq5/h1nwFlPDs9zpLJhlkTCtx2OTGbvimEYeqwPolUuSQR/Yb&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_id"</span>: <span class="token number">12345</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"success"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/DNS-Security/operation/fetch_ds_records" data-section-id="tag/DNS-Security/operation/fetch_ds_records" class="sc-dntaoT ceciOs"><div data-section-id="operation/fetch_ds_records" id="operation/fetch_ds_records" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS-Security/operation/fetch_ds_records" aria-label="tag/DNS-Security/operation/fetch_ds_records"></a>Return domain&#x27;s DS records </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function fetches a domain&amp;#39;s Delegation of Signing (DS) records.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;DNS role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function fetches a domain&#39;s Delegation of Signing (DS) records.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">DNS role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain-0=example0.com&amp;domain-1=example1.com&amp;domain-2=example2.com</span> - To fetch DS records on multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> - To fetch DS records on a single domain.</li></ul><div><div html="&lt;p&gt;The domain from which to fetch DS records.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; To enable DNSSEC on multiple domains, increment the parameter name. For example: &lt;code&gt;domain-0&lt;/code&gt;, &lt;code&gt;domain-1&lt;/code&gt;, &lt;code&gt;domain-2&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain from which to fetch DS records.</p>
<p><strong>Note:</strong></p>
<p> To enable DNSSEC on multiple domains, increment the parameter name. For example: <code>domain-0</code>, <code>domain-1</code>, <code>domain-2</code>.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DNSSEC/fetch_ds_records</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DNSSEC/fetch_ds_records</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99d75a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99d75a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99d75a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d75a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99d75a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d75a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99d75a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d75a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99d75a:0" aria-labelledby="tab:R99d75a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DNSSEC <span class="token punctuation">\</span>
  fetch_ds_records <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99d75a:1" aria-labelledby="tab:R99d75a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99d75a:2" aria-labelledby="tab:R99d75a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99d75a:3" aria-labelledby="tab:R99d75a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pd75a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pd75a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pd75a:0" aria-labelledby="tab:R9pd75a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;fetch_ds_records&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DNSSEC&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"example.com"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"keys"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"33930"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"active"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"algo_desc"</span>: <span class="token string">&quot;RSA/SHA-256&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"algo_num"</span>: <span class="token string">&quot;8&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"algo_tag"</span>: <span class="token string">&quot;RSASHA256&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"bits"</span>: <span class="token number">1024</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token string">&quot;1590002705&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"flags"</span>: <span class="token number">256</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_id"</span>: <span class="token number">2</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_tag"</span>: <span class="token number">33930</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_type"</span>: <span class="token string">&quot;ZSK&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"privatekey"</span>: <span class="token string">&quot;Private-key-format: v1.2\nAlgorithm: 8 (RSASHA256)\nModulus: wcZl882v587qKmt3M7+y6u+kzSgCvfgyiSGQHE2EulDcAnfEmz/ryanXMveHGBsO4L/GynYYUUsGvD2jHK1ITh8CeISiqmbUmPolf9HLQgwcT5pVcvwJ0Wmzpw5Ukmx67N7TTX+yieI5OyflP23GnJYQ5EQUzBu/DhdxhL90hYU=\nPublicExponent: AQAB\nPrivateExponent: EnoBdKrTMA5Jw7u1hQitXbt2Al3jTQvifbLmk9xMYJufLtkOtSL2L6dzLpftmL3TwFho8xspnG7D+KUD7ZMURrwxnLlqTttaL2PeaYJdQ184ezuflExppkDkdTEOqcIUuSylfAbyIdeGkVFuWr0cdjM9OFKMAkoYaVeAUP0SYU0=\nPrime1: 4eslxBBwyvXzmFqKx5TTiHfU7EHIAxUru3ykOMqD2tVMHbRAq5AMKZL6ZhuTXk8mnGppEfC6qqNKnf3VT5jLxw==\nPrime2: 25OUAsWWAJrQ4uLytsXoSbjHsVyh61DgZ4S4n2Mv7RsSHt0Q/VcuyvHXuAKb8Y0XCYczZBtEW+ZoPte/HHnsUw==\nExponent1: Xkb4AqLtvvT2i8y0/2avA9MmCtXEtuydzGbOTVjNv4OlePvgxPee67aHQhcd34xeS4XohPEVpOHx4I6t9sKHvw==\nExponent2: ulZDBRcodNrs6Z4u22yX8/gbfyhdQJUh2reG9bv2sAB/wEJaaKPT0eXqav3L2PKfCjbyJcH+AP9G+A2e4UuWgQ==\nCoefficient: mynNLSgStpQMktIEdysefyOg5jpXE3VeDZF6fbEOUg+E2ZnLBkLu4KPrriCwfl+cLagwgzx2M6wV/1QWkm8vPQ==&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nsec_details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"nsec3_hash_algo_desc"</span>: <span class="token string">&quot;SHA-1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nsec3_hash_algo_num"</span>: <span class="token string">&quot;1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nsec3_iterations"</span>: <span class="token string">&quot;3&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nsec3_narrow"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nsec3_opt_out"</span>: <span class="token string">&quot;0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nsec3_salt"</span>: <span class="token string">&quot;fa1ac2c1rd7fbab4&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nsec_version"</span>: <span class="token string">&quot;NSEC3&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/DNS-Security/operation/remove_zone_key" data-section-id="tag/DNS-Security/operation/remove_zone_key" class="sc-dntaoT ceciOs"><div data-section-id="operation/remove_zone_key" id="operation/remove_zone_key" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS-Security/operation/remove_zone_key" aria-label="tag/DNS-Security/operation/remove_zone_key"></a>Remove DNSSEC security key </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function removes a DNSSEC security key.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;DNS role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes a DNSSEC security key.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">DNS role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The security key&amp;#39;s domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The security key&#39;s domain.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="key_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">key_id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= 1 </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key_id=1</span></div><div><div html="&lt;p&gt;The security key&amp;#39;s ID.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The security key&#39;s ID.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DNSSEC/remove_zone_key</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DNSSEC/remove_zone_key</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99f75a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99f75a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99f75a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f75a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99f75a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f75a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99f75a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f75a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99f75a:0" aria-labelledby="tab:R99f75a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DNSSEC <span class="token punctuation">\</span>
  remove_zone_key <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">key_id</span><span class="token operator">=</span><span class="token string">'1'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99f75a:1" aria-labelledby="tab:R99f75a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99f75a:2" aria-labelledby="tab:R99f75a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99f75a:3" aria-labelledby="tab:R99f75a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pf75a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pf75a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pf75a:0" aria-labelledby="tab:R9pf75a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;remove_zone_key&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DNSSEC&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_id"</span>: <span class="token string">&quot;12&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"success"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/DNS-Security/operation/deactivate_zone_key" data-section-id="tag/DNS-Security/operation/deactivate_zone_key" class="sc-dntaoT ceciOs"><div data-section-id="operation/deactivate_zone_key" id="operation/deactivate_zone_key" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS-Security/operation/deactivate_zone_key" aria-label="tag/DNS-Security/operation/deactivate_zone_key"></a>Disable DNSSEC security key </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function deactivates a DNSSEC security key.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles/&quot;&gt;&lt;em&gt;DNS&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deactivates a DNSSEC security key.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles/"><em>DNS</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The security key&amp;#39;s domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The security key&#39;s domain.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="key_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">key_id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= 1 </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key_id=1</span></div><div><div html="&lt;p&gt;The security key&amp;#39;s ID.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The security key&#39;s ID.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DNSSEC/deactivate_zone_key</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DNSSEC/deactivate_zone_key</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99h75a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99h75a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99h75a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h75a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99h75a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h75a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99h75a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h75a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99h75a:0" aria-labelledby="tab:R99h75a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DNSSEC <span class="token punctuation">\</span>
  deactivate_zone_key <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">key_id</span><span class="token operator">=</span><span class="token string">'1'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h75a:1" aria-labelledby="tab:R99h75a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h75a:2" aria-labelledby="tab:R99h75a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h75a:3" aria-labelledby="tab:R99h75a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9ph75a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9ph75a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9ph75a:0" aria-labelledby="tab:R9ph75a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;deactivate_zone_key&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DNSSEC&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <span class="token string">&quot;Error:  Invalid key_id or domain specified: No such key present for domain.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_id"</span>: <span class="token string">&quot;1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"success"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/DNS-Security/operation/disable_dnssec" data-section-id="tag/DNS-Security/operation/disable_dnssec" class="sc-dntaoT ceciOs"><div data-section-id="operation/disable_dnssec" id="operation/disable_dnssec" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS-Security/operation/disable_dnssec" aria-label="tag/DNS-Security/operation/disable_dnssec"></a>Disable DNSSEC </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function disables DNSSEC on the domain.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;This action is &lt;strong&gt;irreversible&lt;/strong&gt;. If you disable DNSSEC on the domain, you will lose the associated keys. You can only retrieve the previous state with a full backup.&lt;/li&gt;
&lt;li&gt;If you disable DNSSEC, you &lt;strong&gt;must&lt;/strong&gt; remove the DNS records at the registrar.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;DNS role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables DNSSEC on the domain.</p>
<p><strong>Warning:</strong></p>
<ul>
<li>This action is <strong>irreversible</strong>. If you disable DNSSEC on the domain, you will lose the associated keys. You can only retrieve the previous state with a full backup.</li>
<li>If you disable DNSSEC, you <strong>must</strong> remove the DNS records at the registrar.</li>
</ul>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">DNS role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain-0=example0.com&amp;domain-1=example1.com&amp;domain-2=example2.com</span> - To enable DNSSEC on multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> - To enable DNSSEC on a single domain.</li></ul><div><div html="&lt;p&gt;The domain on which to disable DNSSEC.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; To enable DNSSEC on multiple domains, increment the parameter name. For example: &lt;code&gt;domain-0&lt;/code&gt;, &lt;code&gt;domain-1&lt;/code&gt;, &lt;code&gt;domain-2&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain on which to disable DNSSEC.</p>
<p><strong>Note:</strong></p>
<p> To enable DNSSEC on multiple domains, increment the parameter name. For example: <code>domain-0</code>, <code>domain-1</code>, <code>domain-2</code>.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DNSSEC/disable_dnssec</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DNSSEC/disable_dnssec</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99j75a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99j75a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99j75a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99j75a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99j75a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99j75a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99j75a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99j75a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99j75a:0" aria-labelledby="tab:R99j75a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DNSSEC <span class="token punctuation">\</span>
  disable_dnssec <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99j75a:1" aria-labelledby="tab:R99j75a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99j75a:2" aria-labelledby="tab:R99j75a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99j75a:3" aria-labelledby="tab:R99j75a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pj75a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pj75a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pj75a:0" aria-labelledby="tab:R9pj75a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;disable_dnssec&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DNSSEC&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"disabled"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"example.com"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/DNS-Security/operation/add_zone_key" data-section-id="tag/DNS-Security/operation/add_zone_key" class="sc-dntaoT ceciOs"><div data-section-id="operation/add_zone_key" id="operation/add_zone_key" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS-Security/operation/add_zone_key" aria-label="tag/DNS-Security/operation/add_zone_key"></a>Create DNSSEC security key </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function generates a DNSSEC zone key for a domain.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;After you enable DNSSEC on the domain, you &lt;strong&gt;must&lt;/strong&gt; add the DS records to your registrar.&lt;/li&gt;
&lt;li&gt;You &lt;strong&gt;cannot&lt;/strong&gt; modify the DNSSEC security key. To make any changes, you &lt;strong&gt;must&lt;/strong&gt; disable (and delete) and re-create the DNSSEC security key.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;DNS role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function generates a DNSSEC zone key for a domain.</p>
<p><strong>Note:</strong></p>
<ul>
<li>After you enable DNSSEC on the domain, you <strong>must</strong> add the DS records to your registrar.</li>
<li>You <strong>cannot</strong> modify the DNSSEC security key. To make any changes, you <strong>must</strong> disable (and delete) and re-create the DNSSEC security key.</li>
</ul>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">DNS role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="active" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">active</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">active=1</span></div><div><div html="&lt;p&gt;Whether to activate the newly-created key.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Activate the key.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Do &lt;strong&gt;not&lt;/strong&gt; activate the key.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to activate the newly-created key.</p>
<ul>
<li><code>1</code> — Activate the key.</li>
<li><code>0</code> — Do <strong>not</strong> activate the key.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="algo_num" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">algo_num</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">5</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">6</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">7</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">8</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">10</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">13</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">14</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">algo_num=8</span></div><div><div html="&lt;p&gt;The algorithm that the system uses to generate the security key.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;5&lt;/code&gt; — RSA/SHA-1&lt;/li&gt;
&lt;li&gt;&lt;code&gt;6&lt;/code&gt; — DSA-NSEC3-SHA1&lt;/li&gt;
&lt;li&gt;&lt;code&gt;7&lt;/code&gt; — RSASHA1-NSEC3-SHA1&lt;/li&gt;
&lt;li&gt;&lt;code&gt;8&lt;/code&gt; — RSA/SHA-256&lt;/li&gt;
&lt;li&gt;&lt;code&gt;10&lt;/code&gt; — RSA/SHA-512&lt;/li&gt;
&lt;li&gt;&lt;code&gt;13&lt;/code&gt; — ECDSA Curve P-256 with SHA-256&lt;/li&gt;
&lt;li&gt;&lt;code&gt;14&lt;/code&gt; — ECDSA Curve P-384 with SHA-384&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;We recommend that you use &amp;#39;ECDSA Curve P-256 with SHA-256&amp;#39; if your registrar supports it.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The algorithm that the system uses to generate the security key.</p>
<ul>
<li><code>5</code> — RSA/SHA-1</li>
<li><code>6</code> — DSA-NSEC3-SHA1</li>
<li><code>7</code> — RSASHA1-NSEC3-SHA1</li>
<li><code>8</code> — RSA/SHA-256</li>
<li><code>10</code> — RSA/SHA-512</li>
<li><code>13</code> — ECDSA Curve P-256 with SHA-256</li>
<li><code>14</code> — ECDSA Curve P-384 with SHA-384</li>
</ul>
<p><strong>Note:</strong></p>
<p>We recommend that you use &#39;ECDSA Curve P-256 with SHA-256&#39; if your registrar supports it.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The domain on which to enable DNSSEC.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain on which to enable DNSSEC.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="key_size" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">key_size</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> [ 256 .. 2048 ] </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key_size=2048</span></div><div><div html="&lt;p&gt;The key&amp;#39;s size, in bits.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;For the following &lt;code&gt;algo_num&lt;/code&gt; and &lt;code&gt;key_type&lt;/code&gt; parameters, the &lt;code&gt;key_size&lt;/code&gt; defaults to the following values:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;5&lt;/code&gt; — ksk &lt;code&gt;2048&lt;/code&gt; zsk &lt;code&gt;1024&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;6&lt;/code&gt; — ksk &lt;code&gt;2048&lt;/code&gt; zsk &lt;code&gt;1024&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;7&lt;/code&gt; — ksk &lt;code&gt;2048&lt;/code&gt; zsk &lt;code&gt;1024&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;8&lt;/code&gt; — ksk &lt;code&gt;2048&lt;/code&gt; zsk &lt;code&gt;1024&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;10&lt;/code&gt; — ksk &lt;code&gt;2048&lt;/code&gt; zsk &lt;code&gt;1024&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;13&lt;/code&gt; — ksk &lt;code&gt;256&lt;/code&gt; zsk &lt;code&gt;256&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;14&lt;/code&gt; — ksk &lt;code&gt;384&lt;/code&gt; zsk &lt;code&gt;384&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key&#39;s size, in bits.</p>
<p><strong>Note:</strong></p>
<p>For the following <code>algo_num</code> and <code>key_type</code> parameters, the <code>key_size</code> defaults to the following values:</p>
<ul>
<li><code>5</code> — ksk <code>2048</code> zsk <code>1024</code></li>
<li><code>6</code> — ksk <code>2048</code> zsk <code>1024</code></li>
<li><code>7</code> — ksk <code>2048</code> zsk <code>1024</code></li>
<li><code>8</code> — ksk <code>2048</code> zsk <code>1024</code></li>
<li><code>10</code> — ksk <code>2048</code> zsk <code>1024</code></li>
<li><code>13</code> — ksk <code>256</code> zsk <code>256</code></li>
<li><code>14</code> — ksk <code>384</code> zsk <code>384</code></li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="key_type" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">key_type</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;ksk&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;zsk&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key_type=ksk</span></div><div><div html="&lt;p&gt;The type of key to add.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;ksk&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;zsk&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The type of key to add.</p>
<ul>
<li><code>ksk</code></li>
<li><code>zsk</code></li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DNSSEC/add_zone_key</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DNSSEC/add_zone_key</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99l75a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99l75a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99l75a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99l75a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99l75a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99l75a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99l75a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99l75a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99l75a:0" aria-labelledby="tab:R99l75a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DNSSEC <span class="token punctuation">\</span>
  add_zone_key <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">algo_num</span><span class="token operator">=</span><span class="token string">'8'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">key_type</span><span class="token operator">=</span><span class="token string">'ksk'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99l75a:1" aria-labelledby="tab:R99l75a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99l75a:2" aria-labelledby="tab:R99l75a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99l75a:3" aria-labelledby="tab:R99l75a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pl75a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pl75a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pl75a:0" aria-labelledby="tab:R9pl75a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;add_zone_key&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DNSSEC&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <span class="token string">&quot;Error: Invalid key_id or domain specified: No such key present for domain.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"new_key_id"</span>: <span class="token string">&quot;1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"success"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/DNS-Security/operation/set_nsec3" data-section-id="tag/DNS-Security/operation/set_nsec3" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_nsec3" id="operation/set_nsec3" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS-Security/operation/set_nsec3" aria-label="tag/DNS-Security/operation/set_nsec3"></a>Update domain to use NSEC3 </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function configures the domain to use &lt;a href=&quot;https://tools.ietf.org/html/rfc4470&quot;&gt;Next Secure Record 3&lt;/a&gt; (NSEC3) semantics.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;DNS role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function configures the domain to use <a href="https://tools.ietf.org/html/rfc4470">Next Secure Record 3</a> (NSEC3) semantics.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles">DNS role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The domain on which to enable NSEC3 semantics.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain on which to enable NSEC3 semantics.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="nsec3_iterations" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">nsec3_iterations</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> [ 1 .. 500 ] </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">nsec3_iterations=7</span></div><div><div html="&lt;p&gt;The number of times that the system re-executes the first resource record hash operation.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The number of times that the system re-executes the first resource record hash operation.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="nsec3_narrow" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">nsec3_narrow</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">nsec3_narrow=1</span></div><div><div html="&lt;p&gt;Whether NSEC3 will operate in Narrow mode or Inclusive mode. In Narrow mode, PowerDNS sends out white lies about the next secure record. Rather than query the resource record in the database, PowerDNS sends the hash plus 1 as the next secure record.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Narrow mode. * &lt;code&gt;0&lt;/code&gt; - Inclusive mode.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether NSEC3 will operate in Narrow mode or Inclusive mode. In Narrow mode, PowerDNS sends out white lies about the next secure record. Rather than query the resource record in the database, PowerDNS sends the hash plus 1 as the next secure record.</p>
<ul>
<li><code>1</code> - Narrow mode. * <code>0</code> - Inclusive mode.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="nsec3_opt_out" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">nsec3_opt_out</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">nsec3_opt_out=0</span></div><div><div html="&lt;p&gt;Whether the system will create records for all delegations.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Create records for all delegations.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Create records &lt;strong&gt;only&lt;/strong&gt; for secure delegations.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  &lt;strong&gt;Only&lt;/strong&gt; select &lt;code&gt;1&lt;/code&gt; if you &lt;strong&gt;must&lt;/strong&gt; create records for all delegations.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the system will create records for all delegations.</p>
<ul>
<li><code>1</code> - Create records for all delegations.</li>
<li><code>0</code> - Create records <strong>only</strong> for secure delegations.</li>
</ul>
<p><strong>Note:</strong></p>
<p>  <strong>Only</strong> select <code>1</code> if you <strong>must</strong> create records for all delegations.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="nsec3_salt" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">nsec3_salt</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;hex&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">nsec3_salt=1A2B3C4D5E6F</span></div><div><div html="&lt;p&gt;The salt value that PowerDNS uses in the hashes. For more information about the salt value, read the &lt;a href=&quot;https://tools.ietf.org/html/rfc5155&quot;&gt;RFC 5155 documentation&lt;/a&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The salt value that PowerDNS uses in the hashes. For more information about the salt value, read the <a href="https://tools.ietf.org/html/rfc5155">RFC 5155 documentation</a>.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DNSSEC/set_nsec3</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DNSSEC/set_nsec3</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99n75a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99n75a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99n75a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99n75a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99n75a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99n75a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99n75a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99n75a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99n75a:0" aria-labelledby="tab:R99n75a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DNSSEC <span class="token punctuation">\</span>
  set_nsec3 <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">nsec3_opt_out</span><span class="token operator">=</span><span class="token string">'0'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">nsec3_iterations</span><span class="token operator">=</span><span class="token string">'7'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">nsec3_narrow</span><span class="token operator">=</span><span class="token string">'1'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">nsec3_salt</span><span class="token operator">=</span><span class="token string">'1A2B3C4D5E6F'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99n75a:1" aria-labelledby="tab:R99n75a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99n75a:2" aria-labelledby="tab:R99n75a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99n75a:3" aria-labelledby="tab:R99n75a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pn75a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pn75a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pn75a:0" aria-labelledby="tab:R9pn75a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_nsec3&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DNSSEC&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"example1.com"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/DNS-Security/operation/activate_zone_key" data-section-id="tag/DNS-Security/operation/activate_zone_key" class="sc-dntaoT ceciOs"><div data-section-id="operation/activate_zone_key" id="operation/activate_zone_key" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/DNS-Security/operation/activate_zone_key" aria-label="tag/DNS-Security/operation/activate_zone_key"></a>Enable DNSSEC security key </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function activates a DNSSEC security key.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;DNS role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function activates a DNSSEC security key.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">DNS role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The security key&amp;#39;s domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The security key&#39;s domain.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="key_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">key_id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= 1 </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key_id=1</span></div><div><div html="&lt;p&gt;The security key&amp;#39;s ID.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The security key&#39;s ID.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DNSSEC/activate_zone_key</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DNSSEC/activate_zone_key</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99p75a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99p75a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99p75a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99p75a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99p75a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99p75a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99p75a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99p75a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99p75a:0" aria-labelledby="tab:R99p75a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DNSSEC <span class="token punctuation">\</span>
  activate_zone_key <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">key_id</span><span class="token operator">=</span><span class="token string">'1'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99p75a:1" aria-labelledby="tab:R99p75a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99p75a:2" aria-labelledby="tab:R99p75a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99p75a:3" aria-labelledby="tab:R99p75a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pp75a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pp75a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pp75a:0" aria-labelledby="tab:R9pp75a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;activate_zone_key&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DNSSEC&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_id"</span>: <span class="token string">&quot;1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"success"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Dynamic-DNS" data-section-id="tag/Dynamic-DNS" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Dynamic-DNS" aria-label="tag/Dynamic-DNS"></a>Dynamic DNS</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;DNS / Dynamic DNS&lt;/p&gt;
"><p>DNS / Dynamic DNS</p>
</div></div></div><div id="tag/Dynamic-DNS/operation/dynamicdns-create" data-section-id="tag/Dynamic-DNS/operation/dynamicdns-create" class="sc-dntaoT ceciOs"><div data-section-id="operation/dynamicdns-create" id="operation/dynamicdns-create" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Dynamic-DNS/operation/dynamicdns-create" aria-label="tag/Dynamic-DNS/operation/dynamicdns-create"></a>Create Dynamic DNS domain </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function creates a Dynamic DNS (DDNS) domain.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;DNS&lt;/em&gt; role&lt;/a&gt;, the system disables this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a Dynamic DNS (DDNS) domain.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles"><em>DNS</em> role</a>, the system disables this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="description" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">description</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">description=Home network</span></div><div><div html="&lt;p&gt;A human-readable string that describes the domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A human-readable string that describes the domain.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=home.example.com</span></div><div><div html="&lt;p&gt;The fully-qualified domain name to create as a DDNS domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The fully-qualified domain name to create as a DDNS domain.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DynamicDNS/create</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DynamicDNS/create</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kj95a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kj95a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kj95a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj95a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kj95a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj95a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kj95a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj95a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kj95a:0" aria-labelledby="tab:R4kj95a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DynamicDNS <span class="token punctuation">\</span>
  create <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'home.example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj95a:1" aria-labelledby="tab:R4kj95a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj95a:2" aria-labelledby="tab:R4kj95a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj95a:3" aria-labelledby="tab:R4kj95a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sj95a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sj95a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sj95a:0" aria-labelledby="tab:R4sj95a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;create&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DynamicDNS&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created_time"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;ggiugyxxjwnkmqtwysgmvrurplmafxpq&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Dynamic-DNS/operation/dynamicdns-list" data-section-id="tag/Dynamic-DNS/operation/dynamicdns-list" class="sc-dntaoT ceciOs"><div data-section-id="operation/dynamicdns-list" id="operation/dynamicdns-list" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Dynamic-DNS/operation/dynamicdns-list" aria-label="tag/Dynamic-DNS/operation/dynamicdns-list"></a>Return Dynamic DNS domains </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the user’s Dynamic DNS (DDNS) domains.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;DNS&lt;/em&gt; role&lt;/a&gt;, the system disables this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the user’s Dynamic DNS (DDNS) domains.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles"><em>DNS</em> role</a>, the system disables this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DynamicDNS/list</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DynamicDNS/list</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kl95a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kl95a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kl95a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl95a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kl95a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl95a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kl95a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl95a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kl95a:0" aria-labelledby="tab:R4kl95a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DynamicDNS <span class="token punctuation">\</span>
  list
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl95a:1" aria-labelledby="tab:R4kl95a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl95a:2" aria-labelledby="tab:R4kl95a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl95a:3" aria-labelledby="tab:R4kl95a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sl95a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sl95a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sl95a:0" aria-labelledby="tab:R4sl95a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DynamicDNS&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created_time"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">&quot;My home network&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;home.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;gziugyxxjwnamqtwysgmvrurplmafxpj&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_run_times"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">0</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_update_time"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Dynamic-DNS/operation/dynamicdns-delete" data-section-id="tag/Dynamic-DNS/operation/dynamicdns-delete" class="sc-dntaoT ceciOs"><div data-section-id="operation/dynamicdns-delete" id="operation/dynamicdns-delete" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Dynamic-DNS/operation/dynamicdns-delete" aria-label="tag/Dynamic-DNS/operation/dynamicdns-delete"></a>Delete Dynamic DNS domain </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function deletes an existing Dynamic DNS (DDNS) domain.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;DNS&lt;/em&gt; role&lt;/a&gt;, the system disables this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes an existing Dynamic DNS (DDNS) domain.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles"><em>DNS</em> role</a>, the system disables this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">id=ggiugyxxjwnkmqtwysgmvrurplmafxpq</span></div><div><div html="&lt;p&gt;The DDNS domain’s ID.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The DDNS domain’s ID.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DynamicDNS/delete</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DynamicDNS/delete</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kn95a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kn95a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kn95a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn95a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kn95a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn95a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kn95a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn95a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kn95a:0" aria-labelledby="tab:R4kn95a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DynamicDNS <span class="token punctuation">\</span>
  delete <span class="token punctuation">\</span>
  <span class="token assign-left variable">id</span><span class="token operator">=</span><span class="token string">'ggiugyxxjwnkmqtwysgmvrurplmafxpq'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn95a:1" aria-labelledby="tab:R4kn95a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn95a:2" aria-labelledby="tab:R4kn95a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn95a:3" aria-labelledby="tab:R4kn95a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sn95a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sn95a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sn95a:0" aria-labelledby="tab:R4sn95a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;delete&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DynamicDNS&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"deleted"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Dynamic-DNS/operation/dynamicdns-recreate" data-section-id="tag/Dynamic-DNS/operation/dynamicdns-recreate" class="sc-dntaoT ceciOs"><div data-section-id="operation/dynamicdns-recreate" id="operation/dynamicdns-recreate" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Dynamic-DNS/operation/dynamicdns-recreate" aria-label="tag/Dynamic-DNS/operation/dynamicdns-recreate"></a>Update Dynamic DNS domain ID </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function gives a new, randomly-generated ID to an existing Dynamic DNS (DDNS) domain.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;DNS&lt;/em&gt; role&lt;/a&gt;, the system disables this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function gives a new, randomly-generated ID to an existing Dynamic DNS (DDNS) domain.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles"><em>DNS</em> role</a>, the system disables this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">id=ggiugyxxjwnkmqtwysgmvrurplmafxpq</span></div><div><div html="&lt;p&gt;The DDNS domain’s ID.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The DDNS domain’s ID.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DynamicDNS/recreate</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DynamicDNS/recreate</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kp95a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kp95a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kp95a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp95a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kp95a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp95a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kp95a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp95a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kp95a:0" aria-labelledby="tab:R4kp95a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DynamicDNS <span class="token punctuation">\</span>
  recreate <span class="token punctuation">\</span>
  <span class="token assign-left variable">id</span><span class="token operator">=</span><span class="token string">'ggiugyxxjwnkmqtwysgmvrurplmafxpq'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp95a:1" aria-labelledby="tab:R4kp95a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp95a:2" aria-labelledby="tab:R4kp95a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp95a:3" aria-labelledby="tab:R4kp95a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sp95a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sp95a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sp95a:0" aria-labelledby="tab:R4sp95a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;recreate&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DynamicDNS&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;ggiugyxxjwnkmqtwysgmvrurplmafxpq&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Dynamic-DNS/operation/dynamicdns-set_description" data-section-id="tag/Dynamic-DNS/operation/dynamicdns-set_description" class="sc-dntaoT ceciOs"><div data-section-id="operation/dynamicdns-set_description" id="operation/dynamicdns-set_description" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Dynamic-DNS/operation/dynamicdns-set_description" aria-label="tag/Dynamic-DNS/operation/dynamicdns-set_description"></a>Update Dynamic DNS domain description </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function sets the description on a user’s Dynamic DNS (DDNS) domain.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;DNS&lt;/em&gt; role&lt;/a&gt;, the system disables this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets the description on a user’s Dynamic DNS (DDNS) domain.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles"><em>DNS</em> role</a>, the system disables this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="description" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">description</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">description=Home network</span></div><div><div html="&lt;p&gt;A human-readable string that describes the domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A human-readable string that describes the domain.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">id=ggiugyxxjwnkmqtwysgmvrurplmafxpq</span></div><div><div html="&lt;p&gt;The DDNS domain’s ID.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The DDNS domain’s ID.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DynamicDNS/set_description</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DynamicDNS/set_description</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kr95a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kr95a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kr95a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kr95a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kr95a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kr95a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kr95a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kr95a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kr95a:0" aria-labelledby="tab:R4kr95a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DynamicDNS <span class="token punctuation">\</span>
  set_description <span class="token punctuation">\</span>
  <span class="token assign-left variable">id</span><span class="token operator">=</span><span class="token string">'ggiugyxxjwnkmqtwysgmvrurplmafxpq'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">description</span><span class="token operator">=</span><span class="token string">'Home network'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kr95a:1" aria-labelledby="tab:R4kr95a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kr95a:2" aria-labelledby="tab:R4kr95a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kr95a:3" aria-labelledby="tab:R4kr95a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sr95a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sr95a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sr95a:0" aria-labelledby="tab:R4sr95a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DynamicDNS&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-DNS-Settings" data-section-id="tag/Email-DNS-Settings" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-DNS-Settings" aria-label="tag/Email-DNS-Settings"></a>Email DNS Settings</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;DNS / Email DNS Settings&lt;/p&gt;
"><p>DNS / Email DNS Settings</p>
</div></div></div><div id="tag/Email-DNS-Settings/operation/add_mx" data-section-id="tag/Email-DNS-Settings/operation/add_mx" class="sc-dntaoT ceciOs"><div data-section-id="operation/add_mx" id="operation/add_mx" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-DNS-Settings/operation/add_mx" aria-label="tag/Email-DNS-Settings/operation/add_mx"></a>Create mail exchanger record </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function creates a Mail Exchanger (MX) record. For more information about MX record settings, read our &lt;a href=&quot;https://go.cpanel.net/whmdocsEmailRoutingConfiguration&quot;&gt;Email Routing Configuration&lt;/a&gt; documentation.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a Mail Exchanger (MX) record. For more information about MX record settings, read our <a href="https://go.cpanel.net/whmdocsEmailRoutingConfiguration">Email Routing Configuration</a> documentation.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="alwaysaccept" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">alwaysaccept</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">alwaysaccept=1</span></div><div><div html="&lt;p&gt;Whether the mail exchanger accepts all mail for the domain.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — The mail exchanger always accepts mail.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — The mail exchanger does &lt;strong&gt;not&lt;/strong&gt; always accept mail.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the mail exchanger accepts all mail for the domain.</p>
<ul>
<li><code>1</code> — The mail exchanger always accepts mail.</li>
<li><code>0</code> — The mail exchanger does <strong>not</strong> always accept mail.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The new mail exchanger&amp;#39;s domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new mail exchanger&#39;s domain.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="exchanger" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">exchanger</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">exchanger=mail.example.com</span></div><div><div html="&lt;p&gt;The new mail exchanger&amp;#39;s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new mail exchanger&#39;s name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="priority" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">priority</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= 0 </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">priority=5</span></div><div><div html="&lt;p&gt;The new mail exchanger&amp;#39;s &lt;a href=&quot;https://go.cpanel.net/whmdocsEditMXEntry&quot;&gt;priority value&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  It is common practice to set a priority value that is divisible by five.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new mail exchanger&#39;s <a href="https://go.cpanel.net/whmdocsEditMXEntry">priority value</a>.</p>
<p><strong>Note:</strong></p>
<p>  It is common practice to set a priority value that is divisible by five.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/add_mx</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/add_mx</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rii3b5a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rii3b5a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rii3b5a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii3b5a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rii3b5a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii3b5a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rii3b5a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii3b5a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rii3b5a:0" aria-labelledby="tab:Rii3b5a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  add_mx <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">exchanger</span><span class="token operator">=</span><span class="token string">'mail.example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">priority</span><span class="token operator">=</span><span class="token string">'5'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii3b5a:1" aria-labelledby="tab:Rii3b5a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii3b5a:2" aria-labelledby="tab:Rii3b5a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii3b5a:3" aria-labelledby="tab:Rii3b5a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rji3b5a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rji3b5a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rji3b5a:0" aria-labelledby="tab:Rji3b5a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;add_mx&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"checkmx"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"changed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"detected"</span>: <span class="token string">&quot;auto&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"isprimary"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issecondary"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"local"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mxcheck"</span>: <span class="token string">&quot;auto&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"remote"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"secondary"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;Auto Detect of MX configuration not possible due to non-resolving MX entries. Defaulting to last known setting: local.&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"results"</span>: <span class="token string">&quot;Added entry:\\nBind reloading on example using rndc zone: [example.com]\\n&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"statusmsg"</span>: <span class="token string">&quot;Added entry:\\nBind reloading on example using rndc zone: [example.com]\\n&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-DNS-Settings/operation/change_mx" data-section-id="tag/Email-DNS-Settings/operation/change_mx" class="sc-dntaoT ceciOs"><div data-section-id="operation/change_mx" id="operation/change_mx" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-DNS-Settings/operation/change_mx" aria-label="tag/Email-DNS-Settings/operation/change_mx"></a>Update mail exchanger record </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function creates a Mail Exchanger (MX) record. For more information about MX record settings, read our &lt;a href=&quot;https://go.cpanel.net/whmdocsEmailRoutingConfiguration&quot;&gt;Email Routing Configuration&lt;/a&gt; documentation.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a Mail Exchanger (MX) record. For more information about MX record settings, read our <a href="https://go.cpanel.net/whmdocsEmailRoutingConfiguration">Email Routing Configuration</a> documentation.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="alwaysaccept" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">alwaysaccept</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">alwaysaccept=1</span></div><div><div html="&lt;p&gt;Whether the mail exchanger accepts all mail for the domain.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — The mail exchanger always accepts mail.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — The mail exchanger does &lt;strong&gt;not&lt;/strong&gt; always accept mail.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the mail exchanger accepts all mail for the domain.</p>
<ul>
<li><code>1</code> — The mail exchanger always accepts mail.</li>
<li><code>0</code> — The mail exchanger does <strong>not</strong> always accept mail.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The mail exchanger&amp;#39;s domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mail exchanger&#39;s domain.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="exchanger" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">exchanger</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">exchanger=mail.example.com</span></div><div><div html="&lt;p&gt;The mail exchanger&amp;#39;s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mail exchanger&#39;s name.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="oldexchanger" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">oldexchanger</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">oldexchanger=mail.example.com</span></div><div><div html="&lt;p&gt;The mail exchanger&amp;#39;s current name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mail exchanger&#39;s current name.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="oldpriority" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">oldpriority</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= 0 </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">oldpriority=5</span></div><div><div html="&lt;p&gt;The mail exchanger&amp;#39;s current priority value. If multiple MX entries match the &lt;code&gt;oldexchanger&lt;/code&gt; value, the system uses this parameter to find the correct entry.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mail exchanger&#39;s current priority value. If multiple MX entries match the <code>oldexchanger</code> value, the system uses this parameter to find the correct entry.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="priority" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">priority</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= 0 </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">priority=15</span></div><div><div html="&lt;p&gt;The mail exchanger&amp;#39;s new &lt;a href=&quot;https://go.cpanel.net/whmdocsEditMXEntry&quot;&gt;priority value&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  Common practice sets a priority value divisible by five.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mail exchanger&#39;s new <a href="https://go.cpanel.net/whmdocsEditMXEntry">priority value</a>.</p>
<p><strong>Note:</strong></p>
<p>  Common practice sets a priority value divisible by five.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/change_mx</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/change_mx</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rii5b5a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rii5b5a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rii5b5a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii5b5a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rii5b5a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii5b5a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rii5b5a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii5b5a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rii5b5a:0" aria-labelledby="tab:Rii5b5a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  change_mx <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">exchanger</span><span class="token operator">=</span><span class="token string">'mail.example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">oldexchanger</span><span class="token operator">=</span><span class="token string">'mail.example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">priority</span><span class="token operator">=</span><span class="token string">'15'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii5b5a:1" aria-labelledby="tab:Rii5b5a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii5b5a:2" aria-labelledby="tab:Rii5b5a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii5b5a:3" aria-labelledby="tab:Rii5b5a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rji5b5a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rji5b5a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rji5b5a:0" aria-labelledby="tab:Rji5b5a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;change_mx&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"checkmx"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"changed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"detected"</span>: <span class="token string">&quot;auto&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"isprimary"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issecondary"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"local"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mxcheck"</span>: <span class="token string">&quot;auto&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"remote"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"secondary"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;Auto Detect of MX configuration not possible due to non-resolving MX entries. Defaulting to last known setting: local.&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"results"</span>: <span class="token string">&quot;Replacing existing entry on line matched old entry and old priority: 51:\\nBind reloading on example using rndc zone: [example.com]&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"statusmsg"</span>: <span class="token string">&quot;Replacing existing entry on line matched old entry and old priority: 51:\\nBind reloading on example using rndc zone: [example.com]&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-DNS-Settings/operation/delete_mx" data-section-id="tag/Email-DNS-Settings/operation/delete_mx" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete_mx" id="operation/delete_mx" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-DNS-Settings/operation/delete_mx" aria-label="tag/Email-DNS-Settings/operation/delete_mx"></a>Delete mail exchanger record </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function deletes a Mail Exchanger (MX) record. For more information about MX record settings, read our &lt;a href=&quot;https://go.cpanel.net/whmdocsEmailRoutingConfiguration&quot;&gt;Email Routing Configuration&lt;/a&gt; documentation.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;DNS role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes a Mail Exchanger (MX) record. For more information about MX record settings, read our <a href="https://go.cpanel.net/whmdocsEmailRoutingConfiguration">Email Routing Configuration</a> documentation.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">DNS role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The mail exchanger&amp;#39;s domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mail exchanger&#39;s domain.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="exchanger" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">exchanger</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">exchanger=mail.example.com</span></div><div><div html="&lt;p&gt;The mail exchanger&amp;#39;s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mail exchanger&#39;s name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="priority" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">priority</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= 1 </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">priority=15</span></div><div><div html="&lt;p&gt;The mail exchanger&amp;#39;s &lt;a href=&quot;https://go.cpanel.net/whmdocsEditMXEntry&quot;&gt;priority value&lt;/a&gt;. If multiple MX entries match the exchanger value, the system uses this parameter to find the correct entry.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mail exchanger&#39;s <a href="https://go.cpanel.net/whmdocsEditMXEntry">priority value</a>. If multiple MX entries match the exchanger value, the system uses this parameter to find the correct entry.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/delete_mx</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/delete_mx</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rii7b5a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rii7b5a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rii7b5a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii7b5a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rii7b5a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii7b5a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rii7b5a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii7b5a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rii7b5a:0" aria-labelledby="tab:Rii7b5a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  delete_mx <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">exchanger</span><span class="token operator">=</span><span class="token string">'mail.example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">priority</span><span class="token operator">=</span><span class="token string">'15'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii7b5a:1" aria-labelledby="tab:Rii7b5a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii7b5a:2" aria-labelledby="tab:Rii7b5a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii7b5a:3" aria-labelledby="tab:Rii7b5a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rji7b5a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rji7b5a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rji7b5a:0" aria-labelledby="tab:Rji7b5a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;delete_mx&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"checkmx"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"changed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"detected"</span>: <span class="token string">&quot;auto&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"isprimary"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issecondary"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"local"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mxcheck"</span>: <span class="token string">&quot;auto&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"remote"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"secondary"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token string">&quot;Auto Detect of MX configuration not possible due to non-resolving MX entries. Defaulting to last known setting: local.&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"results"</span>: <span class="token string">&quot;Removed entry: example.com. IN MX 15 mail.example.com\nBind reloading on example using rndc zone: [example.com]&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"statusmsg"</span>: <span class="token string">&quot;Removed entry: example.com. IN MX 15 mail.example.com\nBind reloading on example using rndc zone: [example.com]&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-DNS-Settings/operation/EmailAuth::apply_dmarc" data-section-id="tag/Email-DNS-Settings/operation/EmailAuth::apply_dmarc" class="sc-dntaoT ceciOs"><div data-section-id="operation/EmailAuth::apply_dmarc" id="operation/EmailAuth::apply_dmarc" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-DNS-Settings/operation/EmailAuth::apply_dmarc" aria-label="tag/Email-DNS-Settings/operation/EmailAuth::apply_dmarc"></a>Apply DMARC records to domains. </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function applies a DMARC record to the specified domain(s)&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function applies a DMARC record to the specified domain(s)</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain-1=example1.com domain-2=example2.com domain-3=example3.com</span> - Enable multiple domains&#x27; DMARC records.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain=example1.com domain=example2.com domain=example3.com</span> - Enable multiple domains&#x27; DMARC records.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> - Enable a single domain&#x27;s DMARC records.</li></ul><div><div html="&lt;p&gt;The domain for which to apply the DMARC record.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To enable multiple domain DMARC records, duplicate or increment the parameter. For example, to enable DMARC records for three domains, perform either of the following actions:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;Use the &lt;code&gt;domain&lt;/code&gt; parameter three times.&lt;/li&gt;
&lt;li&gt;Use the &lt;code&gt;domain&lt;/code&gt;, &lt;code&gt;domain-1&lt;/code&gt;, and &lt;code&gt;domain-2&lt;/code&gt; parameters.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;If you do not include this argument, the system applies the DMARC record to all the user&amp;#39;s domains.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain for which to apply the DMARC record.</p>
<p><strong>Note:</strong></p>
<p>To enable multiple domain DMARC records, duplicate or increment the parameter. For example, to enable DMARC records for three domains, perform either of the following actions:</p>
<ul>
<li>Use the <code>domain</code> parameter three times.</li>
<li>Use the <code>domain</code>, <code>domain-1</code>, and <code>domain-2</code> parameters.</li>
</ul>
<p>If you do not include this argument, the system applies the DMARC record to all the user&#39;s domains.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="policy" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">policy</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">policy=v=DMARC1;p=reject;pct=100;rua=mailto:postmaster@example.com</span></div><div><div html="&lt;p&gt;The DMARC record to apply to the requested domains.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;Visit the following link for more information about the DMARC record specification: &lt;a href=&quot;https://dmarc.org/resources/specification/&quot;&gt;https://dmarc.org/resources/specification/&lt;/a&gt;&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The DMARC record to apply to the requested domains.</p>
<p><strong>Note:</strong></p>
<p>Visit the following link for more information about the DMARC record specification: <a href="https://dmarc.org/resources/specification/">https://dmarc.org/resources/specification/</a></p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/EmailAuth/apply_dmarc</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/EmailAuth/apply_dmarc</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rii9b5a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rii9b5a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rii9b5a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii9b5a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rii9b5a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii9b5a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rii9b5a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii9b5a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rii9b5a:0" aria-labelledby="tab:Rii9b5a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  EmailAuth <span class="token punctuation">\</span>
  apply_dmarc <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">policy</span><span class="token operator">=</span><span class="token string">'v=DMARC1; p=reject;'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii9b5a:1" aria-labelledby="tab:Rii9b5a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii9b5a:2" aria-labelledby="tab:Rii9b5a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii9b5a:3" aria-labelledby="tab:Rii9b5a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rji9b5a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rji9b5a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rji9b5a:0" aria-labelledby="tab:Rji9b5a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;apply_dmarc&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;EmailAuth&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"msg"</span>: <span class="token string">&quot;[ADD:TXT@_dmarc.example.com:v=DMARC1; p=reject;]&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-DNS-Settings/operation/EmailAuth::remove_dmarc" data-section-id="tag/Email-DNS-Settings/operation/EmailAuth::remove_dmarc" class="sc-dntaoT ceciOs"><div data-section-id="operation/EmailAuth::remove_dmarc" id="operation/EmailAuth::remove_dmarc" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-DNS-Settings/operation/EmailAuth::remove_dmarc" aria-label="tag/Email-DNS-Settings/operation/EmailAuth::remove_dmarc"></a>Remove DMARC record from domain(s) </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function removes the DMARC record for domains.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes the DMARC record for domains.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain=example.com&amp;domain=example2.com&amp;domain=example.com</span> - Multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> - A single domain.</li></ul><div><div html="&lt;p&gt;The domain from which to remove the DMARC record.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If you do not include this argument, the system will remove &lt;strong&gt;all&lt;/strong&gt; DMARC records from &lt;strong&gt;all&lt;/strong&gt; domains owned by the user.&lt;/p&gt;
&lt;p&gt;To remove multiple domain DMARC records, duplicate the parameter name. For example, use the &lt;code&gt;domain=example.com&lt;/code&gt;, &lt;code&gt;domain=example2.com&lt;/code&gt;, and &lt;code&gt;domain=example3.com&lt;/code&gt; parameters.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain from which to remove the DMARC record.</p>
<p><strong>Note:</strong></p>
<p>If you do not include this argument, the system will remove <strong>all</strong> DMARC records from <strong>all</strong> domains owned by the user.</p>
<p>To remove multiple domain DMARC records, duplicate the parameter name. For example, use the <code>domain=example.com</code>, <code>domain=example2.com</code>, and <code>domain=example3.com</code> parameters.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/EmailAuth/remove_dmarc</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/EmailAuth/remove_dmarc</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riibb5a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riibb5a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riibb5a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riibb5a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riibb5a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riibb5a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riibb5a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riibb5a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riibb5a:0" aria-labelledby="tab:Riibb5a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  EmailAuth <span class="token punctuation">\</span>
  remove_dmarc <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riibb5a:1" aria-labelledby="tab:Riibb5a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riibb5a:2" aria-labelledby="tab:Riibb5a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riibb5a:3" aria-labelledby="tab:Riibb5a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjibb5a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjibb5a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjibb5a:0" aria-labelledby="tab:Rjibb5a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;remove_dmarc&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;EmailAuth&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"msg"</span>: <span class="token string">&quot;[REMOVE:TXT@_dmarc.example.com:v=DMARC1; p=reject;]&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-DNS-Settings/operation/EmailAuth::validate_current_dmarcs" data-section-id="tag/Email-DNS-Settings/operation/EmailAuth::validate_current_dmarcs" class="sc-dntaoT ceciOs"><div data-section-id="operation/EmailAuth::validate_current_dmarcs" id="operation/EmailAuth::validate_current_dmarcs" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-DNS-Settings/operation/EmailAuth::validate_current_dmarcs" aria-label="tag/Email-DNS-Settings/operation/EmailAuth::validate_current_dmarcs"></a>Validate domains&#x27; DMARC records </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function checks the validity of the current DMARC record for one or more domains.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks the validity of the current DMARC record for one or more domains.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain=example.com,domain=another.com,domain=yetanother.com</span> - Check DMARC records for multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain=example.com</span> - Check DMARC records for a single domain.</li></ul><div><div html="&lt;p&gt;The domain for which to check the DMARC record.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If you do not include this argument, the system will validate DMARC records for all domains owned by the user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain for which to check the DMARC record.</p>
<p><strong>Note:</strong></p>
<p>If you do not include this argument, the system will validate DMARC records for all domains owned by the user.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/EmailAuth/validate_current_dmarcs</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/EmailAuth/validate_current_dmarcs</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riidb5a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riidb5a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riidb5a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riidb5a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riidb5a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riidb5a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riidb5a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riidb5a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riidb5a:0" aria-labelledby="tab:Riidb5a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  EmailAuth <span class="token punctuation">\</span>
  validate_current_dmarcs <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riidb5a:1" aria-labelledby="tab:Riidb5a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riidb5a:2" aria-labelledby="tab:Riidb5a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riidb5a:3" aria-labelledby="tab:Riidb5a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjidb5a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjidb5a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjidb5a:0" aria-labelledby="tab:Rjidb5a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;validate_current_dmarcs&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;EmailAuth&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <span class="token string">&quot;(XID 4krw35) DNS returned SERVFAIL (code 2)\nin response to the system's query for _dmarc.example.com\nTXT records.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"record"</span>: <span class="token string">&quot;v=DMARC1; p=none;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <span class="token string">&quot;VALID&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subdomain"</span>: <span class="token string">&quot;_dmarc.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"suggested"</span>: <span class="token string">&quot;v=DMARC1; p=none;&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-DNS-Settings/operation/list_mxs" data-section-id="tag/Email-DNS-Settings/operation/list_mxs" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_mxs" id="operation/list_mxs" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-DNS-Settings/operation/list_mxs" aria-label="tag/Email-DNS-Settings/operation/list_mxs"></a>Return mail exchanger records </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists Mail Exchanger (MX) records.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;DNS&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists Mail Exchanger (MX) records.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>DNS</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The domain to query. If you do &lt;strong&gt;not&lt;/strong&gt; use this parameter, the function returns MX records for all of the cPanel account&amp;#39;s domains.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain to query. If you do <strong>not</strong> use this parameter, the function returns MX records for all of the cPanel account&#39;s domains.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/list_mxs</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/list_mxs</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riifb5a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riifb5a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riifb5a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riifb5a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riifb5a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riifb5a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riifb5a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riifb5a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riifb5a:0" aria-labelledby="tab:Riifb5a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  list_mxs
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riifb5a:1" aria-labelledby="tab:Riifb5a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riifb5a:2" aria-labelledby="tab:Riifb5a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riifb5a:3" aria-labelledby="tab:Riifb5a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjifb5a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjifb5a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjifb5a:0" aria-labelledby="tab:Rjifb5a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_mxs&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"alwaysaccept"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"detected"</span>: <span class="token string">&quot;local&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"entries"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"entrycount"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mx"</span>: <span class="token string">&quot;mx.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"priority"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"row"</span>: <span class="token string">&quot;odd&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"local"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mx"</span>: <span class="token string">&quot;mx.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mxcheck"</span>: <span class="token string">&quot;auto&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"remote"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"secondary"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"statusmsg"</span>: <span class="token string">&quot;Fetched MX List&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-DNS-Settings/operation/enable_dkim" data-section-id="tag/Email-DNS-Settings/operation/enable_dkim" class="sc-dntaoT ceciOs"><div data-section-id="operation/enable_dkim" id="operation/enable_dkim" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-DNS-Settings/operation/enable_dkim" aria-label="tag/Email-DNS-Settings/operation/enable_dkim"></a>Enable domains&#x27; DKIM records </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function enables DomainKeys Identified Mail (DKIM) records on the DNS server for one or more domains.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If a DKIM record does &lt;strong&gt;not&lt;/strong&gt; exist on the server, this function will install a new DKIM record.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables DomainKeys Identified Mail (DKIM) records on the DNS server for one or more domains.</p>
<p><strong>Note:</strong></p>
<p>If a DKIM record does <strong>not</strong> exist on the server, this function will install a new DKIM record.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain-1=example1.com domain-2=example2.com domain-3=example3.com</span> - Enable multiple domains&#x27; DKIM records.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain=example1.com domain=example2.com domain=example3.com</span> - Enable multiple domains&#x27; DKIM records.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> - Enable a single domain&#x27;s DKIM records.</li></ul><div><div html="&lt;p&gt;The domain for which to enable DKIM records on the DNS server.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To enable multiple domain DKIM records, duplicate or increment the parameter. For example, to perform this for three domains, you could:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;Use the &lt;code&gt;domain&lt;/code&gt; parameter multiple times.&lt;/li&gt;
&lt;li&gt;Use the &lt;code&gt;domain&lt;/code&gt;, &lt;code&gt;domain-1&lt;/code&gt;, and &lt;code&gt;domain-2&lt;/code&gt; parameters.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain for which to enable DKIM records on the DNS server.</p>
<p><strong>Note:</strong></p>
<p>To enable multiple domain DKIM records, duplicate or increment the parameter. For example, to perform this for three domains, you could:</p>
<ul>
<li>Use the <code>domain</code> parameter multiple times.</li>
<li>Use the <code>domain</code>, <code>domain-1</code>, and <code>domain-2</code> parameters.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/EmailAuth/enable_dkim</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/EmailAuth/enable_dkim</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riihb5a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riihb5a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riihb5a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riihb5a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riihb5a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riihb5a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riihb5a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riihb5a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riihb5a:0" aria-labelledby="tab:Riihb5a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  EmailAuth <span class="token punctuation">\</span>
  enable_dkim <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riihb5a:1" aria-labelledby="tab:Riihb5a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riihb5a:2" aria-labelledby="tab:Riihb5a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riihb5a:3" aria-labelledby="tab:Riihb5a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjihb5a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjihb5a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjihb5a:0" aria-labelledby="tab:Rjihb5a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;enable_dkim&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;EmailAuth&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"msg"</span>: <span class="token string">&quot;[no changes needed]&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-DNS-Settings/operation/ensure_dkim_keys_exist" data-section-id="tag/Email-DNS-Settings/operation/ensure_dkim_keys_exist" class="sc-dntaoT ceciOs"><div data-section-id="operation/ensure_dkim_keys_exist" id="operation/ensure_dkim_keys_exist" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-DNS-Settings/operation/ensure_dkim_keys_exist" aria-label="tag/Email-DNS-Settings/operation/ensure_dkim_keys_exist"></a>Validate domains&#x27; DKIM private keys </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function confirms the validity of a DomainKeys Identified Mail (DKIM) key for one or more domains.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Notes:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;If an existing DKIM key does &lt;strong&gt;not&lt;/strong&gt; meet the server&amp;#39;s security requirements, the system replaces the existing DKIM key.&lt;/li&gt;
&lt;li&gt;If no DKIM key exists, the system creates a new key for the domain.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function confirms the validity of a DomainKeys Identified Mail (DKIM) key for one or more domains.</p>
<p><strong>Notes:</strong></p>
<ul>
<li>If an existing DKIM key does <strong>not</strong> meet the server&#39;s security requirements, the system replaces the existing DKIM key.</li>
<li>If no DKIM key exists, the system creates a new key for the domain.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain=example.com&amp;domain=example2.com&amp;domain=example3.com</span> - Multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> - A single domain.</li></ul><div><div html="&lt;p&gt;The domain for which to confirm a valid DKIM key exists.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; To check the DKIM key validity for multiple domains, duplicate the parameter name. For example, use the &lt;code&gt;domain=example.com&lt;/code&gt;, &lt;code&gt;domain=example2.com&lt;/code&gt;, and &lt;code&gt;domain=example3.com&lt;/code&gt; parameters.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain for which to confirm a valid DKIM key exists.</p>
<p><strong>Note:</strong></p>
<p> To check the DKIM key validity for multiple domains, duplicate the parameter name. For example, use the <code>domain=example.com</code>, <code>domain=example2.com</code>, and <code>domain=example3.com</code> parameters.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/EmailAuth/ensure_dkim_keys_exist</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/EmailAuth/ensure_dkim_keys_exist</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riijb5a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riijb5a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riijb5a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riijb5a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riijb5a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riijb5a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riijb5a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riijb5a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riijb5a:0" aria-labelledby="tab:Riijb5a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  EmailAuth <span class="token punctuation">\</span>
  ensure_dkim_keys_exist <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riijb5a:1" aria-labelledby="tab:Riijb5a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riijb5a:2" aria-labelledby="tab:Riijb5a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riijb5a:3" aria-labelledby="tab:Riijb5a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjijb5a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjijb5a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjijb5a:0" aria-labelledby="tab:Rjijb5a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;ensure_dkim_keys_exist&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;EmailAuth&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"msg"</span>: <span class="token string">&quot;created new key&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-DNS-Settings/operation/fetch_dkim_private_keys" data-section-id="tag/Email-DNS-Settings/operation/fetch_dkim_private_keys" class="sc-dntaoT ceciOs"><div data-section-id="operation/fetch_dkim_private_keys" id="operation/fetch_dkim_private_keys" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-DNS-Settings/operation/fetch_dkim_private_keys" aria-label="tag/Email-DNS-Settings/operation/fetch_dkim_private_keys"></a>Return domains&#x27; DKIM private keys </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns a domain&amp;#39;s installed DKIM private key in &lt;a href=&quot;https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail&quot;&gt;Privacy-Enhanced Mail (PEM)&lt;/a&gt; format.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;We &lt;strong&gt;strongly&lt;/strong&gt; recommend that you protect your private key. If others obtain your private DKIM key, they could sign emails and impersonate you as a sender.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns a domain&#39;s installed DKIM private key in <a href="https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail">Privacy-Enhanced Mail (PEM)</a> format.</p>
<p><strong>Warning:</strong></p>
<p>We <strong>strongly</strong> recommend that you protect your private key. If others obtain your private DKIM key, they could sign emails and impersonate you as a sender.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain=example.com&amp;domain=example2.com&amp;domain=example3.com</span> - Multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> - A single domain.</li></ul><div><div html="&lt;p&gt;The domain for which to retrieve the installed DKIM private key.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To retrieve multiple domain DKIM keys, duplicate the parameter name. For example, use the &lt;code&gt;domain=example.com&lt;/code&gt;, &lt;code&gt;domain=example2.com&lt;/code&gt;, and &lt;code&gt;domain=example3.com&lt;/code&gt; parameters.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain for which to retrieve the installed DKIM private key.</p>
<p><strong>Note:</strong></p>
<p>To retrieve multiple domain DKIM keys, duplicate the parameter name. For example, use the <code>domain=example.com</code>, <code>domain=example2.com</code>, and <code>domain=example3.com</code> parameters.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/EmailAuth/fetch_dkim_private_keys</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/EmailAuth/fetch_dkim_private_keys</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riilb5a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riilb5a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riilb5a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riilb5a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riilb5a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riilb5a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riilb5a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riilb5a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riilb5a:0" aria-labelledby="tab:Riilb5a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  EmailAuth <span class="token punctuation">\</span>
  fetch_dkim_private_keys <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riilb5a:1" aria-labelledby="tab:Riilb5a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riilb5a:2" aria-labelledby="tab:Riilb5a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riilb5a:3" aria-labelledby="tab:Riilb5a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjilb5a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjilb5a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjilb5a:0" aria-labelledby="tab:Rjilb5a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;fetch_dkim_private_keys&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;EmailAuth&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pem"</span>: <span class="token string">&quot;-----BEGIN RSA PRIVATE KEY-----\nMIICLDCCAdKgAwIBAgIBADAKBggqhkjOPQQDAjB9MQswCQYDVQQGEwJCRTEPMA0G\nA1UEChMGR251VExTMSUwIwYDVQQLExxHbnVUTFMgY2VydGlmaWNhdGUgYXV0aG9y\naXR5MQ8wDQYDVQQIEwZMZXV2ZW4xJTAjBgNVBAMTHEdudVRMUyBjZXJ0aWZpY2F0\nZSBhdXRob3JpdHkwHhcNMTEwNTIzMjAzODIxWhcNMTIxMjIyMDc0MTUxWjB9MQsw\nCQYDVQQGEwJCRTEPMA0GA1UEChMGR251VExTMSUwIwYDVQQLExxHbnVUTFMgY2Vy\ndGlmaWNhdGUgYXV0aG9yaXR5MQ8wDQYDVQQIEwZMZXV2ZW4xJTAjBgNVBAMTHEdu\ndVRMUyBjZXJ0aWZpY2F0ZSBhdXRob3JpdHkwWTATBgcqhkjOPQIBBggqhkjOPQMB\nBwNCAARS2I0jiuNn14Y2sSALCX3IybqiIJUvxUpj+oNfzngvj/Niyv2394BWnW4X\nuQ4RTEiywK87WRcWMGgJB5kX/t2no0MwQTAPBgNVHRMBAf8EBTADAQH/MA8GA1Ud\nDwEB/wQFAwMHBgAwHQYDVR0OBBYEFPC0gf6YEr+1KLlkQAPLzB9mTigDMAoGCCqG\nSM49BAMCA0gAMEUCIDGuwD1KPyG+hRf88MeyMQcqOFZD0TbVleF+UsAGQ4enAiEA\nl4wOuDwKQa+upc8GftXE2C//4mKANBC6It01gUaTIpo==\n-----END RSA PRIVATE KEY-----\n&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-DNS-Settings/operation/install_dkim_private_keys" data-section-id="tag/Email-DNS-Settings/operation/install_dkim_private_keys" class="sc-dntaoT ceciOs"><div data-section-id="operation/install_dkim_private_keys" id="operation/install_dkim_private_keys" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-DNS-Settings/operation/install_dkim_private_keys" aria-label="tag/Email-DNS-Settings/operation/install_dkim_private_keys"></a>Add domains&#x27; DKIM record keys </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function installs existing keys for use in a DomainKeys Identified Mail (DKIM) record. This is useful if you do not want the system to generate keys for DKIM records.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;This function does &lt;strong&gt;not&lt;/strong&gt; update the local DNS server&amp;#39;s records.&lt;/li&gt;
&lt;li&gt;If the local DNS server is authoritative for the domain&amp;#39;s DNS records, use the UAPI &lt;code&gt;EmailAuth::enable_dkim&lt;/code&gt; function to update the local DNS server&amp;#39;s DNS records.&lt;ul&gt;
&lt;li&gt;We recommend that you use the UAPI &lt;code&gt;EmailAuth::install_dkim_private_keys&lt;/code&gt; and &lt;code&gt;EmailAuth::enable_dkim functions&lt;/code&gt; in a batch UAPI call.&lt;/li&gt;
&lt;/ul&gt;
&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function installs existing keys for use in a DomainKeys Identified Mail (DKIM) record. This is useful if you do not want the system to generate keys for DKIM records.</p>
<p><strong>Note:</strong></p>
<ul>
<li>This function does <strong>not</strong> update the local DNS server&#39;s records.</li>
<li>If the local DNS server is authoritative for the domain&#39;s DNS records, use the UAPI <code>EmailAuth::enable_dkim</code> function to update the local DNS server&#39;s DNS records.<ul>
<li>We recommend that you use the UAPI <code>EmailAuth::install_dkim_private_keys</code> and <code>EmailAuth::enable_dkim functions</code> in a batch UAPI call.</li>
</ul>
</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain=example&amp;domain=example2.com&amp;domain=example3.com</span> - Multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example</span> - A single domain.</li></ul><div><div html="&lt;p&gt;The domain for which to install a DKIM private key on the local server.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To install multiple RSA private keys for multiple domains, duplicate the parameter name. For example, use the &lt;code&gt;domain=example.com&lt;/code&gt;, &lt;code&gt;domain=example2.com&lt;/code&gt;, and &lt;code&gt;domain=example3.com&lt;/code&gt; parameters.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain for which to install a DKIM private key on the local server.</p>
<p><strong>Note:</strong></p>
<p>To install multiple RSA private keys for multiple domains, duplicate the parameter name. For example, use the <code>domain=example.com</code>, <code>domain=example2.com</code>, and <code>domain=example3.com</code> parameters.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="key" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">key</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;pem-private-key&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key=-----BEGIN%20RSA%20PRIVATE%20KEY-----%0aAAAAB3NzaC1yc2EAAAABIwAAAQEA5kSivOqhs0U9ZMN20nxFe27QZ3t0lT2zbH7OSXylKd%0a1rjAjYXGnSXC9j2uaZlemHlptBKVziMJC86ha7Hcj6dVOVrDQ6vF4q34bOCjtKLphQ0IjB%0azVIvqILH9eLJdRaOrS34CmgmPaisrCk5wKVlakygvUfcj3HzaTKS6THyZDGx5shdTpa9lb%0ay8tpOD3JceV7ay4w8r0DipoKPC0OLpvS4EABEeMo9sx8zQEaKv03XygjNCCYtFvxlQQIRG%0alVoL7mPaHSaL3anI05RpNbm/PS+9BhZg+BqNjU4ofHBbfkXk5MiN6M7ieR4Sk5BquccboG%0aF13U5slNgmCEekdt0amw%0a-----END%20RSA%20PRIVATE%20KEY-----%0a</span></div><div><div html="&lt;p&gt;An RSA key in &lt;a href=&quot;https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail&quot;&gt;Privacy-Enhanced Mail (PEM)&lt;/a&gt; format.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You &lt;strong&gt;must&lt;/strong&gt; provide this parameter for each &lt;code&gt;domain&lt;/code&gt; parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An RSA key in <a href="https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail">Privacy-Enhanced Mail (PEM)</a> format.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> provide this parameter for each <code>domain</code> parameter.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/EmailAuth/install_dkim_private_keys</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/EmailAuth/install_dkim_private_keys</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riinb5a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riinb5a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riinb5a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riinb5a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riinb5a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riinb5a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riinb5a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riinb5a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riinb5a:0" aria-labelledby="tab:Riinb5a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  EmailAuth <span class="token punctuation">\</span>
  install_dkim_private_keys <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">key</span><span class="token operator">=</span><span class="token string">'-----BEGIN%20RSA%20PRIVATE%20KEY-----%0aAAAAB3NzaC1yc2EAAAABIwAAAQEA5kSivOqhs0U9ZMN20nxFe27QZ3t0lT2zbH7OSXylKd%0a1rjAjYXGnSXC9j2uaZlemHlptBKVziMJC86ha7Hcj6dVOVrDQ6vF4q34bOCjtKLphQ0IjB%0azVIvqILH9eLJdRaOrS34CmgmPaisrCk5wKVlakygvUfcj3HzaTKS6THyZDGx5shdTpa9lb%0ay8tpOD3JceV7ay4w8r0DipoKPC0OLpvS4EABEeMo9sx8zQEaKv03XygjNCCYtFvxlQQIRG%0alVoL7mPaHSaL3anI05RpNbm/PS+9BhZg+BqNjU4ofHBbfkXk5MiN6M7ieR4Sk5BquccboG%0aF13U5slNgmCEekdt0amw%0a-----END%20RSA%20PRIVATE%20KEY-----%0a'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riinb5a:1" aria-labelledby="tab:Riinb5a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riinb5a:2" aria-labelledby="tab:Riinb5a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riinb5a:3" aria-labelledby="tab:Riinb5a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjinb5a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjinb5a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjinb5a:0" aria-labelledby="tab:Rjinb5a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;install_dkim_private_keys&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;EmailAuth&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"msg"</span>: <span class="token string">&quot;[ADD:TXT@default._domainkey:v=DKIM1; k=rsa; p=AAAAB3NzaC1yc2EAAAABIwAAAQEA5kSivOqhs0U9ZMN20nxFe27QZ3t0lT2zbH7OSXylKd1rjAjYXGnSXC9j2uaZlemHlptBKVziMJC86ha7Hcj6dVOVrDQ6vF4q34bOCjtKLphQ0IjBzVIvqILH9eLJdRaOrS34CmgmPaisrCk5wKVlakygvUfcj3HzaTKS6THyZDGx5shdTpa9lby8tpOD3JceV7ay4w8r0DipoKPC0OLpvS4EABEeMo9sx8zQEaKv03XygjNCCYtFvxlQQIRGlVoL7mPaHSaL3anI05RpNbm/PS+9BhZg+BqNjU4ofHBbfkXk5MiN6M7ieR4Sk5BquccboGF13U5slNgmCEekdt0amw;]&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-DNS-Settings/operation/install_spf_records" data-section-id="tag/Email-DNS-Settings/operation/install_spf_records" class="sc-dntaoT ceciOs"><div data-section-id="operation/install_spf_records" id="operation/install_spf_records" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-DNS-Settings/operation/install_spf_records" aria-label="tag/Email-DNS-Settings/operation/install_spf_records"></a>Add domains&#x27; SPF records </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function installs a Sender Policy Framework (SPF) record for a domain on the DNS server.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function installs a Sender Policy Framework (SPF) record for a domain on the DNS server.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain=example.com&amp;domain=example2.com&amp;domain=example3.com</span> - Multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> - A single domain.</li></ul><div><div html="&lt;p&gt;The domain for which to install an SPF record on the DNS server.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To install multiple SPF records, duplicate the parameter name. For example, use the &lt;code&gt;domain=example.com&lt;/code&gt;, &lt;code&gt;domain=example2.com&lt;/code&gt;, and &lt;code&gt;domain=example3.com&lt;/code&gt; parameters.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain for which to install an SPF record on the DNS server.</p>
<p><strong>Note:</strong></p>
<p>To install multiple SPF records, duplicate the parameter name. For example, use the <code>domain=example.com</code>, <code>domain=example2.com</code>, and <code>domain=example3.com</code> parameters.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="record" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">record</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">record=&quot;v=spf1 ip4:10.0.0.1 %2Ba %2Bmx %2Bip4:10.0.0.2 %2Bip4:10.0.0.3 -all&quot;</span></div><div><div html="&lt;p&gt;An SPF record.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You &lt;strong&gt;must&lt;/strong&gt; provide this parameter for each &lt;code&gt;domain&lt;/code&gt; parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An SPF record.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> provide this parameter for each <code>domain</code> parameter.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/EmailAuth/install_spf_records</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/EmailAuth/install_spf_records</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riipb5a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riipb5a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riipb5a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riipb5a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riipb5a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riipb5a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riipb5a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riipb5a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riipb5a:0" aria-labelledby="tab:Riipb5a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  EmailAuth <span class="token punctuation">\</span>
  install_spf_records <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">record</span><span class="token operator">=</span><span class="token string">'"v=spf1 ip4:10.0.0.1 %2Ba %2Bmx %2Bip4:10.0.0.2 %2Bip4:10.0.0.3 -all"'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riipb5a:1" aria-labelledby="tab:Riipb5a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riipb5a:2" aria-labelledby="tab:Riipb5a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riipb5a:3" aria-labelledby="tab:Riipb5a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjipb5a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjipb5a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjipb5a:0" aria-labelledby="tab:Rjipb5a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;install_spf_records&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;EmailAuth&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"msg"</span>: <span class="token string">&quot;[ADD:TXT@example.com.:v=spf1 ip4:10.0.0.1 %2Ba %2Bmx %2Bip4:10.0.0.2 %2Bip4:10.0.0.3 -all]&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-DNS-Settings/operation/validate_current_dkims" data-section-id="tag/Email-DNS-Settings/operation/validate_current_dkims" class="sc-dntaoT ceciOs"><div data-section-id="operation/validate_current_dkims" id="operation/validate_current_dkims" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-DNS-Settings/operation/validate_current_dkims" aria-label="tag/Email-DNS-Settings/operation/validate_current_dkims"></a>Validate domains&#x27; DKIM records </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves and checks the DomainKeys Identified Mail
(DKIM) records for one or more domains.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves and checks the DomainKeys Identified Mail
(DKIM) records for one or more domains.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain=example.com,domain=another.com,domain=yetanother.com
domain=example.com,domain-1=another.com,domain-2=yetanother.com</span> - Check DKIM records for a multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> - Check DKIM records for a single domain.</li></ul><div><div html="&lt;p&gt;The domain for which to check the DKIM records.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain for which to check the DKIM records.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/EmailAuth/validate_current_dkims</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/EmailAuth/validate_current_dkims</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riirb5a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riirb5a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riirb5a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riirb5a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riirb5a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riirb5a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riirb5a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riirb5a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riirb5a:0" aria-labelledby="tab:Riirb5a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  EmailAuth <span class="token punctuation">\</span>
  validate_current_dkims <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riirb5a:1" aria-labelledby="tab:Riirb5a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riirb5a:2" aria-labelledby="tab:Riirb5a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riirb5a:3" aria-labelledby="tab:Riirb5a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjirb5a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjirb5a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjirb5a:0" aria-labelledby="tab:Rjirb5a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;validate_current_dkims&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;EmailAuth&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;default._domainkey.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <span class="token string">&quot;(XID 4krw35) DNS returned SERVFAIL (code 2)\nin response to the systems query for default._domainkey.example2.coms\nTXT records.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expected"</span>: <span class="token string">&quot;v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDw5nw4NP1RsWXlfmiMzByDfOT16QCZO\\/xJtrPZKskZF8\\/sU0zWGTqKUOErlyJfoJzMDUv3\\/zzjGswc2nEmYqxxoQZaBkN4QaS6MvJQxysAr+sK8C248\\/r9zMperQdhJedUVejtpFQHJwgqpHy1tQMxY37L7sQjdxmQ5WnQ1acXiwIDAQAB&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"records"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"current"</span>: <span class="token string">&quot;v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDw5nw4NP1RsWXlfmiMzByDfOT16QCZO\\/xJtrPZKskZF8\\/sU0zWGTqKUOErlyJfoJzMDUv3\\/zzjGswc2nEmYqxxoQZaBkN4QaS6MvJQxysAr+sK8C248\\/r9zMperQdhJedUVejtpFQHJwgqpHy1tQMxY37L7sQjdxmQ5WnQ1acXiwIDAQAB&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">&quot;example.com: The DKIM version must be \&quot;DKIM1\&quot;.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <span class="token string">&quot;VALID&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <span class="token string">&quot;VALID&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"validity_cache_update"</span>: <span class="token string">&quot;valid&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-DNS-Settings/operation/validate_current_ptrs" data-section-id="tag/Email-DNS-Settings/operation/validate_current_ptrs" class="sc-dntaoT ceciOs"><div data-section-id="operation/validate_current_ptrs" id="operation/validate_current_ptrs" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-DNS-Settings/operation/validate_current_ptrs" aria-label="tag/Email-DNS-Settings/operation/validate_current_ptrs"></a>Validate domains&#x27; PTR records </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function validates the pointer records (PTR) for IPv4 and
IPv6 addresses that the account&amp;#39;s domains send mail from. It retrieves the
PTR records for each IP address and determines which of the domain&amp;#39;s IP addresses
send mail. It then validates the PTR records for each IP address and validates
the A or AAAA records pointing to each domain. This function also ensures
that at least one of that domain&amp;#39;s A or AAAA records points back to the IP
address.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function validates the pointer records (PTR) for IPv4 and
IPv6 addresses that the account&#39;s domains send mail from. It retrieves the
PTR records for each IP address and determines which of the domain&#39;s IP addresses
send mail. It then validates the PTR records for each IP address and validates
the A or AAAA records pointing to each domain. This function also ensures
that at least one of that domain&#39;s A or AAAA records points back to the IP
address.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=`domain`=example.com,`domain`=another.com,`domain`=yetanother.com
`domain`=example.com,`domain-1`=another.com,`domain-2`=yetanother.com</span> - Check PTR records for a multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> - Check PTR records for a single domain.</li></ul><div><div html="&lt;p&gt;The domain for which to validate the PTR records.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain for which to validate the PTR records.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/EmailAuth/validate_current_ptrs</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/EmailAuth/validate_current_ptrs</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riitb5a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riitb5a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riitb5a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riitb5a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riitb5a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riitb5a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riitb5a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riitb5a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riitb5a:0" aria-labelledby="tab:Riitb5a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  EmailAuth <span class="token punctuation">\</span>
  validate_current_ptrs <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riitb5a:1" aria-labelledby="tab:Riitb5a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riitb5a:2" aria-labelledby="tab:Riitb5a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riitb5a:3" aria-labelledby="tab:Riitb5a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjitb5a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjitb5a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjitb5a:0" aria-labelledby="tab:Rjitb5a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;validate_current_ptrs&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;EmailAuth&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"arpa_domain"</span>: <span class="token string">&quot;1.0.0.10.in-addr.arpa&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <span class="token string">&quot;1.1.1.1.1 is not a valid IP address.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"helo"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip_address"</span>: <span class="token string">&quot;10.0.0.1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip_version"</span>: <span class="token number">4</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nameservers"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;ns1.example.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ptr_records"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"forward_records"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;10.0.0.1&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <span class="token string">&quot;VALID&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <span class="token string">&quot;VALID&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-DNS-Settings/operation/disable_dkim" data-section-id="tag/Email-DNS-Settings/operation/disable_dkim" class="sc-dntaoT ceciOs"><div data-section-id="operation/disable_dkim" id="operation/disable_dkim" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-DNS-Settings/operation/disable_dkim" aria-label="tag/Email-DNS-Settings/operation/disable_dkim"></a>Remove domains&#x27; DKIM records </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function removes the DomainKeys Identified Mail (DKIM) records on the DNS server for one or more domains.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes the DomainKeys Identified Mail (DKIM) records on the DNS server for one or more domains.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain=example.com&amp;domain=example2.com&amp;domain=example.com</span> - Multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> - A single domain.</li></ul><div><div html="&lt;p&gt;The domain for which to remove DKIM records on the DNS server.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To remove multiple domain DKIM records, duplicate the parameter name. For example, use the &lt;code&gt;domain=example.com&lt;/code&gt;, &lt;code&gt;domain=example2.com&lt;/code&gt;, and &lt;code&gt;domain=example3.com&lt;/code&gt; parameters.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain for which to remove DKIM records on the DNS server.</p>
<p><strong>Note:</strong></p>
<p>To remove multiple domain DKIM records, duplicate the parameter name. For example, use the <code>domain=example.com</code>, <code>domain=example2.com</code>, and <code>domain=example3.com</code> parameters.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/EmailAuth/disable_dkim</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/EmailAuth/disable_dkim</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riivb5a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riivb5a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riivb5a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riivb5a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riivb5a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riivb5a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riivb5a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riivb5a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riivb5a:0" aria-labelledby="tab:Riivb5a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  EmailAuth <span class="token punctuation">\</span>
  disable_dkim <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riivb5a:1" aria-labelledby="tab:Riivb5a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riivb5a:2" aria-labelledby="tab:Riivb5a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riivb5a:3" aria-labelledby="tab:Riivb5a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjivb5a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjivb5a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjivb5a:0" aria-labelledby="tab:Rjivb5a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;disable_dkim&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;EmailAuth&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"msg"</span>: <span class="token string">&quot;[REMOVE:TXT@default._domainkey:v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiLMNOpQDw5nw4NP1RsWXlfmiMzByDfOT16QCZO/xJtrPZKskZF8/sU0zWGTqKUOErlyJfoJzMDUv3/zzjGswc2nEmYqxxoQZaBkN4QaS6MvJQxysAr+sK8C248/r9zMperQdhJedUVejtpFQHJwgqpHy1tQMxY37L7sQjdxmQ5WnQ1acXiwIDAQAB\\;]&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-DNS-Settings/operation/validate_current_spfs" data-section-id="tag/Email-DNS-Settings/operation/validate_current_spfs" class="sc-dntaoT ceciOs"><div data-section-id="operation/validate_current_spfs" id="operation/validate_current_spfs" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-DNS-Settings/operation/validate_current_spfs" aria-label="tag/Email-DNS-Settings/operation/validate_current_spfs"></a>Validate domains&#x27; SPF records </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves the the Sender Policy Framework (SPF) records
for one or more domains.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the the Sender Policy Framework (SPF) records
for one or more domains.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=`domain`=example.com,`domain`=another.com,`domain`=yetanother.com
`domain`=example.com,`domain-1`=another.com,`domain-2`=yetanother.com</span> - Check `SPF` records for a multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> - Check `SPF` records for a single domain.</li></ul><div><div html="&lt;p&gt;The domain for which to check the &lt;code&gt;SPF&lt;/code&gt; records.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain for which to check the <code>SPF</code> records.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/EmailAuth/validate_current_spfs</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/EmailAuth/validate_current_spfs</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rij1b5a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rij1b5a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rij1b5a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij1b5a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rij1b5a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij1b5a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rij1b5a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij1b5a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rij1b5a:0" aria-labelledby="tab:Rij1b5a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  EmailAuth <span class="token punctuation">\</span>
  validate_current_spfs <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij1b5a:1" aria-labelledby="tab:Rij1b5a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij1b5a:2" aria-labelledby="tab:Rij1b5a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij1b5a:3" aria-labelledby="tab:Rij1b5a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjj1b5a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj1b5a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj1b5a:0" aria-labelledby="tab:Rjj1b5a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;validate_current_spfs&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;EmailAuth&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"error"</span>: <span class="token string">&quot;(XID rm8h9f) DNS returned SERVFAIL (code 2)\nin response to the systems query for example2.coms\nTXT records.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expected"</span>: <span class="token string">&quot;ip6:0:0:0:0:0:ffff:c0a8:101&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip_address"</span>: <span class="token string">&quot;0:0:0:0:0:ffff:c0a8:101&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip_version"</span>: <span class="token number">6</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"records"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"current"</span>: <span class="token string">&quot;v=spf1 +a +mx ip6:0:0:0:0:0:ffff:c0a8:101 ~all&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">&quot;'example.com: Sender\nis not authorized by default to use ''example.com''\nin ''helo'' identity, however domain is not\ncurrently prepared for false failures (mechanism\n''~all'' matched)'&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <span class="token string">&quot;PASS&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <span class="token string">&quot;VALID&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Direct-Link-Protection-(Hotlink)" data-section-id="tag/Direct-Link-Protection-(Hotlink)" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Direct-Link-Protection-(Hotlink)" aria-label="tag/Direct-Link-Protection-(Hotlink)"></a>Direct Link Protection (Hotlink)</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Domain Management / Direct Link Protection (Hotlink)&lt;/p&gt;
"><p>Domain Management / Direct Link Protection (Hotlink)</p>
</div></div></div><div id="tag/Direct-Link-Protection-(Hotlink)/operation/delete_hotlink" data-section-id="tag/Direct-Link-Protection-(Hotlink)/operation/delete_hotlink" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete_hotlink" id="operation/delete_hotlink" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Direct-Link-Protection-(Hotlink)/operation/delete_hotlink" aria-label="tag/Direct-Link-Protection-(Hotlink)/operation/delete_hotlink"></a>Disable hotlink protection </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function removes hotlink protection.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Web Server&lt;/a&gt; role, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes hotlink protection.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">Web Server</a> role, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mime/delete_hotlink</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mime/delete_hotlink</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ab35q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ab35q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ab35q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab35q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2ab35q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab35q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2ab35q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab35q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ab35q:0" aria-labelledby="tab:R2ab35q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mime <span class="token punctuation">\</span>
  delete_hotlink
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab35q:1" aria-labelledby="tab:R2ab35q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab35q:2" aria-labelledby="tab:R2ab35q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab35q:3" aria-labelledby="tab:R2ab35q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eb35q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eb35q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eb35q:0" aria-labelledby="tab:R2eb35q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;delete_hotlink&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mime&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Direct-Link-Protection-(Hotlink)/operation/add_hotlink" data-section-id="tag/Direct-Link-Protection-(Hotlink)/operation/add_hotlink" class="sc-dntaoT ceciOs"><div data-section-id="operation/add_hotlink" id="operation/add_hotlink" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Direct-Link-Protection-(Hotlink)/operation/add_hotlink" aria-label="tag/Direct-Link-Protection-(Hotlink)/operation/add_hotlink"></a>Enable hotlink protection </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function adds hotlink protection for a site. Hotlink protection will redirect users to another URL if they navigate to a file with a specified extension, but an allowed URL did not refer them.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;WebServer role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function adds hotlink protection for a site. Hotlink protection will redirect users to another URL if they navigate to a file with a specified extension, but an allowed URL did not refer them.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">WebServer role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="allow_null" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">allow_null</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">allow_null=1</span></div><div><div html="&lt;p&gt;Whether the domain allows hotlinks.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Allows.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Does &lt;strong&gt;not&lt;/strong&gt; allow.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the domain allows hotlinks.</p>
<ul>
<li><code>1</code> - Allows.</li>
<li><code>0</code> - Does <strong>not</strong> allow.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="extensions" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">extensions</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">extensions=foo,bar</span> - Add hotlink protection for multiple file extensions.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">extensions=foo</span> - Add hotlink protection for a single file extension.</li></ul><div><div html="&lt;p&gt;File types to hotlink protect.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To protect multiple file types, use a comma-separated list.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>File types to hotlink protect.</p>
<p><strong>Note:</strong></p>
<p>To protect multiple file types, use a comma-separated list.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="redirect_url" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">redirect_url</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;url&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">redirect_url=http://redirect.example.com/</span></div><div><div html="&lt;p&gt;The URL to which the system sends hotlinkers.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The URL to which the system sends hotlinkers.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="urls" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">urls</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">urls=http://example.com/
http://foobar.com/</span> - Add hotlink protection for multiple sites.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">urls=http://example.com/</span> - Add hotlink protection for a single site.</li></ul><div><div html="&lt;p&gt;The site to hotlink protect.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To protect multiple URLs, separate each URL with a newline character.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The site to hotlink protect.</p>
<p><strong>Note:</strong></p>
<p>To protect multiple URLs, separate each URL with a newline character.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mime/add_hotlink</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mime/add_hotlink</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ad35q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ad35q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ad35q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ad35q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2ad35q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ad35q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2ad35q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ad35q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ad35q:0" aria-labelledby="tab:R2ad35q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mime <span class="token punctuation">\</span>
  add_hotlink <span class="token punctuation">\</span>
  <span class="token assign-left variable">urls</span><span class="token operator">=</span><span class="token string">'http://example.com/'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">extensions</span><span class="token operator">=</span><span class="token string">'foo'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">redirect_url</span><span class="token operator">=</span><span class="token string">'http://redirect.example.com/'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ad35q:1" aria-labelledby="tab:R2ad35q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ad35q:2" aria-labelledby="tab:R2ad35q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ad35q:3" aria-labelledby="tab:R2ad35q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ed35q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ed35q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ed35q:0" aria-labelledby="tab:R2ed35q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;add_hotlink&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mime&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Direct-Link-Protection-(Hotlink)/operation/list_hotlinks" data-section-id="tag/Direct-Link-Protection-(Hotlink)/operation/list_hotlinks" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_hotlinks" id="operation/list_hotlinks" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Direct-Link-Protection-(Hotlink)/operation/list_hotlinks" aria-label="tag/Direct-Link-Protection-(Hotlink)/operation/list_hotlinks"></a>Return domains with hotlink protection </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists domains with hotlink protection.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you &lt;strong&gt;disable&lt;/strong&gt; the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Web Server&lt;/a&gt; role, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists domains with hotlink protection.</p>
<p><strong>Important:</strong></p>
<p>When you <strong>disable</strong> the <a href="https://go.cpanel.net/serverroles">Web Server</a> role, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mime/list_hotlinks</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mime/list_hotlinks</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2af35q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2af35q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2af35q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2af35q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2af35q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2af35q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2af35q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2af35q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2af35q:0" aria-labelledby="tab:R2af35q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mime <span class="token punctuation">\</span>
  list_hotlinks
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2af35q:1" aria-labelledby="tab:R2af35q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2af35q:2" aria-labelledby="tab:R2af35q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2af35q:3" aria-labelledby="tab:R2af35q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ef35q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ef35q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ef35q:0" aria-labelledby="tab:R2ef35q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_hotlinks&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mime&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"allow_null"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"extensions"</span>: <span class="token string">&quot;jpg,jpeg,gif,png,bmp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"redirect_url"</span>: <span class="token string">&quot;</span><a href="http://redirect.example.com/">http://redirect.example.com/</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <span class="token string">&quot;disabled&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"urls"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;</span><a href="http://example.com/">http://example.com/</a><span class="token string">&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Domain-Information" data-section-id="tag/Domain-Information" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Information" aria-label="tag/Domain-Information"></a>Domain Information</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Domain Management / Domain Information&lt;/p&gt;
"><p>Domain Management / Domain Information</p>
</div></div></div><div id="tag/Domain-Information/operation/domains_data" data-section-id="tag/Domain-Information/operation/domains_data" class="sc-dntaoT ceciOs"><div data-section-id="operation/domains_data" id="operation/domains_data" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Information/operation/domains_data" aria-label="tag/Domain-Information/operation/domains_data"></a>Return all domains&#x27; hosting configuration </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists user data for the cPanel account&amp;#39;s domains.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This function retrieves data from the &lt;code&gt;/var/cpanel/userdata/user/domain&lt;/code&gt; file, where &lt;code&gt;user&lt;/code&gt;
represents the cPanel account username and &lt;code&gt;domain&lt;/code&gt; represents the domain. For this reason,
actual output may not contain all of the returns that this document lists.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists user data for the cPanel account&#39;s domains.</p>
<p><strong>Note:</strong></p>
<p>This function retrieves data from the <code>/var/cpanel/userdata/user/domain</code> file, where <code>user</code>
represents the cPanel account username and <code>domain</code> represents the domain. For this reason,
actual output may not contain all of the returns that this document lists.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="format" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">format</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;hash&quot;</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;hash&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;list&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">format=hash</span></div><div><div html="&lt;p&gt;The function&amp;#39;s return format.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;hash&lt;/code&gt; — Use a hash format. The function will return objects based on the domain type.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;list&lt;/code&gt; — Use a list format. The function will return an array of objects, where each object is a domain.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The function&#39;s return format.</p>
<ul>
<li><code>hash</code> — Use a hash format. The function will return objects based on the domain type.</li>
<li><code>list</code> — Use a list format. The function will return an array of objects, where each object is a domain.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="return_https_redirects_status" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">return_https_redirects_status</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">return_https_redirects_status=1</span></div><div><div html="&lt;p&gt;Whether to return the secure redirect status of the addon domains.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Return the status.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Do &lt;strong&gt;not&lt;/strong&gt; return the status.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to return the secure redirect status of the addon domains.</p>
<ul>
<li><code>1</code> — Return the status.</li>
<li><code>0</code> — Do <strong>not</strong> return the status.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DomainInfo/domains_data</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DomainInfo/domains_data</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kj55q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kj55q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kj55q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj55q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kj55q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj55q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kj55q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj55q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kj55q:0" aria-labelledby="tab:R4kj55q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DomainInfo <span class="token punctuation">\</span>
  domains_data
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj55q:1" aria-labelledby="tab:R4kj55q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj55q:2" aria-labelledby="tab:R4kj55q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj55q:3" aria-labelledby="tab:R4kj55q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sj55q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sj55q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sj55q:0" aria-labelledby="tab:R4sj55q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Example</span><div class="sc-diYFot sc-frniUE jsRqjj esCYIP"><svg class="sc-kZrBCu JXohG" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="Output in hash return format." selected="">Output in hash return format.</option><option value="Output in list return format.">Output in list return format.</option></select><label>Output in hash return format.</label></div></div><div><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"addon_domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"all_aliases_valid"</span>: <span class="token string">&quot;0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_https_redirect"</span>: <span class="token string">&quot;0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"documentroot"</span>: <span class="token string">&quot;/home/user/public_html/seconddomain.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;seconddomain.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group"</span>: <span class="token string">&quot;user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hascgi"</span>: <span class="token string">&quot;1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/home/user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip"</span>: <span class="token string">&quot;192.168.0.128&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ipv6"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_https_redirecting"</span>: <span class="token string">&quot;0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"no_cache_update"</span>: <span class="token string">&quot;0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"owner"</span>: <span class="token string">&quot;root&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"serveradmin"</span>: <span class="token string">&quot;webmaster@seconddomain.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"serveralias"</span>: <span class="token string">&quot;seconddomain.com www.seconddomain.com www.seconddomain.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"servername"</span>: <span class="token string">&quot;seconddomain.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;addon_domain&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usecanonicalname"</span>: <span class="token string">&quot;Off&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">&quot;user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"userdirprotect"</span>: <span class="token string">&quot;&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"all_aliases_valid"</span>: <span class="token string">&quot;0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_https_redirect"</span>: <span class="token string">&quot;0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"documentroot"</span>: <span class="token string">&quot;/home/user/public_html/subdomain&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;exampledomain.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group"</span>: <span class="token string">&quot;user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hascgi"</span>: <span class="token string">&quot;1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/home/user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip"</span>: <span class="token string">&quot;192.168.0.128&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ipv6"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_https_redirecting"</span>: <span class="token string">&quot;0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"no_cache_update"</span>: <span class="token string">&quot;0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"owner"</span>: <span class="token string">&quot;root&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"serveradmin"</span>: <span class="token string">&quot;webmaster@subdomain.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"serveralias"</span>: <span class="token string">&quot;exampledomain.com www.exampledomain.com www.subdomain.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"servername"</span>: <span class="token string">&quot;subdomain.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;addon_domain&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usecanonicalname"</span>: <span class="token string">&quot;Off&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">&quot;user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"userdirprotect"</span>: <span class="token string">&quot;&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"all_aliases_valid"</span>: <span class="token string">&quot;0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_https_redirect"</span>: <span class="token string">&quot;0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"documentroot"</span>: <span class="token string">&quot;/home/user/addondomain/home/dir&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;addondomain.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group"</span>: <span class="token string">&quot;user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hascgi"</span>: <span class="token string">&quot;1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/home/user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip"</span>: <span class="token string">&quot;192.168.0.128&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ipv6"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_https_redirecting"</span>: <span class="token string">&quot;0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"main_domain"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"all_aliases_valid"</span>: <span class="token string">&quot;0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_https_redirect"</span>: <span class="token string">&quot;0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"customlog"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"format"</span>: <span class="token string">&quot;combined&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"target"</span>: <span class="token string">&quot;/usr/local/apache/domlogs/example.com&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"format"</span>: <span class="token string">&quot;\&quot;%{%s}t %I .\\n%{%s}t %O .\&quot;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"target"</span>: <span class="token string">&quot;/usr/local/apache/domlogs/example.com-bytes_log&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"documentroot"</span>: <span class="token string">&quot;/home/user/public_html&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group"</span>: <span class="token string">&quot;user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hascgi"</span>: <span class="token string">&quot;1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/home/user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ifmodulemodsuphpc"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"group"</span>: <span class="token string">&quot;user&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip"</span>: <span class="token string">&quot;192.168.0.128&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_https_redirecting"</span>: <span class="token string">&quot;0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"options"</span>: <span class="token string">&quot;ExecCGI Includes&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"owner"</span>: <span class="token string">&quot;root&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"port"</span>: <span class="token string">&quot;80&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"scriptalias"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/home/user/public_html/cgi-bin&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">&quot;/cgi-bin/&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/home/user/public_html/cgi-bin/&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">&quot;/cgi-bin/&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"serveradmin"</span>: <span class="token string">&quot;webmaster@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"serveralias"</span>: <span class="token string">&quot;parkeddomain.com www.parkeddomain.com www.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"servername"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;main_domain&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usecanonicalname"</span>: <span class="token string">&quot;Off&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">&quot;user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"userdirprotect"</span>: <span class="token string">&quot;&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"no_cache_update"</span>: <span class="token string">&quot;0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"owner"</span>: <span class="token string">&quot;root&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parked_capable_of_https_redirects"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;parkeddomain.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parked_domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;parkeddomain.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parked_with_https_redirects"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;parkeddomain.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"serveradmin"</span>: <span class="token string">&quot;webmaster@subdomain.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"serveralias"</span>: <span class="token string">&quot;addondomain.com www.addondomain.com www.subdomain.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"servername"</span>: <span class="token string">&quot;subdomain.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sub_domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"all_aliases_valid"</span>: <span class="token string">&quot;0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_https_redirect"</span>: <span class="token string">&quot;0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"documentroot"</span>: <span class="token string">&quot;/home/user/public_html/sub&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;sub.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group"</span>: <span class="token string">&quot;user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hascgi"</span>: <span class="token string">&quot;1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/home/user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip"</span>: <span class="token string">&quot;192.168.0.128&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ipv6"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_https_redirecting"</span>: <span class="token string">&quot;0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"no_cache_update"</span>: <span class="token string">&quot;0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"owner"</span>: <span class="token string">&quot;root&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"serveradmin"</span>: <span class="token string">&quot;webmaster@sub.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"serveralias"</span>: <span class="token string">&quot;www.sub.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"servername"</span>: <span class="token string">&quot;sub.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub_domain&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usecanonicalname"</span>: <span class="token string">&quot;Off&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">&quot;user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"userdirprotect"</span>: <span class="token string">&quot;&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;addon_domain&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usecanonicalname"</span>: <span class="token string">&quot;Off&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">&quot;user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"userdirprotect"</span>: <span class="token string">&quot;&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Domain-Information/operation/list_domains" data-section-id="tag/Domain-Information/operation/list_domains" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_domains" id="operation/list_domains" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Information/operation/list_domains" aria-label="tag/Domain-Information/operation/list_domains"></a>Return cPanel account&#x27;s domains </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the cPanel account&amp;#39;s domains.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;For this function to succeed, the &lt;code&gt;/var/cpanel/userdata/username/main&lt;/code&gt; file (where &lt;code&gt;username&lt;/code&gt; represents the authenticated user) &lt;strong&gt;must&lt;/strong&gt; possess the correct permissions. If a permissions error occurs, this function returns blank values for &lt;strong&gt;all&lt;/strong&gt; of its returns and does &lt;strong&gt;not&lt;/strong&gt; return an error message.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the cPanel account&#39;s domains.</p>
<p><strong>Note:</strong></p>
<p>For this function to succeed, the <code>/var/cpanel/userdata/username/main</code> file (where <code>username</code> represents the authenticated user) <strong>must</strong> possess the correct permissions. If a permissions error occurs, this function returns blank values for <strong>all</strong> of its returns and does <strong>not</strong> return an error message.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DomainInfo/list_domains</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DomainInfo/list_domains</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kl55q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kl55q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kl55q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl55q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kl55q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl55q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kl55q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl55q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kl55q:0" aria-labelledby="tab:R4kl55q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DomainInfo <span class="token punctuation">\</span>
  list_domains
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl55q:1" aria-labelledby="tab:R4kl55q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl55q:2" aria-labelledby="tab:R4kl55q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl55q:3" aria-labelledby="tab:R4kl55q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sl55q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sl55q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sl55q:0" aria-labelledby="tab:R4sl55q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_domains&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DomainInfo&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"addon_domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;addondomain.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"main_domain"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parked_domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;parkeddomain.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sub_domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;subdomain.example.com&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Domain-Information/operation/single_domain_data" data-section-id="tag/Domain-Information/operation/single_domain_data" class="sc-dntaoT ceciOs"><div data-section-id="operation/single_domain_data" id="operation/single_domain_data" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Information/operation/single_domain_data" aria-label="tag/Domain-Information/operation/single_domain_data"></a>Return domain&#x27;s hosting configuration </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists user data for a domain.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  This function retrieves data from the &lt;code&gt;/var/cpanel/userdata/user/domain&lt;/code&gt; file, where &lt;code&gt;user&lt;/code&gt; represents the cPanel account username and &lt;code&gt;domain&lt;/code&gt; represents the domain.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;Because aliases (parked domains) do &lt;strong&gt;not&lt;/strong&gt; use a user data file, this function &lt;strong&gt;cannot&lt;/strong&gt; query information for aliases. To retrieve information for an alias, specify the associated main or addon domain.&lt;/li&gt;
&lt;li&gt;Due to differences in user data files, the function&amp;#39;s actual output may not contain all of the returns that this document lists.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists user data for a domain.</p>
<p><strong>Important:</strong></p>
<p>  This function retrieves data from the <code>/var/cpanel/userdata/user/domain</code> file, where <code>user</code> represents the cPanel account username and <code>domain</code> represents the domain.</p>
<ul>
<li>Because aliases (parked domains) do <strong>not</strong> use a user data file, this function <strong>cannot</strong> query information for aliases. To retrieve information for an alias, specify the associated main or addon domain.</li>
<li>Due to differences in user data files, the function&#39;s actual output may not contain all of the returns that this document lists.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The domain on the cPanel account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;Do &lt;strong&gt;not&lt;/strong&gt; specify an alias (parked domain).&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain on the cPanel account.</p>
<p><strong>Important:</strong></p>
<p>Do <strong>not</strong> specify an alias (parked domain).</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="return_https_redirect_status" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">return_https_redirect_status</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">return_https_redirect_status=1</span></div><div><div html="&lt;p&gt;Whether to return the secure redirect status of the addon domains.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Return status.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Do &lt;strong&gt;not&lt;/strong&gt; return status.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to return the secure redirect status of the addon domains.</p>
<ul>
<li><code>1</code> - Return status.</li>
<li><code>0</code> - Do <strong>not</strong> return status.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DomainInfo/single_domain_data</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DomainInfo/single_domain_data</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kn55q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kn55q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kn55q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn55q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kn55q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn55q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kn55q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn55q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kn55q:0" aria-labelledby="tab:R4kn55q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DomainInfo <span class="token punctuation">\</span>
  single_domain_data <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn55q:1" aria-labelledby="tab:R4kn55q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn55q:2" aria-labelledby="tab:R4kn55q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn55q:3" aria-labelledby="tab:R4kn55q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sn55q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sn55q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sn55q:0" aria-labelledby="tab:R4sn55q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;single_domain_data&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DomainInfo&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"all_aliases_valid"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"can_https_redirect"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"customlog"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;combined&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"target"</span>: <span class="token string">&quot;/usr/local/apache/domlogs/example.com&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"documentroot"</span>: <span class="token string">&quot;/home/user/public_html/&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"group"</span>: <span class="token string">&quot;user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hascgi"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/home/user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ifmodulemodsuphpc"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"group"</span>: <span class="token string">&quot;user&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip"</span>: <span class="token string">&quot;192.168.0.128&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_https_redirecting"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"options"</span>: <span class="token string">&quot;ExecCGI Includes&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"owner"</span>: <span class="token string">&quot;root&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phpopenbasedirprotect"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"port"</span>: <span class="token number">80</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"scriptalias"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/home/user/public_html/cgi-bin&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">&quot;/cgi-bin/&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"serveradmin"</span>: <span class="token string">&quot;webmaster@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"serveralias"</span>: <span class="token string">&quot;parkeddomain.com www.parkeddomain.com www.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"servername"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;main_domain&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usecanonicalname"</span>: <span class="token string">&quot;Off&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">&quot;user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"userdirprotect"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Domain-Information/operation/main_domain_builtin_subdomain_aliases" data-section-id="tag/Domain-Information/operation/main_domain_builtin_subdomain_aliases" class="sc-dntaoT ceciOs"><div data-section-id="operation/main_domain_builtin_subdomain_aliases" id="operation/main_domain_builtin_subdomain_aliases" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Information/operation/main_domain_builtin_subdomain_aliases" aria-label="tag/Domain-Information/operation/main_domain_builtin_subdomain_aliases"></a>Return built-in subdomain aliases </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the built-in subdomain aliases for an account&amp;#39;s main domain.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  This function retrieves data from the &lt;code&gt;/var/cpanel/userdata/user/domain&lt;/code&gt; file, where &lt;code&gt;user&lt;/code&gt; represents the cPanel account username and &lt;code&gt;domain&lt;/code&gt; represents the domain. For this reason, actual output may not contain all of the returns that this document lists.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the built-in subdomain aliases for an account&#39;s main domain.</p>
<p><strong>Note:</strong></p>
<p>  This function retrieves data from the <code>/var/cpanel/userdata/user/domain</code> file, where <code>user</code> represents the cPanel account username and <code>domain</code> represents the domain. For this reason, actual output may not contain all of the returns that this document lists.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DomainInfo/main_domain_builtin_subdomain_aliases</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DomainInfo/main_domain_builtin_subdomain_aliases</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kp55q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kp55q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kp55q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp55q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kp55q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp55q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kp55q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp55q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kp55q:0" aria-labelledby="tab:R4kp55q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DomainInfo <span class="token punctuation">\</span>
  main_domain_builtin_subdomain_aliases
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp55q:1" aria-labelledby="tab:R4kp55q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp55q:2" aria-labelledby="tab:R4kp55q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp55q:3" aria-labelledby="tab:R4kp55q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sp55q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sp55q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sp55q:0" aria-labelledby="tab:R4sp55q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;main_domain_builtin_subdomain_aliases&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DomainInfo&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;mail&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;www&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Domain-Redirection" data-section-id="tag/Domain-Redirection" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Redirection" aria-label="tag/Domain-Redirection"></a>Domain Redirection</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Domain Management / Domain Redirection&lt;/p&gt;
"><p>Domain Management / Domain Redirection</p>
</div></div></div><div id="tag/Domain-Redirection/operation/add_redirect" data-section-id="tag/Domain-Redirection/operation/add_redirect" class="sc-dntaoT ceciOs"><div data-section-id="operation/add_redirect" id="operation/add_redirect" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Redirection/operation/add_redirect" aria-label="tag/Domain-Redirection/operation/add_redirect"></a>Add redirect to domain </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function adds a redirect to a domain.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Web Server&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function adds a redirect to a domain.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>Web Server</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The domain from which to redirect.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain from which to redirect.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="redirect" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">redirect</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;url&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">redirect=http://example.com/</span></div><div><div html="&lt;p&gt;The URL to which to redirect.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The URL to which to redirect.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="redirect_wildcard" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">redirect_wildcard</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">redirect_wildcard=1</span></div><div><div html="&lt;p&gt;Whether to redirect all files within a directory to the same
filename within the destination directory.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Redirect all files within the directory.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Do &lt;strong&gt;not&lt;/strong&gt; redirect all files within the directory.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to redirect all files within a directory to the same
filename within the destination directory.</p>
<ul>
<li><code>1</code> - Redirect all files within the directory.</li>
<li><code>0</code> - Do <strong>not</strong> redirect all files within the directory.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="redirect_www" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">redirect_www</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">redirect_www=0</span></div><div><div html="&lt;p&gt;Whether to redirect domains with or without &lt;code&gt;www&lt;/code&gt;.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;2&lt;/code&gt; - Redirect with &lt;code&gt;www&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Redirect without &lt;code&gt;www&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Redirect with &lt;strong&gt;and&lt;/strong&gt; without &lt;code&gt;www&lt;/code&gt;.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to redirect domains with or without <code>www</code>.</p>
<ul>
<li><code>2</code> - Redirect with <code>www</code>.</li>
<li><code>1</code> - Redirect without <code>www</code>.</li>
<li><code>0</code> - Redirect with <strong>and</strong> without <code>www</code>.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="src" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">src</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;url-path&gt; </span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;/&quot;</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">src=/specific-page</span></div><div><div html="&lt;p&gt;A specific page from which to redirect.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A specific page from which to redirect.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="type" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">type</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;permanent&quot;</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;permanent&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;temp&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">type=permanent</span></div><div><div html="&lt;p&gt;Whether the redirect is temporary.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;permanent&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;temp&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the redirect is temporary.</p>
<ul>
<li><code>permanent</code></li>
<li><code>temp</code></li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mime/add_redirect</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mime/add_redirect</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kj75q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kj75q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kj75q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj75q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kj75q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj75q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kj75q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj75q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kj75q:0" aria-labelledby="tab:R4kj75q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mime <span class="token punctuation">\</span>
  add_redirect <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">redirect</span><span class="token operator">=</span><span class="token string">'http://example.com/'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj75q:1" aria-labelledby="tab:R4kj75q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj75q:2" aria-labelledby="tab:R4kj75q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj75q:3" aria-labelledby="tab:R4kj75q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sj75q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sj75q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sj75q:0" aria-labelledby="tab:R4sj75q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;add_redirect&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mime&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;Htaccess Installed&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Domain-Redirection/operation/delete_redirect" data-section-id="tag/Domain-Redirection/operation/delete_redirect" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete_redirect" id="operation/delete_redirect" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Redirection/operation/delete_redirect" aria-label="tag/Domain-Redirection/operation/delete_redirect"></a>Remove redirect from domain </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function removes a redirect from a domain.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles#roles&quot;&gt;Web Server role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes a redirect from a domain.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles#roles">Web Server role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="args" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">args</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;&quot;</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">args=redirectme http://redirectme.com/</span></div><div><div html="&lt;p&gt;An argument string that contains the arguments of a &lt;code&gt;Redirect&lt;/code&gt; or &lt;code&gt;RedirectMatch&lt;/code&gt; directives.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An argument string that contains the arguments of a <code>Redirect</code> or <code>RedirectMatch</code> directives.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="docroot" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">docroot</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">docroot=/home/example/public_html/</span></div><div><div html="&lt;p&gt;The absolute file path to the document root containing the &lt;code&gt;.htaccess&lt;/code&gt; file to change.&lt;/p&gt;
&lt;p&gt;If you don&amp;#39;t pass this parameter, the system looks up the document root from the &lt;code&gt;domain&lt;/code&gt; parameter&amp;#39;s value.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The absolute file path to the document root containing the <code>.htaccess</code> file to change.</p>
<p>If you don&#39;t pass this parameter, the system looks up the document root from the <code>domain</code> parameter&#39;s value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The domain name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="src" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">src</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;&quot;</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">src=redirectpage.html</span></div><div><div html="&lt;p&gt;The specific page that redirects visitors.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The specific page that redirects visitors.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mime/delete_redirect</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mime/delete_redirect</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kl75q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kl75q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kl75q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl75q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kl75q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl75q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kl75q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl75q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kl75q:0" aria-labelledby="tab:R4kl75q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mime <span class="token punctuation">\</span>
  delete_redirect <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl75q:1" aria-labelledby="tab:R4kl75q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl75q:2" aria-labelledby="tab:R4kl75q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl75q:3" aria-labelledby="tab:R4kl75q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sl75q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sl75q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sl75q:0" aria-labelledby="tab:R4sl75q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;delete_redirect&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mime&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Domain-Redirection/operation/get_redirect" data-section-id="tag/Domain-Redirection/operation/get_redirect" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_redirect" id="operation/get_redirect" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Redirection/operation/get_redirect" aria-label="tag/Domain-Redirection/operation/get_redirect"></a>Return redirect URL for domain </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves a redirection URL for a domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a redirection URL for a domain.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The domain&amp;#39;s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain&#39;s name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mime/get_redirect</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mime/get_redirect</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kn75q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kn75q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kn75q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn75q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kn75q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn75q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kn75q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn75q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kn75q:0" aria-labelledby="tab:R4kn75q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mime <span class="token punctuation">\</span>
  get_redirect <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn75q:1" aria-labelledby="tab:R4kn75q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn75q:2" aria-labelledby="tab:R4kn75q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn75q:3" aria-labelledby="tab:R4kn75q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sn75q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sn75q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sn75q:0" aria-labelledby="tab:R4sn75q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_redirect&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mime&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"redirection_enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">&quot;</span><a href="http://www.domain.com">http://www.domain.com</a><span class="token string">&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Domain-Redirection/operation/list_redirects" data-section-id="tag/Domain-Redirection/operation/list_redirects" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_redirects" id="operation/list_redirects" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Redirection/operation/list_redirects" aria-label="tag/Domain-Redirection/operation/list_redirects"></a>Return .htaccess files&#x27; redirects </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the redirects in an account&amp;#39;s .htaccess files.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles#roles&quot;&gt;Web Server role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the redirects in an account&#39;s .htaccess files.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles#roles">Web Server role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="destination" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">destination</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">destination=http://example.tld</span></div><div><div html="&lt;p&gt;The string with which to filter results.&lt;/p&gt;
&lt;p&gt;** Note: **&lt;/p&gt;
&lt;p&gt;This will &lt;strong&gt;only&lt;/strong&gt; return results that match the &lt;code&gt;destination&lt;/code&gt; parameter &lt;strong&gt;exactly&lt;/strong&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The string with which to filter results.</p>
<p>** Note: **</p>
<p>This will <strong>only</strong> return results that match the <code>destination</code> parameter <strong>exactly</strong>.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="regex" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">regex</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">regex=&quot;^[a-z0-9_-]{6,18}$&quot;</span></div><div><div html="&lt;p&gt;A Perl regular expression that filters the results. The system matches the regular expression to the &lt;code&gt;sourceurl&lt;/code&gt; return value.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A Perl regular expression that filters the results. The system matches the regular expression to the <code>sourceurl</code> return value.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mime/list_redirects</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mime/list_redirects</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kp75q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kp75q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kp75q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp75q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kp75q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp75q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kp75q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp75q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kp75q:0" aria-labelledby="tab:R4kp75q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mime <span class="token punctuation">\</span>
  list_redirects
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp75q:1" aria-labelledby="tab:R4kp75q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp75q:2" aria-labelledby="tab:R4kp75q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp75q:3" aria-labelledby="tab:R4kp75q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sp75q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sp75q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sp75q:0" aria-labelledby="tab:R4sp75q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_redirects&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mime&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"destination"</span>: <span class="token string">&quot;</span><a href="http://redirect.example.com/">http://redirect.example.com/</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"displaydomain"</span>: <span class="token string">&quot;ALL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"displaysourceurl"</span>: <span class="token string">&quot;/marceau.html&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"docroot"</span>: <span class="token string">&quot;/home/example/public_html&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"kind"</span>: <span class="token string">&quot;rewrite&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"matchwww"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"matchwww_text"</span>: <span class="token string">&quot;checked&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"opts"</span>: <span class="token string">&quot;L&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"source"</span>: <span class="token string">&quot;/marceau.html&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sourceurl"</span>: <span class="token string">&quot;/marceau.html&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"statuscode"</span>: <span class="token string">&quot;301&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"targeturl"</span>: <span class="token string">&quot;</span><a href="http://redirect.example.com/">http://redirect.example.com/</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;permanent&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"urldomain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"wildcard"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"wildcard_text"</span>: <span class="token string">&quot;checked&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/SubDomain" data-section-id="tag/SubDomain" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SubDomain" aria-label="tag/SubDomain"></a>SubDomain</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;The SubDomain module for UAPI.&lt;/p&gt;
"><p>The SubDomain module for UAPI.</p>
</div></div></div><div id="tag/SubDomain/operation/addsubdomain" data-section-id="tag/SubDomain/operation/addsubdomain" class="sc-dntaoT ceciOs"><div data-section-id="operation/addsubdomain" id="operation/addsubdomain" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SubDomain/operation/addsubdomain" aria-label="tag/SubDomain/operation/addsubdomain"></a>Create subdomain </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function creates a subdomain.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles#roles&quot;&gt;Web Server role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a subdomain.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles#roles">Web Server role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="canoff" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">canoff</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">canoff=1</span></div><div><div html="&lt;p&gt;Whether to use a canonical name (CNAME) in the &lt;a href=&quot;https://httpd.apache.org/docs/2.4/mod/core.html#usecanonicalname&quot;&gt;Apache® configuration for self-referential URLs&lt;/a&gt;.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Use the CNAME.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Do &lt;strong&gt;not&lt;/strong&gt; use the CNAME.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to use a canonical name (CNAME) in the <a href="https://httpd.apache.org/docs/2.4/mod/core.html#usecanonicalname">Apache® configuration for self-referential URLs</a>.</p>
<ul>
<li><code>1</code> - Use the CNAME.</li>
<li><code>0</code> - Do <strong>not</strong> use the CNAME.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="dir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">dir</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">dir=/public_html/directory_name</span></div><div><div html="&lt;p&gt;The subdomain&amp;#39;s document &lt;code&gt;root&lt;/code&gt; within the home directory, given as a valid directory path relative to the user&amp;#39;s home directory.&lt;/p&gt;
&lt;p&gt;This value defaults to the user&amp;#39;s home directory &lt;code&gt;/public_html/&lt;/code&gt; path.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If the &lt;em&gt;Restrict document roots to public_html&lt;/em&gt; value is set to &lt;em&gt;Off&lt;/em&gt; in WHM&amp;#39;s &lt;a href=&quot;https://go.cpanel.net/whmdocsTweakSettings#domains&quot;&gt;&lt;em&gt;Tweak Settings&lt;/em&gt;&lt;/a&gt; interface (&lt;em&gt;WHM &amp;gt;&amp;gt; Home &amp;gt;&amp;gt; Server Configuration &amp;gt;&amp;gt; Tweak Settings&lt;/em&gt;), this parameter defaults to the &lt;code&gt;/username/&lt;/code&gt; path. For example, the &lt;code&gt;username&lt;/code&gt; user&amp;#39;s subdomain &lt;code&gt;example&lt;/code&gt; would default to the &lt;code&gt;/home/username/example&lt;/code&gt; path.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The subdomain&#39;s document <code>root</code> within the home directory, given as a valid directory path relative to the user&#39;s home directory.</p>
<p>This value defaults to the user&#39;s home directory <code>/public_html/</code> path.</p>
<p><strong>Note:</strong></p>
<p>If the <em>Restrict document roots to public_html</em> value is set to <em>Off</em> in WHM&#39;s <a href="https://go.cpanel.net/whmdocsTweakSettings#domains"><em>Tweak Settings</em></a> interface (<em>WHM &gt;&gt; Home &gt;&gt; Server Configuration &gt;&gt; Tweak Settings</em>), this parameter defaults to the <code>/username/</code> path. For example, the <code>username</code> user&#39;s subdomain <code>example</code> would default to the <code>/home/username/example</code> path.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="disallowdot" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">disallowdot</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">disallowdot=1</span></div><div><div html="&lt;p&gt;Whether to remove the dot (&lt;code&gt;.&lt;/code&gt;) characters from the &lt;code&gt;domain&lt;/code&gt; value.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Remove dots from the domain.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Do &lt;strong&gt;not&lt;/strong&gt; remove dots from the domain.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to remove the dot (<code>.</code>) characters from the <code>domain</code> value.</p>
<ul>
<li><code>1</code> - Remove dots from the domain.</li>
<li><code>0</code> - Do <strong>not</strong> remove dots from the domain.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=subdomain</span></div><div><div html="&lt;p&gt;The subdomain name to create.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The subdomain name to create.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="rootdomain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">rootdomain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">rootdomain=example.com</span></div><div><div html="&lt;p&gt;The domain on which to create the new subdomain.  The domain &lt;strong&gt;must&lt;/strong&gt; already exist on the cPanel account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain on which to create the new subdomain.  The domain <strong>must</strong> already exist on the cPanel account.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SubDomain/addsubdomain</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SubDomain/addsubdomain</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R15795q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R15795q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R15795q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R15795q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R15795q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R15795q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R15795q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R15795q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R15795q:0" aria-labelledby="tab:R15795q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SubDomain <span class="token punctuation">\</span>
  addsubdomain <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'subdomain'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">rootdomain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R15795q:1" aria-labelledby="tab:R15795q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R15795q:2" aria-labelledby="tab:R15795q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R15795q:3" aria-labelledby="tab:R15795q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R17795q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R17795q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R17795q:0" aria-labelledby="tab:R17795q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;addsubdomain&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SubDomain&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Virtual-Host-Information" data-section-id="tag/Virtual-Host-Information" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Virtual-Host-Information" aria-label="tag/Virtual-Host-Information"></a>Virtual Host Information</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Domain Management / Virtual Host Information&lt;/p&gt;
"><p>Domain Management / Virtual Host Information</p>
</div></div></div><div id="tag/Virtual-Host-Information/operation/WebVhosts::list_domains" data-section-id="tag/Virtual-Host-Information/operation/WebVhosts::list_domains" class="sc-dntaoT ceciOs"><div data-section-id="operation/WebVhosts::list_domains" id="operation/WebVhosts::list_domains" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Virtual-Host-Information/operation/WebVhosts::list_domains" aria-label="tag/Virtual-Host-Information/operation/WebVhosts::list_domains"></a>Return virtual host names for domains </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists virtual host names for each domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists virtual host names for each domain.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/WebVhosts/list_domains</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/WebVhosts/list_domains</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2abb5q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abb5q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abb5q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abb5q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2abb5q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abb5q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2abb5q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abb5q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abb5q:0" aria-labelledby="tab:R2abb5q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  WebVhosts <span class="token punctuation">\</span>
  list_domains
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abb5q:1" aria-labelledby="tab:R2abb5q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abb5q:2" aria-labelledby="tab:R2abb5q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abb5q:3" aria-labelledby="tab:R2abb5q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ebb5q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebb5q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebb5q:0" aria-labelledby="tab:R2ebb5q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_domains&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;WebVhosts&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"proxy_subdomains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;cpanel&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;webmail&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;autodiscover&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;whm&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;webdisk&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vhost_is_ssl"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vhost_name"</span>: <span class="token string">&quot;hostname.example.com&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Virtual-Host-Information/operation/list_ssl_capable_domains" data-section-id="tag/Virtual-Host-Information/operation/list_ssl_capable_domains" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_ssl_capable_domains" id="operation/list_ssl_capable_domains" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Virtual-Host-Information/operation/list_ssl_capable_domains" aria-label="tag/Virtual-Host-Information/operation/list_ssl_capable_domains"></a>Return domains that allow SSL certificate purchase </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists every domain for which you may purchase an SSL certificate. The possible domains for the Secure Sockets Layer (SSL) certificate include applicable &lt;a href=&quot;https://go.cpanel.net/ServiceProxySubdomains&quot;&gt;service subdomains.&lt;/a&gt;&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists every domain for which you may purchase an SSL certificate. The possible domains for the Secure Sockets Layer (SSL) certificate include applicable <a href="https://go.cpanel.net/ServiceProxySubdomains">service subdomains.</a></p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/WebVhosts/list_ssl_capable_domains</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/WebVhosts/list_ssl_capable_domains</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2adb5q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2adb5q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2adb5q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adb5q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2adb5q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adb5q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2adb5q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adb5q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2adb5q:0" aria-labelledby="tab:R2adb5q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  WebVhosts <span class="token punctuation">\</span>
  list_ssl_capable_domains
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adb5q:1" aria-labelledby="tab:R2adb5q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adb5q:2" aria-labelledby="tab:R2adb5q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adb5q:3" aria-labelledby="tab:R2adb5q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2edb5q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2edb5q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2edb5q:0" aria-labelledby="tab:R2edb5q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_ssl_capable_domains&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;WebVhosts&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_proxy"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vhost_name"</span>: <span class="token string">&quot;hostname.example.com&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts" data-section-id="tag/Email-Accounts" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts" aria-label="tag/Email-Accounts"></a>Email Accounts</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Email / Email Accounts&lt;/p&gt;
"><p>Email / Email Accounts</p>
</div></div></div><div id="tag/Email-Accounts/operation/account_name" data-section-id="tag/Email-Accounts/operation/account_name" class="sc-dntaoT ceciOs"><div data-section-id="operation/account_name" id="operation/account_name" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/account_name" aria-label="tag/Email-Accounts/operation/account_name"></a>Return current user&#x27;s account name </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the provided value. This function works with other functions to display form data within a user interface.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  If you call this function from a Webmail session URL, the system will &lt;strong&gt;only&lt;/strong&gt; access data for that email account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the provided value. This function works with other functions to display form data within a user interface.</p>
<p><strong>Note:</strong></p>
<p>  If you call this function from a Webmail session URL, the system will <strong>only</strong> access data for that email account.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="account" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">account</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">account=user</span></div><div><div html="&lt;p&gt;The function will return this value in the data return. If you do &lt;strong&gt;not&lt;/strong&gt; include this parameter, the function returns &lt;code&gt;All Mail On The Account&lt;/code&gt; or a blank value.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;A valid string.&lt;/li&gt;
&lt;li&gt;An empty value.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; The function does &lt;strong&gt;not&lt;/strong&gt; validate this parameter&amp;#39;s value.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The function will return this value in the data return. If you do <strong>not</strong> include this parameter, the function returns <code>All Mail On The Account</code> or a blank value.</p>
<ul>
<li>A valid string.</li>
<li>An empty value.</li>
</ul>
<p><strong>Note:</strong></p>
<p> The function does <strong>not</strong> validate this parameter&#39;s value.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="display" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">display</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">display=any_value</span></div><div><div html="&lt;p&gt;Include this parameter to cause the function to return &lt;code&gt;All Mail On The Account&lt;/code&gt; if the account parameter is blank or does not exist. If you do &lt;strong&gt;not&lt;/strong&gt; include this parameter and the account value is blank or does not exist, the function returns a blank data value.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Include this parameter to cause the function to return <code>All Mail On The Account</code> if the account parameter is blank or does not exist. If you do <strong>not</strong> include this parameter and the account value is blank or does not exist, the function returns a blank data value.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/account_name</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/account_name</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a8636a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a8636a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a8636a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a8636a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2a8636a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a8636a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2a8636a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a8636a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a8636a:0" aria-labelledby="tab:R2a8636a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  account_name
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a8636a:1" aria-labelledby="tab:R2a8636a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a8636a:2" aria-labelledby="tab:R2a8636a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a8636a:3" aria-labelledby="tab:R2a8636a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2e8636a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e8636a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e8636a:0" aria-labelledby="tab:R2e8636a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;account_name&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/browse_mailbox" data-section-id="tag/Email-Accounts/operation/browse_mailbox" class="sc-dntaoT ceciOs"><div data-section-id="operation/browse_mailbox" id="operation/browse_mailbox" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/browse_mailbox" aria-label="tag/Email-Accounts/operation/browse_mailbox"></a>Return mail directory&#x27;s subdirectories and files </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the mail directory&amp;#39;s subdirectories (boxes) and files.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles#roles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Notes:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  If you do not use any input parameters, the function returns a list of items in the cPanel account&amp;#39;s main mail directory.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the mail directory&#39;s subdirectories (boxes) and files.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles#roles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
<p><strong>Notes:</strong></p>
<p>  If you do not use any input parameters, the function returns a list of items in the cPanel account&#39;s main mail directory.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="account" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">account</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">account=user@example.com</span></div><div><div html="&lt;p&gt;An email address, to limit the function&amp;#39;s results.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An email address, to limit the function&#39;s results.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="dir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">dir</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">dir=maildir</span></div><div><div html="&lt;p&gt;A mail directory name, to limit results to specific directories.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  If you pass the &lt;code&gt;default&lt;/code&gt; or &lt;code&gt;mail&lt;/code&gt; values, the function lists information for all mail directories.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A mail directory name, to limit results to specific directories.</p>
<p><strong>Note:</strong></p>
<p>  If you pass the <code>default</code> or <code>mail</code> values, the function lists information for all mail directories.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="showdotfiles" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">showdotfiles</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">showdotfiles=0</span></div><div><div html="&lt;p&gt;Whether to include hidden files and directories.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Include hidden items.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Do &lt;strong&gt;not&lt;/strong&gt; include hidden items.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to include hidden files and directories.</p>
<ul>
<li><code>1</code> — Include hidden items.</li>
<li><code>0</code> — Do <strong>not</strong> include hidden items.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/browse_mailbox</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/browse_mailbox</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a8a36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a8a36a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a8a36a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a8a36a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2a8a36a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a8a36a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2a8a36a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a8a36a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a8a36a:0" aria-labelledby="tab:R2a8a36a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  browse_mailbox
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a8a36a:1" aria-labelledby="tab:R2a8a36a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a8a36a:2" aria-labelledby="tab:R2a8a36a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a8a36a:3" aria-labelledby="tab:R2a8a36a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2e8a36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e8a36a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e8a36a:0" aria-labelledby="tab:R2e8a36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;browse_mailbox&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"depth"</span>: <span class="token number">2</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file"</span>: <span class="token string">&quot;archive&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"fullpath"</span>: <span class="token string">&quot;/home/example/mail/archive&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"isleaf"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ismailbox"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mtime"</span>: <span class="token number">1413398866</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/home/example/mail&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"relpath"</span>: <span class="token string">&quot;/archive&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;dir&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/add_pop" data-section-id="tag/Email-Accounts/operation/add_pop" class="sc-dntaoT ceciOs"><div data-section-id="operation/add_pop" id="operation/add_pop" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/add_pop" aria-label="tag/Email-Accounts/operation/add_pop"></a>Create email address </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function creates an email address.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/li&gt;
&lt;li&gt;We recommend that you use the UAPI &lt;code&gt;UserManager::create_user&lt;/code&gt; function to create an email address instead of this function. This function is incompatible with &lt;a href=&quot;https://go.cpanel.net/resetpassdocs&quot;&gt;the &lt;em&gt;Reset Password&lt;/em&gt; feature&lt;/a&gt;.&lt;/li&gt;
&lt;li&gt;You &lt;strong&gt;must&lt;/strong&gt; URI-encode values when using the CLI.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates an email address.</p>
<p><strong>Important:</strong></p>
<ul>
<li>When you disable the <a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</li>
<li>We recommend that you use the UAPI <code>UserManager::create_user</code> function to create an email address instead of this function. This function is incompatible with <a href="https://go.cpanel.net/resetpassdocs">the <em>Reset Password</em> feature</a>.</li>
<li>You <strong>must</strong> URI-encode values when using the CLI.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;The cPanel account&#x27;s main domain.&quot;</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The email account&amp;#39;s domain. For example, &lt;code&gt;example.com&lt;/code&gt; to create &lt;code&gt;user@example.com&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account&#39;s domain. For example, <code>example.com</code> to create <code>user@example.com</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="email" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand email"><span class="property-name">email</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user</span></div><div><div html="&lt;p&gt;The email account username or address.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;A valid email account username. For example, &lt;code&gt;user&lt;/code&gt; to create &lt;code&gt;user@example.com&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;A valid email address.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  You &lt;strong&gt;cannot&lt;/strong&gt; enter &lt;code&gt;cpanel&lt;/code&gt; as an account name when you create an email account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account username or address.</p>
<ul>
<li>A valid email account username. For example, <code>user</code> to create <code>user@example.com</code>.</li>
<li>A valid email address.</li>
</ul>
<p><strong>Note:</strong></p>
<p>  You <strong>cannot</strong> enter <code>cpanel</code> as an account name when you create an email account.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="password" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">password</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">password=123456luggage</span></div><div><div html="&lt;p&gt;The email account password.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account password.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="password_hash" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">password_hash</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">password_hash=$6$1sOyHP5ZDYp3pGUz$R0TSgfPRHfDjT5PP5RJGv39FhiGTNNPvM7IFpCBjXijMmlMZk9yI8T3LqGuntc9fdKb5eX.lGL7wBS9e4DAWn/</span></div><div><div html="&lt;p&gt;The account&amp;#39;s password hash.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Notes:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;You can use this parameter instead of the &lt;code&gt;password&lt;/code&gt; parameter. However, you cannot use both &lt;code&gt;password&lt;/code&gt; and &lt;code&gt;password_hash&lt;/code&gt; parameters in the same request.&lt;/li&gt;
&lt;li&gt;You can find your server&amp;#39;s hash type in the &lt;code&gt;/etc/sysconfig/authconfig&lt;/code&gt; file.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account&#39;s password hash.</p>
<p><strong>Notes:</strong></p>
<ul>
<li>You can use this parameter instead of the <code>password</code> parameter. However, you cannot use both <code>password</code> and <code>password_hash</code> parameters in the same request.</li>
<li>You can find your server&#39;s hash type in the <code>/etc/sysconfig/authconfig</code> file.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="quota" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand quota"><span class="property-name">quota</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;The defined system value.&quot;</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">quota=500</span></div><div><div html="&lt;p&gt;The maximum amount of disk space that the new email account may use.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;A positive integer that represents the maximum amount of disk space, in megabytes (MB).&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; or &lt;code&gt;unlimited&lt;/code&gt; — The account possesses unlimited disk space.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;The positive integer value &lt;strong&gt;cannot&lt;/strong&gt; exceed the maximum email quota.&lt;/li&gt;
&lt;li&gt;The &lt;code&gt;0&lt;/code&gt; or &lt;code&gt;unlimited&lt;/code&gt; value is &lt;strong&gt;only&lt;/strong&gt; available to users &lt;strong&gt;without&lt;/strong&gt; a maximum email account quota.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum amount of disk space that the new email account may use.</p>
<ul>
<li>A positive integer that represents the maximum amount of disk space, in megabytes (MB).</li>
<li><code>0</code> or <code>unlimited</code> — The account possesses unlimited disk space.</li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li>The positive integer value <strong>cannot</strong> exceed the maximum email quota.</li>
<li>The <code>0</code> or <code>unlimited</code> value is <strong>only</strong> available to users <strong>without</strong> a maximum email account quota.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="send_welcome_email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">send_welcome_email</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">send_welcome_email=0</span></div><div><div html="&lt;p&gt;Whether to send client configuration instructions to the account.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Send the instructions.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Do &lt;strong&gt;not&lt;/strong&gt; send the instructions.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to send client configuration instructions to the account.</p>
<ul>
<li><code>1</code> — Send the instructions.</li>
<li><code>0</code> — Do <strong>not</strong> send the instructions.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="skip_update_db" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">skip_update_db</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">skip_update_db=1</span></div><div><div html="&lt;p&gt;Whether to skip the update of the email accounts database&amp;#39;s cache.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Skip the update.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Perform the update.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to skip the update of the email accounts database&#39;s cache.</p>
<ul>
<li><code>1</code> — Skip the update.</li>
<li><code>0</code> — Perform the update.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/add_pop</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/add_pop</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a8e36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a8e36a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a8e36a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a8e36a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2a8e36a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a8e36a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2a8e36a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a8e36a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a8e36a:0" aria-labelledby="tab:R2a8e36a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  add_pop <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'user'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">password</span><span class="token operator">=</span><span class="token string">'123456luggage'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a8e36a:1" aria-labelledby="tab:R2a8e36a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a8e36a:2" aria-labelledby="tab:R2a8e36a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a8e36a:3" aria-labelledby="tab:R2a8e36a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2e8e36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e8e36a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e8e36a:0" aria-labelledby="tab:R2e8e36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;add_pop&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token string">&quot;user+example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/count_auto_responders" data-section-id="tag/Email-Accounts/operation/count_auto_responders" class="sc-dntaoT ceciOs"><div data-section-id="operation/count_auto_responders" id="operation/count_auto_responders" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/count_auto_responders" aria-label="tag/Email-Accounts/operation/count_auto_responders"></a>Return cPanel account&#x27;s autoresponders total </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the number of &lt;a href=&quot;https://go.cpanel.net/Autoresponders&quot;&gt;autoresponders&lt;/a&gt; for every email address on a cPanel account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles#roles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the number of <a href="https://go.cpanel.net/Autoresponders">autoresponders</a> for every email address on a cPanel account.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles#roles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/count_auto_responders</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/count_auto_responders</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a8i36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a8i36a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a8i36a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a8i36a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2a8i36a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a8i36a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2a8i36a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a8i36a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a8i36a:0" aria-labelledby="tab:R2a8i36a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  count_auto_responders
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a8i36a:1" aria-labelledby="tab:R2a8i36a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a8i36a:2" aria-labelledby="tab:R2a8i36a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a8i36a:3" aria-labelledby="tab:R2a8i36a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2e8i36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e8i36a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e8i36a:0" aria-labelledby="tab:R2e8i36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;count_auto_responders&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/count_pops" data-section-id="tag/Email-Accounts/operation/count_pops" class="sc-dntaoT ceciOs"><div data-section-id="operation/count_pops" id="operation/count_pops" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/count_pops" aria-label="tag/Email-Accounts/operation/count_pops"></a>Return cPanel account&#x27;s email account total </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the number of &lt;a href=&quot;https://go.cpanel.net/cpaneldocsEmailAccounts&quot;&gt;email accounts&lt;/a&gt; for a cPanel account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles#roles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the number of <a href="https://go.cpanel.net/cpaneldocsEmailAccounts">email accounts</a> for a cPanel account.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles#roles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/count_pops</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/count_pops</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a8m36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a8m36a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a8m36a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a8m36a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2a8m36a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a8m36a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2a8m36a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a8m36a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a8m36a:0" aria-labelledby="tab:R2a8m36a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  count_pops
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a8m36a:1" aria-labelledby="tab:R2a8m36a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a8m36a:2" aria-labelledby="tab:R2a8m36a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a8m36a:3" aria-labelledby="tab:R2a8m36a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2e8m36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e8m36a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e8m36a:0" aria-labelledby="tab:R2e8m36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;count_pops&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/delete_held_messages" data-section-id="tag/Email-Accounts/operation/delete_held_messages" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete_held_messages" id="operation/delete_held_messages" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/delete_held_messages" aria-label="tag/Email-Accounts/operation/delete_held_messages"></a>Delete email account&#x27;s outgoing messages </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function deletes all outbound email messages held in the mail queue for the specified email account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes all outbound email messages held in the mail queue for the specified email account.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=username@example.com</span></div><div><div html="&lt;p&gt;The email address to query.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email address to query.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/delete_held_messages</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/delete_held_messages</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a8q36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a8q36a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a8q36a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a8q36a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2a8q36a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a8q36a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2a8q36a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a8q36a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a8q36a:0" aria-labelledby="tab:R2a8q36a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  delete_held_messages <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'username@example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a8q36a:1" aria-labelledby="tab:R2a8q36a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a8q36a:2" aria-labelledby="tab:R2a8q36a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a8q36a:3" aria-labelledby="tab:R2a8q36a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2e8q36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e8q36a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e8q36a:0" aria-labelledby="tab:R2e8q36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;delete_held_messages&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/edit_pop_quota" data-section-id="tag/Email-Accounts/operation/edit_pop_quota" class="sc-dntaoT ceciOs"><div data-section-id="operation/edit_pop_quota" id="operation/edit_pop_quota" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/edit_pop_quota" aria-label="tag/Email-Accounts/operation/edit_pop_quota"></a>Update email account&#x27;s quota </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function changes an email address&amp;#39;s quota.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function changes an email address&#39;s quota.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The email account&amp;#39;s domain. Defaults to the cPanel account&amp;#39;s main domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account&#39;s domain. Defaults to the cPanel account&#39;s main domain.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user</span></div><div><div html="&lt;p&gt;The email account username.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account username.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="quota" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">quota</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">quota=500</span></div><div><div html="&lt;p&gt;The maximum amount of disk space that the new email account may use. Defaults to the system value.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;A positive integer that represents the maximum amount of disk space, in megabytes (MB).&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You &lt;strong&gt;cannot&lt;/strong&gt; enter a value that exceeds the maximum email quota.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; or &lt;code&gt;unlimited&lt;/code&gt; — The account possesses unlimited disk space.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;If the email account&amp;#39;s quota value is set higher (or unlimited) than
the account&amp;#39;s max quota, the account&amp;#39;s max quota will be applied instead
of the value entered.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This value is only available to users without a maximum email account quota.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum amount of disk space that the new email account may use. Defaults to the system value.</p>
<ul>
<li>A positive integer that represents the maximum amount of disk space, in megabytes (MB).</li>
</ul>
<p><strong>Note:</strong></p>
<p>You <strong>cannot</strong> enter a value that exceeds the maximum email quota.</p>
<ul>
<li><code>0</code> or <code>unlimited</code> — The account possesses unlimited disk space.</li>
</ul>
<p>If the email account&#39;s quota value is set higher (or unlimited) than
the account&#39;s max quota, the account&#39;s max quota will be applied instead
of the value entered.</p>
<p><strong>Note:</strong></p>
<p>This value is only available to users without a maximum email account quota.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/edit_pop_quota</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/edit_pop_quota</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a8u36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a8u36a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a8u36a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a8u36a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2a8u36a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a8u36a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2a8u36a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a8u36a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a8u36a:0" aria-labelledby="tab:R2a8u36a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  edit_pop_quota <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'user'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a8u36a:1" aria-labelledby="tab:R2a8u36a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a8u36a:2" aria-labelledby="tab:R2a8u36a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a8u36a:3" aria-labelledby="tab:R2a8u36a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2e8u36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e8u36a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e8u36a:0" aria-labelledby="tab:R2e8u36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;edit_pop_quota&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/dispatch_client_settings" data-section-id="tag/Email-Accounts/operation/dispatch_client_settings" class="sc-dntaoT ceciOs"><div data-section-id="operation/dispatch_client_settings" id="operation/dispatch_client_settings" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/dispatch_client_settings" aria-label="tag/Email-Accounts/operation/dispatch_client_settings"></a>Send email client settings to an email address </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function sends an email account&amp;#39;s client settings to an email address.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sends an email account&#39;s client settings to an email address.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="account" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand account"><span class="property-name">account</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">account=username</span></div><div><div html="&lt;p&gt;The email account username or address for which to send client settings.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account username or address for which to send client settings.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="to" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">to</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">to=user@example.com</span></div><div><div html="&lt;p&gt;The email address to send client settings.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email address to send client settings.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/dispatch_client_settings</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/dispatch_client_settings</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a9236a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9236a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9236a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9236a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2a9236a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9236a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2a9236a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9236a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9236a:0" aria-labelledby="tab:R2a9236a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  dispatch_client_settings <span class="token punctuation">\</span>
  <span class="token assign-left variable">to</span><span class="token operator">=</span><span class="token string">'user@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">account</span><span class="token operator">=</span><span class="token string">'username'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9236a:1" aria-labelledby="tab:R2a9236a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9236a:2" aria-labelledby="tab:R2a9236a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9236a:3" aria-labelledby="tab:R2a9236a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2e9236a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9236a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9236a:0" aria-labelledby="tab:R2e9236a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;dispatch_client_settings&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/hold_outgoing" data-section-id="tag/Email-Accounts/operation/hold_outgoing" class="sc-dntaoT ceciOs"><div data-section-id="operation/hold_outgoing" id="operation/hold_outgoing" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/hold_outgoing" aria-label="tag/Email-Accounts/operation/hold_outgoing"></a>Stop email account&#x27;s outgoing mail </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function sets Exim&amp;#39;s queue to not send outgoing mail from an email account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Notes:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;To send all mail from the queue, use the UAPI &lt;code&gt;Email::release_outgoing&lt;/code&gt; function.&lt;/li&gt;
&lt;li&gt;To reject outgoing mail and not place mail in a queue, use the UAPI &lt;code&gt;Email::suspend_outgoing&lt;/code&gt; function.&lt;/li&gt;
&lt;li&gt;This function does &lt;strong&gt;not&lt;/strong&gt; hold local outgoing mail.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets Exim&#39;s queue to not send outgoing mail from an email account.</p>
<p><strong>Notes:</strong></p>
<ul>
<li>To send all mail from the queue, use the UAPI <code>Email::release_outgoing</code> function.</li>
<li>To reject outgoing mail and not place mail in a queue, use the UAPI <code>Email::suspend_outgoing</code> function.</li>
<li>This function does <strong>not</strong> hold local outgoing mail.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=username@example.com</span></div><div><div html="&lt;p&gt;The email account&amp;#39;s username.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account&#39;s username.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/hold_outgoing</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/hold_outgoing</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a9636a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9636a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9636a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9636a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2a9636a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9636a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2a9636a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9636a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9636a:0" aria-labelledby="tab:R2a9636a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  hold_outgoing <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'username@example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9636a:1" aria-labelledby="tab:R2a9636a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9636a:2" aria-labelledby="tab:R2a9636a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9636a:3" aria-labelledby="tab:R2a9636a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2e9636a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9636a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9636a:0" aria-labelledby="tab:R2e9636a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;hold_outgoing&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/get_auto_responder" data-section-id="tag/Email-Accounts/operation/get_auto_responder" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_auto_responder" id="operation/get_auto_responder" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/get_auto_responder" aria-label="tag/Email-Accounts/operation/get_auto_responder"></a>Return email account&#x27;s autoresponder information </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves autoresponder information.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves autoresponder information.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;username&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user</span></div><div><div html="&lt;p&gt;The email account name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="temp_charset" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">temp_charset</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;utf-8&quot;</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">temp_charset=utf-8</span></div><div><div html="&lt;p&gt;The autoresponder&amp;#39;s &lt;a href=&quot;https://en.wikipedia.org/wiki/Character_encoding&quot;&gt;character set&lt;/a&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The autoresponder&#39;s <a href="https://en.wikipedia.org/wiki/Character_encoding">character set</a>.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/get_auto_responder</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/get_auto_responder</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a9a36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9a36a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9a36a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9a36a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2a9a36a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9a36a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2a9a36a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9a36a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9a36a:0" aria-labelledby="tab:R2a9a36a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  get_auto_responder <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'user'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9a36a:1" aria-labelledby="tab:R2a9a36a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9a36a:2" aria-labelledby="tab:R2a9a36a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9a36a:3" aria-labelledby="tab:R2a9a36a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2e9a36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9a36a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9a36a:0" aria-labelledby="tab:R2e9a36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_auto_responder&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"body"</span>: <span class="token string">&quot;This is an autoresponder message.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"charset"</span>: <span class="token string">&quot;UTF-8&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"from"</span>: <span class="token string">&quot;User Name&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"interval"</span>: <span class="token number">24</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_html"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"start"</span>: <span class="token number">1410277881</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"stop"</span>: <span class="token number">1410300000</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject"</span>: <span class="token string">&quot;Autoresponder Subject&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/get_client_settings" data-section-id="tag/Email-Accounts/operation/get_client_settings" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_client_settings" id="operation/get_client_settings" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/get_client_settings" aria-label="tag/Email-Accounts/operation/get_client_settings"></a>Return email account&#x27;s client settings </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves an email account&amp;#39;s client settings.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves an email account&#39;s client settings.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="account" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">account</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">account=username@example.com</span></div><div><div html="&lt;p&gt;The email address for which to send client settings.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This parameter defaults to the &lt;a href=&quot;https://go.cpanel.net/systemdefaultemailaccount&quot;&gt;system default email account&lt;/a&gt;. &lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email address for which to send client settings.</p>
<p><strong>Note:</strong></p>
<p>This parameter defaults to the <a href="https://go.cpanel.net/systemdefaultemailaccount">system default email account</a>. </p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/get_client_settings</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/get_client_settings</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a9e36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9e36a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9e36a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9e36a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2a9e36a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9e36a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2a9e36a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9e36a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9e36a:0" aria-labelledby="tab:R2a9e36a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  get_client_settings
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9e36a:1" aria-labelledby="tab:R2a9e36a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9e36a:2" aria-labelledby="tab:R2a9e36a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9e36a:3" aria-labelledby="tab:R2a9e36a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2e9e36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9e36a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9e36a:0" aria-labelledby="tab:R2e9e36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_client_settings&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"account"</span>: <span class="token string">&quot;username@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"activesync_available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"activesync_host"</span>: <span class="token string">&quot;mail.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"activesync_port"</span>: <span class="token number">2091</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"activesync_username"</span>: <span class="token string">&quot;username@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display"</span>: <span class="token string">&quot;username@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;domain.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"from_archiving"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_plaintext_authentication"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"inbox_host"</span>: <span class="token string">&quot;mail.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"inbox_insecure_port"</span>: <span class="token number">143</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"inbox_port"</span>: <span class="token number">993</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"inbox_service"</span>: <span class="token string">&quot;imap&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"inbox_username"</span>: <span class="token string">&quot;username@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mail_domain"</span>: <span class="token string">&quot;mail.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"smtp_host"</span>: <span class="token string">&quot;mail.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"smtp_insecure_port"</span>: <span class="token number">25</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"smtp_port"</span>: <span class="token number">465</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"smtp_username"</span>: <span class="token string">&quot;username@example.com&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/get_default_email_quota" data-section-id="tag/Email-Accounts/operation/get_default_email_quota" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_default_email_quota" id="operation/get_default_email_quota" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/get_default_email_quota" aria-label="tag/Email-Accounts/operation/get_default_email_quota"></a>Return email account&#x27;s default email quota </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves the account&amp;#39;s default email quota size, in bytes format.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail&lt;/a&gt; role, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the account&#39;s default email quota size, in bytes format.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail</a> role, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/get_default_email_quota</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/get_default_email_quota</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a9i36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9i36a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9i36a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9i36a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2a9i36a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9i36a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2a9i36a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9i36a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9i36a:0" aria-labelledby="tab:R2a9i36a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  get_default_email_quota
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9i36a:1" aria-labelledby="tab:R2a9i36a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9i36a:2" aria-labelledby="tab:R2a9i36a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9i36a:3" aria-labelledby="tab:R2a9i36a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2e9i36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9i36a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9i36a:0" aria-labelledby="tab:R2e9i36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_default_email_quota&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">34359738368</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/get_disk_usage" data-section-id="tag/Email-Accounts/operation/get_disk_usage" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_disk_usage" id="operation/get_disk_usage" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/get_disk_usage" aria-label="tag/Email-Accounts/operation/get_disk_usage"></a>Return email account&#x27;s disk usage </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves the disk space that an email account uses.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the disk space that an email account uses.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The email account&amp;#39;s domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account&#39;s domain.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;username&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=user</span></div><div><div html="&lt;p&gt;The email account username.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account username.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/get_disk_usage</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/get_disk_usage</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a9m36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9m36a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9m36a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9m36a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2a9m36a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9m36a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2a9m36a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9m36a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9m36a:0" aria-labelledby="tab:R2a9m36a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  get_disk_usage <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'user'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9m36a:1" aria-labelledby="tab:R2a9m36a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9m36a:2" aria-labelledby="tab:R2a9m36a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9m36a:3" aria-labelledby="tab:R2a9m36a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2e9m36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9m36a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9m36a:0" aria-labelledby="tab:R2e9m36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_disk_usage&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"diskused"</span>: <span class="token number">399.6</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"login"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">&quot;user&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/get_default_email_quota_mib" data-section-id="tag/Email-Accounts/operation/get_default_email_quota_mib" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_default_email_quota_mib" id="operation/get_default_email_quota_mib" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/get_default_email_quota_mib" aria-label="tag/Email-Accounts/operation/get_default_email_quota_mib"></a>Return email account&#x27;s default email quota in MiB </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves the account&amp;#39;s default email quota size in &lt;a href=&quot;https://en.wikipedia.org/wiki/Mebibyte&quot;&gt;mebibytes&lt;/a&gt; (MiB).&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail&lt;/a&gt; role, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the account&#39;s default email quota size in <a href="https://en.wikipedia.org/wiki/Mebibyte">mebibytes</a> (MiB).</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail</a> role, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/get_default_email_quota_mib</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/get_default_email_quota_mib</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a9q36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9q36a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9q36a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9q36a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2a9q36a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9q36a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2a9q36a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9q36a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9q36a:0" aria-labelledby="tab:R2a9q36a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  get_default_email_quota_mib
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9q36a:1" aria-labelledby="tab:R2a9q36a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9q36a:2" aria-labelledby="tab:R2a9q36a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9q36a:3" aria-labelledby="tab:R2a9q36a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2e9q36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9q36a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9q36a:0" aria-labelledby="tab:R2e9q36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_default_email_quota_mib&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">32768</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/get_main_account_disk_usage" data-section-id="tag/Email-Accounts/operation/get_main_account_disk_usage" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_main_account_disk_usage" id="operation/get_main_account_disk_usage" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/get_main_account_disk_usage" aria-label="tag/Email-Accounts/operation/get_main_account_disk_usage"></a>Return primary email account&#x27;s disk usage </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the disk space that the main account uses.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the disk space that the main account uses.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/get_main_account_disk_usage</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/get_main_account_disk_usage</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a9u36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9u36a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9u36a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9u36a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2a9u36a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9u36a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2a9u36a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9u36a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9u36a:0" aria-labelledby="tab:R2a9u36a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  get_main_account_disk_usage
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9u36a:1" aria-labelledby="tab:R2a9u36a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9u36a:2" aria-labelledby="tab:R2a9u36a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9u36a:3" aria-labelledby="tab:R2a9u36a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2e9u36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9u36a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9u36a:0" aria-labelledby="tab:R2e9u36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_main_account_disk_usage&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token string">&quot;3076 bytes&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/get_held_message_count" data-section-id="tag/Email-Accounts/operation/get_held_message_count" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_held_message_count" id="operation/get_held_message_count" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/get_held_message_count" aria-label="tag/Email-Accounts/operation/get_held_message_count"></a>Return email account&#x27;s outgoing message count </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the count of outbound email messages held in the mail queue for the specified email account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the count of outbound email messages held in the mail queue for the specified email account.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=username@example.com</span></div><div><div html="&lt;p&gt;The email address to query.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email address to query.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/get_held_message_count</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/get_held_message_count</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aa236a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aa236a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aa236a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aa236a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2aa236a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aa236a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2aa236a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aa236a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aa236a:0" aria-labelledby="tab:R2aa236a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  get_held_message_count
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aa236a:1" aria-labelledby="tab:R2aa236a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aa236a:2" aria-labelledby="tab:R2aa236a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aa236a:3" aria-labelledby="tab:R2aa236a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ea236a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ea236a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ea236a:0" aria-labelledby="tab:R2ea236a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_held_message_count&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/get_main_account_disk_usage_bytes" data-section-id="tag/Email-Accounts/operation/get_main_account_disk_usage_bytes" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_main_account_disk_usage_bytes" id="operation/get_main_account_disk_usage_bytes" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/get_main_account_disk_usage_bytes" aria-label="tag/Email-Accounts/operation/get_main_account_disk_usage_bytes"></a>Return primary email account&#x27;s disk usage in bytes </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the disk space that the cPanel account uses.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail&lt;/a&gt; role, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the disk space that the cPanel account uses.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail</a> role, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/get_main_account_disk_usage_bytes</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/get_main_account_disk_usage_bytes</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aa636a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aa636a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aa636a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aa636a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2aa636a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aa636a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2aa636a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aa636a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aa636a:0" aria-labelledby="tab:R2aa636a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  get_main_account_disk_usage_bytes
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aa636a:1" aria-labelledby="tab:R2aa636a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aa636a:2" aria-labelledby="tab:R2aa636a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aa636a:3" aria-labelledby="tab:R2aa636a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ea636a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ea636a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ea636a:0" aria-labelledby="tab:R2ea636a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_main_account_disk_usage_bytes&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">3076</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/get_max_email_quota" data-section-id="tag/Email-Accounts/operation/get_max_email_quota" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_max_email_quota" id="operation/get_max_email_quota" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/get_max_email_quota" aria-label="tag/Email-Accounts/operation/get_max_email_quota"></a>Return email account&#x27;s max quota size </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves the account&amp;#39;s maximum email quota size, in bytes format.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail&lt;/a&gt; role, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the account&#39;s maximum email quota size, in bytes format.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail</a> role, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/get_max_email_quota</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/get_max_email_quota</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aaa36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aaa36a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aaa36a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aaa36a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2aaa36a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aaa36a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2aaa36a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aaa36a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aaa36a:0" aria-labelledby="tab:R2aaa36a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  get_max_email_quota
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aaa36a:1" aria-labelledby="tab:R2aaa36a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aaa36a:2" aria-labelledby="tab:R2aaa36a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aaa36a:3" aria-labelledby="tab:R2aaa36a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eaa36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eaa36a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eaa36a:0" aria-labelledby="tab:R2eaa36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_max_email_quota&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">4503599627370496</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/get_max_email_quota_mib" data-section-id="tag/Email-Accounts/operation/get_max_email_quota_mib" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_max_email_quota_mib" id="operation/get_max_email_quota_mib" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/get_max_email_quota_mib" aria-label="tag/Email-Accounts/operation/get_max_email_quota_mib"></a>Return email account&#x27;s max quota size in MiB </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves the account&amp;#39;s maximum email account quota size, in
&lt;a href=&quot;https://en.wikipedia.org/wiki/Mebibyte&quot;&gt;Mebibytes (MiB)&lt;/a&gt; format.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;Receive Mail role&lt;/a&gt;,
the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the account&#39;s maximum email account quota size, in
<a href="https://en.wikipedia.org/wiki/Mebibyte">Mebibytes (MiB)</a> format.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles">Receive Mail role</a>,
the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/get_max_email_quota_mib</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/get_max_email_quota_mib</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aae36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aae36a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aae36a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aae36a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2aae36a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aae36a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2aae36a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aae36a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aae36a:0" aria-labelledby="tab:R2aae36a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  get_max_email_quota_mib
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aae36a:1" aria-labelledby="tab:R2aae36a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aae36a:2" aria-labelledby="tab:R2aae36a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aae36a:3" aria-labelledby="tab:R2aae36a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eae36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eae36a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eae36a:0" aria-labelledby="tab:R2eae36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_max_email_quota_mib&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">4294967296</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/get_pop_quota" data-section-id="tag/Email-Accounts/operation/get_pop_quota" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_pop_quota" id="operation/get_pop_quota" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/get_pop_quota" aria-label="tag/Email-Accounts/operation/get_pop_quota"></a>Return email account&#x27;s quota </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves an email account&amp;#39;s quota.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail&lt;/a&gt; role, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves an email account&#39;s quota.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail</a> role, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="as_bytes" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">as_bytes</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">as_bytes=1</span></div><div><div html="&lt;p&gt;Whether to return the quota as bytes.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Return the quota as bytes.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Return the quota as megabytes (MB).&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to return the quota as bytes.</p>
<ul>
<li><code>1</code> — Return the quota as bytes.</li>
<li><code>0</code> — Return the quota as megabytes (MB).</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The email account&amp;#39;s domain. This parameter defaults to the cPanel account&amp;#39;s main domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account&#39;s domain. This parameter defaults to the cPanel account&#39;s main domain.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user</span></div><div><div html="&lt;p&gt;The email account username.  For example, user if the email address is &lt;a href=&quot;mailto:&amp;#x75;&amp;#115;&amp;#x65;&amp;#114;&amp;#64;&amp;#101;&amp;#x78;&amp;#x61;&amp;#109;&amp;#x70;&amp;#108;&amp;#101;&amp;#x2e;&amp;#99;&amp;#111;&amp;#x6d;&quot;&gt;&amp;#x75;&amp;#115;&amp;#x65;&amp;#114;&amp;#64;&amp;#101;&amp;#x78;&amp;#x61;&amp;#109;&amp;#x70;&amp;#108;&amp;#101;&amp;#x2e;&amp;#99;&amp;#111;&amp;#x6d;&lt;/a&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account username.  For example, user if the email address is <a href="mailto:&#x75;&#115;&#x65;&#114;&#64;&#101;&#x78;&#x61;&#109;&#x70;&#108;&#101;&#x2e;&#99;&#111;&#x6d;">&#x75;&#115;&#x65;&#114;&#64;&#101;&#x78;&#x61;&#109;&#x70;&#108;&#101;&#x2e;&#99;&#111;&#x6d;</a>.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/get_pop_quota</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/get_pop_quota</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aai36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aai36a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aai36a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aai36a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2aai36a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aai36a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2aai36a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aai36a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aai36a:0" aria-labelledby="tab:R2aai36a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  get_pop_quota <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'user'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aai36a:1" aria-labelledby="tab:R2aai36a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aai36a:2" aria-labelledby="tab:R2aai36a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aai36a:3" aria-labelledby="tab:R2aai36a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eai36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eai36a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eai36a:0" aria-labelledby="tab:R2eai36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_pop_quota&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">262144000</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/get_webmail_settings" data-section-id="tag/Email-Accounts/operation/get_webmail_settings" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_webmail_settings" id="operation/get_webmail_settings" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/get_webmail_settings" aria-label="tag/Email-Accounts/operation/get_webmail_settings"></a>Return email account&#x27;s Webmail settings </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves an email account&amp;#39;s Webmail settings.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves an email account&#39;s Webmail settings.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="account" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand account"><span class="property-name">account</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or string</span></div> <div><div html="&lt;p&gt;The email account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If you do &lt;strong&gt;not&lt;/strong&gt; specify a value, the function retrieves settings for the cPanel account&amp;#39;s default mail account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account.</p>
<p><strong>Note:</strong></p>
<p>If you do <strong>not</strong> specify a value, the function retrieves settings for the cPanel account&#39;s default mail account.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/get_webmail_settings</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/get_webmail_settings</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aam36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aam36a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aam36a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aam36a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2aam36a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aam36a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2aam36a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aam36a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aam36a:0" aria-labelledby="tab:R2aam36a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  get_webmail_settings
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aam36a:1" aria-labelledby="tab:R2aam36a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aam36a:2" aria-labelledby="tab:R2aam36a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aam36a:3" aria-labelledby="tab:R2aam36a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eam36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eam36a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eam36a:0" aria-labelledby="tab:R2eam36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_webmail_settings&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;mail.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_maildir"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">&quot;user@example.com&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/list_auto_responders" data-section-id="tag/Email-Accounts/operation/list_auto_responders" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_auto_responders" id="operation/list_auto_responders" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/list_auto_responders" aria-label="tag/Email-Accounts/operation/list_auto_responders"></a>Return domain&#x27;s autoresponders </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists a domain&amp;#39;s autoresponders.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists a domain&#39;s autoresponders.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The domain name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="regex" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">regex</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">regex=user</span></div><div><div html="&lt;p&gt;A &lt;a href=&quot;https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions&quot;&gt;Perl Compatible Regular Expression (PCRE)&lt;/a&gt; that filters the results.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A <a href="https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions">Perl Compatible Regular Expression (PCRE)</a> that filters the results.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/list_auto_responders</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/list_auto_responders</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aaq36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aaq36a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aaq36a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aaq36a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2aaq36a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aaq36a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2aaq36a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aaq36a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aaq36a:0" aria-labelledby="tab:R2aaq36a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  list_auto_responders <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aaq36a:1" aria-labelledby="tab:R2aaq36a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aaq36a:2" aria-labelledby="tab:R2aaq36a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aaq36a:3" aria-labelledby="tab:R2aaq36a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eaq36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eaq36a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eaq36a:0" aria-labelledby="tab:R2eaq36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_auto_responders&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject"</span>: <span class="token string">&quot;Autoresponder Subject&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/list_default_address" data-section-id="tag/Email-Accounts/operation/list_default_address" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_default_address" id="operation/list_default_address" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/list_default_address" aria-label="tag/Email-Accounts/operation/list_default_address"></a>Return domain&#x27;s default email address </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves a domain&amp;#39;s default address.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a domain&#39;s default address.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The domain. If you do not specify a value, the function lists default addresses for all of the cPanel account&amp;#39;s domains.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain. If you do not specify a value, the function lists default addresses for all of the cPanel account&#39;s domains.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;username&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=user</span></div><div><div html="&lt;p&gt;The user whose default addresses to list.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user whose default addresses to list.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/list_default_address</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/list_default_address</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aau36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aau36a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aau36a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aau36a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2aau36a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aau36a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2aau36a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aau36a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aau36a:0" aria-labelledby="tab:R2aau36a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  list_default_address <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'user'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aau36a:1" aria-labelledby="tab:R2aau36a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aau36a:2" aria-labelledby="tab:R2aau36a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aau36a:3" aria-labelledby="tab:R2aau36a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eau36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eau36a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eau36a:0" aria-labelledby="tab:R2eau36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_default_address&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"defaultaddress"</span>: <span class="token string">&quot;user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/list_mail_domains" data-section-id="tag/Email-Accounts/operation/list_mail_domains" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_mail_domains" id="operation/list_mail_domains" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/list_mail_domains" aria-label="tag/Email-Accounts/operation/list_mail_domains"></a>Return cPanel account&#x27;s mail domains </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the account&amp;#39;s mail domains.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  This function &lt;strong&gt;always&lt;/strong&gt; returns the account&amp;#39;s main domain first.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the account&#39;s mail domains.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
<p><strong>Note:</strong></p>
<p>  This function <strong>always</strong> returns the account&#39;s main domain first.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="add_www" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">add_www</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">add_www=1</span></div><div><div html="&lt;p&gt;Whether to list &lt;code&gt;www.&lt;/code&gt; addresses.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — List &lt;code&gt;www.&lt;/code&gt; addresses.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Do &lt;strong&gt;not&lt;/strong&gt; list &lt;code&gt;www.&lt;/code&gt; addresses.
For example, if you specify &lt;code&gt;1&lt;/code&gt;, the function&amp;#39;s output would include both &lt;code&gt;example.com&lt;/code&gt; and &lt;code&gt;www.example.com&lt;/code&gt;. If you specify &lt;code&gt;0&lt;/code&gt;, the output would include &lt;strong&gt;only&lt;/strong&gt; &lt;code&gt;example.com&lt;/code&gt;.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to list <code>www.</code> addresses.</p>
<ul>
<li><code>1</code> — List <code>www.</code> addresses.</li>
<li><code>0</code> — Do <strong>not</strong> list <code>www.</code> addresses.
For example, if you specify <code>1</code>, the function&#39;s output would include both <code>example.com</code> and <code>www.example.com</code>. If you specify <code>0</code>, the output would include <strong>only</strong> <code>example.com</code>.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="include_wildcard" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">include_wildcard</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">include_wildcard=1</span></div><div><div html="&lt;p&gt;Whether to list wildcard addresses.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — List wildcard addresses.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Do &lt;strong&gt;not&lt;/strong&gt; list wildcard addresses.
For example, if you specify &lt;code&gt;1&lt;/code&gt;, the function&amp;#39;s output would include both &lt;code&gt;example.com&lt;/code&gt; and &lt;code&gt;*.example.com&lt;/code&gt;. If you specify &lt;code&gt;0&lt;/code&gt;, the output would include &lt;strong&gt;only&lt;/strong&gt; &lt;code&gt;example.com&lt;/code&gt;.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to list wildcard addresses.</p>
<ul>
<li><code>1</code> — List wildcard addresses.</li>
<li><code>0</code> — Do <strong>not</strong> list wildcard addresses.
For example, if you specify <code>1</code>, the function&#39;s output would include both <code>example.com</code> and <code>*.example.com</code>. If you specify <code>0</code>, the output would include <strong>only</strong> <code>example.com</code>.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="select" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">select</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">select=example.com</span></div><div><div html="&lt;p&gt;The name of the domain that the function returns with the &lt;code&gt;select &lt;/code&gt;output parameter. If you do &lt;strong&gt;not&lt;/strong&gt; use this parameter, the function will &lt;strong&gt;not&lt;/strong&gt; return the &lt;code&gt;select&lt;/code&gt; parameter with any domains.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the domain that the function returns with the <code>select </code>output parameter. If you do <strong>not</strong> use this parameter, the function will <strong>not</strong> return the <code>select</code> parameter with any domains.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/list_mail_domains</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/list_mail_domains</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ab236a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ab236a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ab236a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab236a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2ab236a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab236a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2ab236a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab236a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ab236a:0" aria-labelledby="tab:R2ab236a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  list_mail_domains
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab236a:1" aria-labelledby="tab:R2ab236a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab236a:2" aria-labelledby="tab:R2ab236a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab236a:3" aria-labelledby="tab:R2ab236a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eb236a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eb236a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eb236a:0" aria-labelledby="tab:R2eb236a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_mail_domains&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"select"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/list_pops" data-section-id="tag/Email-Accounts/operation/list_pops" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_pops" id="operation/list_pops" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/list_pops" aria-label="tag/Email-Accounts/operation/list_pops"></a>Return email accounts </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the cPanel account&amp;#39;s email accounts.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the cPanel account&#39;s email accounts.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="no_validate" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">no_validate</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">no_validate=1</span></div><div><div html="&lt;p&gt;Whether to skip the email database&amp;#39;s validation check.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Skip the validation check.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Run the validation check.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to skip the email database&#39;s validation check.</p>
<ul>
<li><code>1</code> — Skip the validation check.</li>
<li><code>0</code> — Run the validation check.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="regex" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">regex</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">regex=user</span></div><div><div html="&lt;p&gt;A &lt;a href=&quot;https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions&quot;&gt;Perl Compatible Regular Expression (PCRE)&lt;/a&gt; that filters the results.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A <a href="https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions">Perl Compatible Regular Expression (PCRE)</a> that filters the results.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="skip_main" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">skip_main</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">skip_main=0</span></div><div><div html="&lt;p&gt;Whether to exclude the cPanel account&amp;#39;s main account from the results.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Exclude the main account.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Include the main account.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to exclude the cPanel account&#39;s main account from the results.</p>
<ul>
<li><code>1</code> — Exclude the main account.</li>
<li><code>0</code> — Include the main account.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/list_pops</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/list_pops</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ab636a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ab636a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ab636a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab636a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2ab636a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab636a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2ab636a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab636a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ab636a:0" aria-labelledby="tab:R2ab636a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  list_pops
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab636a:1" aria-labelledby="tab:R2ab636a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab636a:2" aria-labelledby="tab:R2ab636a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab636a:3" aria-labelledby="tab:R2ab636a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eb636a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eb636a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eb636a:0" aria-labelledby="tab:R2eb636a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_pops&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"login"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"suspended_incoming"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"suspended_login"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/list_pops_with_disk" data-section-id="tag/Email-Accounts/operation/list_pops_with_disk" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_pops_with_disk" id="operation/list_pops_with_disk" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/list_pops_with_disk" aria-label="tag/Email-Accounts/operation/list_pops_with_disk"></a>Return email accounts with disk information </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the cPanel account&amp;#39;s email accounts with disk information.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the cPanel account&#39;s email accounts with disk information.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;A domain name to filter the results by. If you do &lt;strong&gt;not&lt;/strong&gt; use this parameter, the function returns &lt;strong&gt;all&lt;/strong&gt; of the cPanel account&amp;#39;s email addresses.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A domain name to filter the results by. If you do <strong>not</strong> use this parameter, the function returns <strong>all</strong> of the cPanel account&#39;s email addresses.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;username&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user</span></div><div><div html="&lt;p&gt;The cPanel user account to query. If you do &lt;strong&gt;not&lt;/strong&gt; use this parameter, the function returns the email addresses for &lt;strong&gt;all&lt;/strong&gt; cPanel accounts that the user owns.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; To retrieve information for a single email address, add the domain parameter. For example, &lt;code&gt;email=user&amp;amp;domain=example.com&lt;/code&gt; will return information for the email address &lt;code&gt;user@example.com&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel user account to query. If you do <strong>not</strong> use this parameter, the function returns the email addresses for <strong>all</strong> cPanel accounts that the user owns.</p>
<p><strong>Note:</strong></p>
<p> To retrieve information for a single email address, add the domain parameter. For example, <code>email=user&amp;domain=example.com</code> will return information for the email address <code>user@example.com</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="get_restrictions" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">get_restrictions</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">get_restrictions=0</span></div><div><div html="&lt;p&gt;Whether to display restriction status for each of the email addresses.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Display.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Do &lt;strong&gt;not&lt;/strong&gt; display.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to display restriction status for each of the email addresses.</p>
<ul>
<li><code>1</code> — Display.</li>
<li><code>0</code> — Do <strong>not</strong> display.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="infinityimg" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">infinityimg</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">infinityimg=images/myimg.jpg</span></div><div><div html="&lt;p&gt;An image to display for email addresses with an unlimited quota. If you specify an &lt;code&gt;infinityimg&lt;/code&gt; value, the function returns HTML code to display that image as the &lt;code&gt;diskquota&lt;/code&gt; parameter&amp;#39;s value.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An image to display for email addresses with an unlimited quota. If you specify an <code>infinityimg</code> value, the function returns HTML code to display that image as the <code>diskquota</code> parameter&#39;s value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="infinitylang" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">infinitylang</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">infinitylang=0</span></div><div><div html="&lt;p&gt;Whether to return the &lt;code&gt;∞&lt;/code&gt; character for email addresses with an unlimited quota.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Return the &lt;code&gt;∞&lt;/code&gt; character for unlimited &lt;code&gt;diskquota&lt;/code&gt; values.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Return the string &lt;code&gt;unlimited&lt;/code&gt; for unlimited &lt;code&gt;diskquota&lt;/code&gt; values.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; If you specify &lt;code&gt;1&lt;/code&gt; for this parameter &lt;strong&gt;and&lt;/strong&gt; the &lt;code&gt;infinityimg&lt;/code&gt; parameter, the function ignores &lt;strong&gt;this&lt;/strong&gt; parameter and returns HTML code for unlimited &lt;code&gt;diskquota&lt;/code&gt; values.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to return the <code>∞</code> character for email addresses with an unlimited quota.</p>
<ul>
<li><code>1</code> — Return the <code>∞</code> character for unlimited <code>diskquota</code> values.</li>
<li><code>0</code> — Return the string <code>unlimited</code> for unlimited <code>diskquota</code> values.</li>
</ul>
<p><strong>Note:</strong></p>
<p> If you specify <code>1</code> for this parameter <strong>and</strong> the <code>infinityimg</code> parameter, the function ignores <strong>this</strong> parameter and returns HTML code for unlimited <code>diskquota</code> values.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="maxaccounts" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">maxaccounts</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= 1 </span></span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;unlimited&quot;</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">maxaccounts=500</span></div><div><div html="&lt;p&gt;The maximum number of email addresses to return. If you do not use this parameter, the function returns an unlimited number of email addresses.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum number of email addresses to return. If you do not use this parameter, the function returns an unlimited number of email addresses.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="no_disk" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">no_disk</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">no_disk=0</span></div><div><div html="&lt;p&gt;Whether to skip the collection of disk usage information.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Do &lt;strong&gt;not&lt;/strong&gt; collect.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Collect.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to skip the collection of disk usage information.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> collect.</li>
<li><code>0</code> — Collect.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="no_validate" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">no_validate</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">no_validate=0</span></div><div><div html="&lt;p&gt;Whether to skip email database validation.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Skip validation.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Perform the validation.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to skip email database validation.</p>
<ul>
<li><code>1</code> — Skip validation.</li>
<li><code>0</code> — Perform the validation.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="regex" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">regex</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;An empty string&quot;</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">regex=/^[a-z0-9_-]{6,18}$/</span></div><div><div html="&lt;p&gt;A &lt;a href=&quot;https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions&quot;&gt;Perl Compatible Regular Expression (PCRE)&lt;/a&gt; that filters the results. For example, &lt;code&gt;/^[a-z0-9_-]{6,18}$/&lt;/code&gt; matches the local portion of an email address, if it contains between six and 18 characters.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A <a href="https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions">Perl Compatible Regular Expression (PCRE)</a> that filters the results. For example, <code>/^[a-z0-9_-]{6,18}$/</code> matches the local portion of an email address, if it contains between six and 18 characters.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/list_pops_with_disk</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/list_pops_with_disk</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aba36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aba36a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aba36a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aba36a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2aba36a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aba36a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2aba36a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aba36a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aba36a:0" aria-labelledby="tab:R2aba36a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  list_pops_with_disk
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aba36a:1" aria-labelledby="tab:R2aba36a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aba36a:2" aria-labelledby="tab:R2aba36a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aba36a:3" aria-labelledby="tab:R2aba36a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eba36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eba36a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eba36a:0" aria-labelledby="tab:R2eba36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_pops_with_disk&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"_diskquota"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_diskused"</span>: <span class="token number">483</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"diskquota"</span>: <span class="token string">&quot;unlimited&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"diskused"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"diskusedpercent"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"diskusedpercent20"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"diskusedpercent_float"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"has_suspended"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hold_outgoing"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"humandiskquota"</span>: <span class="token string">&quot;None&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"humandiskused"</span>: <span class="token string">&quot;483 bytes&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"login"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mtime"</span>: <span class="token number">1415894498</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"suspended_incoming"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"suspended_login"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"suspended_outgoing"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"txtdiskquota"</span>: <span class="token string">&quot;unlimited&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">&quot;user&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/passwd_pop" data-section-id="tag/Email-Accounts/operation/passwd_pop" class="sc-dntaoT ceciOs"><div data-section-id="operation/passwd_pop" id="operation/passwd_pop" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/passwd_pop" aria-label="tag/Email-Accounts/operation/passwd_pop"></a>Update email account password </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function changes an email account&amp;#39;s password.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function changes an email account&#39;s password.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;the cPanel account&#x27;s main domain&quot;</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The email account&amp;#39;s domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account&#39;s domain.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="email" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand email"><span class="property-name">email</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=username@example.com</span></div><div><div html="&lt;p&gt;The email account username or address.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account username or address.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="password" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">password</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">password=12345luggage</span></div><div><div html="&lt;p&gt;The email account password.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account password.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/passwd_pop</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/passwd_pop</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2abe36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abe36a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abe36a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abe36a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2abe36a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abe36a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2abe36a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abe36a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abe36a:0" aria-labelledby="tab:R2abe36a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  passwd_pop <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'username@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">password</span><span class="token operator">=</span><span class="token string">'12345luggage'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abe36a:1" aria-labelledby="tab:R2abe36a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abe36a:2" aria-labelledby="tab:R2abe36a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abe36a:3" aria-labelledby="tab:R2abe36a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ebe36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebe36a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebe36a:0" aria-labelledby="tab:R2ebe36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;passwd_pop&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/release_outgoing" data-section-id="tag/Email-Accounts/operation/release_outgoing" class="sc-dntaoT ceciOs"><div data-section-id="operation/release_outgoing" id="operation/release_outgoing" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/release_outgoing" aria-label="tag/Email-Accounts/operation/release_outgoing"></a>Start email account outgoing mail </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function sends all of the outgoing mail from Exim&amp;#39;s queue for an email account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To set Exim to queue all outgoing mail for an email account, use the UAPI &lt;code&gt;Email::hold_outgoing&lt;/code&gt; function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sends all of the outgoing mail from Exim&#39;s queue for an email account.</p>
<p><strong>Note:</strong></p>
<p>To set Exim to queue all outgoing mail for an email account, use the UAPI <code>Email::hold_outgoing</code> function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=username@example.com</span></div><div><div html="&lt;p&gt;The email account&amp;#39;s username.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account&#39;s username.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/release_outgoing</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/release_outgoing</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2abi36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abi36a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abi36a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abi36a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2abi36a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abi36a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2abi36a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abi36a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abi36a:0" aria-labelledby="tab:R2abi36a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  release_outgoing <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'username@example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abi36a:1" aria-labelledby="tab:R2abi36a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abi36a:2" aria-labelledby="tab:R2abi36a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abi36a:3" aria-labelledby="tab:R2abi36a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ebi36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebi36a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebi36a:0" aria-labelledby="tab:R2ebi36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;release_outgoing&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/set_default_address" data-section-id="tag/Email-Accounts/operation/set_default_address" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_default_address" id="operation/set_default_address" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/set_default_address" aria-label="tag/Email-Accounts/operation/set_default_address"></a>Create default email address </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function configures a default (catchall) email address.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important&lt;/strong&gt;:&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Mail Receive role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function configures a default (catchall) email address.</p>
<p><strong>Important</strong>:</p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">Mail Receive role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The domain whose default email behavior you want to configure.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note&lt;/strong&gt;:&lt;/p&gt;
&lt;p&gt;  This parameter defaults to the cPanel account’s main domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain whose default email behavior you want to configure.</p>
<p><strong>Note</strong>:</p>
<p>  This parameter defaults to the cPanel account’s main domain.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="failmsgs" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">failmsgs</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;No such person at this address&quot;</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">failmsgs=Failure echos loud. That address does not exist. Softly I regret. - an email failure haiku</span></div><div><div html="&lt;p&gt;The failure message for the message’s sender.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note&lt;/strong&gt;:&lt;/p&gt;
&lt;p&gt; Use this parameter if you used the &lt;code&gt;fail&lt;/code&gt; method for the &lt;code&gt;fwdopt&lt;/code&gt; parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The failure message for the message’s sender.</p>
<p><strong>Note</strong>:</p>
<p> Use this parameter if you used the <code>fail</code> method for the <code>fwdopt</code> parameter.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="fwdemail" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">fwdemail</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">fwdemail=admin@example.com</span></div><div><div html="&lt;p&gt;The email address to which the system forwards messages.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note&lt;/strong&gt;:&lt;/p&gt;
&lt;p&gt; Use this parameter if you used the &lt;code&gt;fwd&lt;/code&gt; method for the &lt;code&gt;fwdopt&lt;/code&gt; parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email address to which the system forwards messages.</p>
<p><strong>Note</strong>:</p>
<p> Use this parameter if you used the <code>fwd</code> method for the <code>fwdopt</code> parameter.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="fwdopt" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">fwdopt</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;fwd&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;fail&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;blackhole&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;pipe&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">fwdopt=fwd</span></div><div><div html="&lt;p&gt;The method to use to handle unroutable mail.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;fwd&lt;/code&gt; — Forward messages to the &lt;code&gt;fwdemail&lt;/code&gt; parameter’s address.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;fail&lt;/code&gt; — Bounce messages back to the sender, and include the &lt;code&gt;failmsgs&lt;/code&gt; parameter’s failure message.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;blackhole&lt;/code&gt; — Send messages to the &lt;code&gt;/dev/null/&lt;/code&gt; directory. This method does &lt;strong&gt;not&lt;/strong&gt; generate a failure notice.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;pipe&lt;/code&gt; — Pipe mail to the &lt;code&gt;pipefwd&lt;/code&gt; parameter’s application. This parameter requires the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;File Storage role&lt;/a&gt;.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The method to use to handle unroutable mail.</p>
<ul>
<li><code>fwd</code> — Forward messages to the <code>fwdemail</code> parameter’s address.</li>
<li><code>fail</code> — Bounce messages back to the sender, and include the <code>failmsgs</code> parameter’s failure message.</li>
<li><code>blackhole</code> — Send messages to the <code>/dev/null/</code> directory. This method does <strong>not</strong> generate a failure notice.</li>
<li><code>pipe</code> — Pipe mail to the <code>pipefwd</code> parameter’s application. This parameter requires the <a href="https://go.cpanel.net/serverroles">File Storage role</a>.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="pipefwd" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">pipefwd</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">pipefwd=mailscript.pl</span></div><div><div html="&lt;p&gt;The application to which the system pipes messages.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note&lt;/strong&gt;:&lt;/p&gt;
&lt;p&gt;  Use this parameter if you used the &lt;code&gt;pipe&lt;/code&gt; method for the &lt;code&gt;fwdopt&lt;/code&gt; parameter.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important&lt;/strong&gt;:&lt;/p&gt;
&lt;p&gt;  This parameter requires the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;File Storage role&lt;/a&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The application to which the system pipes messages.</p>
<p><strong>Note</strong>:</p>
<p>  Use this parameter if you used the <code>pipe</code> method for the <code>fwdopt</code> parameter.</p>
<p><strong>Important</strong>:</p>
<p>  This parameter requires the <a href="https://go.cpanel.net/serverroles">File Storage role</a>.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/set_default_address</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/set_default_address</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2abm36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abm36a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abm36a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abm36a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2abm36a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abm36a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2abm36a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abm36a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abm36a:0" aria-labelledby="tab:R2abm36a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  set_default_address <span class="token punctuation">\</span>
  <span class="token assign-left variable">fwdopt</span><span class="token operator">=</span><span class="token string">'fwd'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abm36a:1" aria-labelledby="tab:R2abm36a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abm36a:2" aria-labelledby="tab:R2abm36a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abm36a:3" aria-labelledby="tab:R2abm36a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ebm36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebm36a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebm36a:0" aria-labelledby="tab:R2ebm36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_default_address&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dest"</span>: <span class="token string">&quot;admin@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/trace_delivery" data-section-id="tag/Email-Accounts/operation/trace_delivery" class="sc-dntaoT ceciOs"><div data-section-id="operation/trace_delivery" id="operation/trace_delivery" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/trace_delivery" aria-label="tag/Email-Accounts/operation/trace_delivery"></a>Run email delivery route trace </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function traces the email delivery route to an email account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function traces the email delivery route to an email account.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="recipient" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">recipient</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">recipient=username@example.com</span></div><div><div html="&lt;p&gt;The email address to which to trace a message delivery path.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email address to which to trace a message delivery path.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/trace_delivery</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/trace_delivery</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2abq36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abq36a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abq36a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abq36a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2abq36a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abq36a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2abq36a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abq36a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abq36a:0" aria-labelledby="tab:R2abq36a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  trace_delivery <span class="token punctuation">\</span>
  <span class="token assign-left variable">recipient</span><span class="token operator">=</span><span class="token string">'username@example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abq36a:1" aria-labelledby="tab:R2abq36a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abq36a:2" aria-labelledby="tab:R2abq36a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abq36a:3" aria-labelledby="tab:R2abq36a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ebq36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebq36a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebq36a:0" aria-labelledby="tab:R2ebq36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;trace_delivery&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"address"</span>: <span class="token string">&quot;username@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"destinations"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"address"</span>: <span class="token string">&quot;username@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"aliasfile"</span>: <span class="token string">&quot;/etc/valiases/example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"destinations"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"mailbox"</span>: <span class="token string">&quot;username@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;local_delivery&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;routed&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;routed&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/verify_password" data-section-id="tag/Email-Accounts/operation/verify_password" class="sc-dntaoT ceciOs"><div data-section-id="operation/verify_password" id="operation/verify_password" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/verify_password" aria-label="tag/Email-Accounts/operation/verify_password"></a>Validate email account password </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function verifies the password for an email account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function verifies the password for an email account.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=username@example.com</span></div><div><div html="&lt;p&gt;The email account address.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account address.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="password" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">password</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">password=123456luggage</span></div><div><div html="&lt;p&gt;The email account password.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account password.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/verify_password</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/verify_password</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2abu36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abu36a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abu36a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abu36a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2abu36a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abu36a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2abu36a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abu36a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abu36a:0" aria-labelledby="tab:R2abu36a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  verify_password <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'username@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">password</span><span class="token operator">=</span><span class="token string">'123456luggage'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abu36a:1" aria-labelledby="tab:R2abu36a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abu36a:2" aria-labelledby="tab:R2abu36a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abu36a:3" aria-labelledby="tab:R2abu36a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ebu36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebu36a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebu36a:0" aria-labelledby="tab:R2ebu36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;verify_password&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/delete_auto_responder" data-section-id="tag/Email-Accounts/operation/delete_auto_responder" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete_auto_responder" id="operation/delete_auto_responder" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/delete_auto_responder" aria-label="tag/Email-Accounts/operation/delete_auto_responder"></a>Delete email account&#x27;s autoresponder </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function deletes an autoresponder.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles#roles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes an autoresponder.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles#roles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user@example.com</span></div><div><div html="&lt;p&gt;The email account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/delete_auto_responder</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/delete_auto_responder</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ac236a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ac236a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ac236a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ac236a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2ac236a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ac236a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2ac236a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ac236a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ac236a:0" aria-labelledby="tab:R2ac236a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  delete_auto_responder <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'user@example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ac236a:1" aria-labelledby="tab:R2ac236a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ac236a:2" aria-labelledby="tab:R2ac236a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ac236a:3" aria-labelledby="tab:R2ac236a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ec236a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ec236a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ec236a:0" aria-labelledby="tab:R2ec236a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;delete_auto_responder&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/delete_pop" data-section-id="tag/Email-Accounts/operation/delete_pop" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete_pop" id="operation/delete_pop" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/delete_pop" aria-label="tag/Email-Accounts/operation/delete_pop"></a>Delete email address </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function deletes an email address.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes an email address.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;The cPanel account&#x27;s main domain.&quot;</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The email account&amp;#39;s domain. For example, &lt;code&gt;example.com&lt;/code&gt; if the email address is &lt;code&gt;user@example.com&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account&#39;s domain. For example, <code>example.com</code> if the email address is <code>user@example.com</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="email" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand email"><span class="property-name">email</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user@domain.com</span></div><div><div html="&lt;p&gt;The email account username or address.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;A valid email account username. For example, &lt;code&gt;user&lt;/code&gt; if the email address is &lt;code&gt;user@example.com&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;A valid email address.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account username or address.</p>
<ul>
<li>A valid email account username. For example, <code>user</code> if the email address is <code>user@example.com</code>.</li>
<li>A valid email address.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="flags" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">flags</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">flags=passwd</span></div><div><div html="&lt;p&gt;Whether to remove the mail account&amp;#39;s home mail directory. If you do not specify a value, the function removes the mail account&amp;#39;s home directory.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;passwd&lt;/code&gt; — Preserve the mail account&amp;#39;s home directory.&lt;/li&gt;
&lt;li&gt;Any other value — Remove the mail account&amp;#39;s home directory.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to remove the mail account&#39;s home mail directory. If you do not specify a value, the function removes the mail account&#39;s home directory.</p>
<ul>
<li><code>passwd</code> — Preserve the mail account&#39;s home directory.</li>
<li>Any other value — Remove the mail account&#39;s home directory.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="skip_quota" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">skip_quota</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">skip_quota=0</span></div><div><div html="&lt;p&gt;Whether to modify the mail account&amp;#39;s quota file.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Do &lt;strong&gt;not&lt;/strong&gt; modify.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Modify.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to modify the mail account&#39;s quota file.</p>
<ul>
<li><code>1</code> — Do <strong>not</strong> modify.</li>
<li><code>0</code> — Modify.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/delete_pop</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/delete_pop</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ac636a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ac636a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ac636a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ac636a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2ac636a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ac636a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2ac636a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ac636a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ac636a:0" aria-labelledby="tab:R2ac636a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  delete_pop <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'user@domain.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ac636a:1" aria-labelledby="tab:R2ac636a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ac636a:2" aria-labelledby="tab:R2ac636a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ac636a:3" aria-labelledby="tab:R2ac636a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ec636a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ec636a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ec636a:0" aria-labelledby="tab:R2ec636a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;delete_pop&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/add_auto_responder" data-section-id="tag/Email-Accounts/operation/add_auto_responder" class="sc-dntaoT ceciOs"><div data-section-id="operation/add_auto_responder" id="operation/add_auto_responder" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/add_auto_responder" aria-label="tag/Email-Accounts/operation/add_auto_responder"></a>Create email account&#x27;s autoresponder </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function creates an autoresponder for an email account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates an autoresponder for an email account.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="body" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">body</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">body=This is an autoresponder message.</span></div><div><div html="&lt;p&gt;The contents of the autoresponder message&amp;#39;s &lt;code&gt;Body&lt;/code&gt; section.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The contents of the autoresponder message&#39;s <code>Body</code> section.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="charset" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">charset</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;utf-8&quot;</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">charset=UTF-8</span></div><div><div html="&lt;p&gt;The &lt;a href=&quot;https://en.wikipedia.org/wiki/Character_encoding&quot;&gt;character set&lt;/a&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The <a href="https://en.wikipedia.org/wiki/Character_encoding">character set</a>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The email account&amp;#39;s domain. For example, &lt;code&gt;example.com&lt;/code&gt; if the email address is &lt;code&gt;user@example.com&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account&#39;s domain. For example, <code>example.com</code> if the email address is <code>user@example.com</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user</span></div><div><div html="&lt;p&gt;The email account name. For example, &lt;code&gt;user&lt;/code&gt; if the email address is &lt;code&gt;user@example.com&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account name. For example, <code>user</code> if the email address is <code>user@example.com</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="from" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">from</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">from=User Name</span></div><div><div html="&lt;p&gt;The contents of the autoresponder message&amp;#39;s &lt;code&gt;From:&lt;/code&gt; field.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The contents of the autoresponder message&#39;s <code>From:</code> field.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="interval" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">interval</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= 0 </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">interval=24</span></div><div><div html="&lt;p&gt;The amount of time, in hours, that the server waits between autoresponder messages to the same address.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  If you specify &lt;code&gt;0&lt;/code&gt;, the system sends a message for each received email.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The amount of time, in hours, that the server waits between autoresponder messages to the same address.</p>
<p><strong>Note:</strong></p>
<p>  If you specify <code>0</code>, the system sends a message for each received email.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="is_html" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">is_html</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">is_html=1</span></div><div><div html="&lt;p&gt;Whether the body of the autoresponder message begins with an &lt;a href=&quot;https://en.wikipedia.org/wiki/Character_encodings_in_HTML#Specifying_the_document.27s_character_encoding&quot;&gt;HTML Content-Type declaration&lt;/a&gt;.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Include an HTML content type declaration.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Do &lt;strong&gt;not&lt;/strong&gt; include an HTML content type declaration.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the body of the autoresponder message begins with an <a href="https://en.wikipedia.org/wiki/Character_encodings_in_HTML#Specifying_the_document.27s_character_encoding">HTML Content-Type declaration</a>.</p>
<ul>
<li><code>1</code> — Include an HTML content type declaration.</li>
<li><code>0</code> — Do <strong>not</strong> include an HTML content type declaration.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="start" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">start</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;unix_timestamp&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">start=1410277881</span></div><div><div html="&lt;p&gt;When to enable the autoresponder.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>When to enable the autoresponder.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="stop" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">stop</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;unix_timestamp&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">stop=1410300000</span></div><div><div html="&lt;p&gt;When to disable the autoresponder. A time that is after the &lt;code&gt;start&lt;/code&gt; time.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>When to disable the autoresponder. A time that is after the <code>start</code> time.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="subject" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">subject</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">subject=Autoresponder Subject</span></div><div><div html="&lt;p&gt;The contents of the autoresponder message&amp;#39;s &lt;code&gt;Subject:&lt;/code&gt; field.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The contents of the autoresponder message&#39;s <code>Subject:</code> field.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/add_auto_responder</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/add_auto_responder</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aca36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aca36a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aca36a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aca36a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2aca36a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aca36a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2aca36a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aca36a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aca36a:0" aria-labelledby="tab:R2aca36a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  add_auto_responder <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'user'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">from</span><span class="token operator">=</span><span class="token string">'User Name'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">subject</span><span class="token operator">=</span><span class="token string">'Autoresponder Subject'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">body</span><span class="token operator">=</span><span class="token string">'This is an autoresponder message.'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">is_html</span><span class="token operator">=</span><span class="token string">'1'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">interval</span><span class="token operator">=</span><span class="token string">'24'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">start</span><span class="token operator">=</span><span class="token string">'1410277881'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">stop</span><span class="token operator">=</span><span class="token string">'1410300000'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aca36a:1" aria-labelledby="tab:R2aca36a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aca36a:2" aria-labelledby="tab:R2aca36a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aca36a:3" aria-labelledby="tab:R2aca36a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eca36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eca36a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eca36a:0" aria-labelledby="tab:R2eca36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;add_auto_responder&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/CSVImport::doimport" data-section-id="tag/Email-Accounts/operation/CSVImport::doimport" class="sc-dntaoT ceciOs"><div data-section-id="operation/CSVImport::doimport" id="operation/CSVImport::doimport" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/CSVImport::doimport" aria-label="tag/Email-Accounts/operation/CSVImport::doimport"></a>Import email accounts from CSV file </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function imports email accounts from an already uploaded CSV file.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function imports email accounts from an already uploaded CSV file.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The domain under which to add the email accounts.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain under which to add the email accounts.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">id=Leq58oid3sF3Moye3_YbJGqoMvCb7M4j</span></div><div><div html="&lt;p&gt;The unique ID of the import operation. The cPanel API 2 CSVImport::uploadimport function generates this ID and stores it in the &lt;code&gt;CPVAR&lt;/code&gt; attribute named &lt;code&gt;csvimportid&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The unique ID of the import operation. The cPanel API 2 CSVImport::uploadimport function generates this ID and stores it in the <code>CPVAR</code> attribute named <code>csvimportid</code>.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="type" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">type</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;email&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;fwd&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">type=email</span></div><div><div html="&lt;p&gt;The type of email address to add.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;email&lt;/code&gt; — A regular email account.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;fwd&lt;/code&gt; — A forwarder.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The type of email address to add.</p>
<ul>
<li><code>email</code> — A regular email account.</li>
<li><code>fwd</code> — A forwarder.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/CSVImport/doimport</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/CSVImport/doimport</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ace36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ace36a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ace36a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ace36a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2ace36a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ace36a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2ace36a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ace36a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ace36a:0" aria-labelledby="tab:R2ace36a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  CSVImport <span class="token punctuation">\</span>
  doimport <span class="token punctuation">\</span>
  <span class="token assign-left variable">id</span><span class="token operator">=</span><span class="token string">'Leq58oid3sF3Moye3_YbJGqoMvCb7M4j'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">type</span><span class="token operator">=</span><span class="token string">'email'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ace36a:1" aria-labelledby="tab:R2ace36a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ace36a:2" aria-labelledby="tab:R2ace36a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ace36a:3" aria-labelledby="tab:R2ace36a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ece36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ece36a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ece36a:0" aria-labelledby="tab:R2ece36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;doimport&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;CSVImport&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"results"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">&quot;j.doe@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">&quot;OK&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;email&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">&quot;jdoe@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">&quot;The account jdoe@example.com already exists!&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;email&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;1 error(s) were encountered while importing accounts.&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/set_manual_mx_redirects" data-section-id="tag/Email-Accounts/operation/set_manual_mx_redirects" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_manual_mx_redirects" id="operation/set_manual_mx_redirects" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/set_manual_mx_redirects" aria-label="tag/Email-Accounts/operation/set_manual_mx_redirects"></a>Add manual MX redirection </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lets you create a manual Exim mail exchanger (MX) redirect for a domain.
An MX redirection lets you bypass the domain&amp;#39;s MX lookup via the Domain Name System (DNS).
This function adds the manual redirect entries to the &lt;code&gt;/etc/manualmx&lt;/code&gt; file.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  To remove a domain&amp;#39;s manual MX redirection, use the UAPI Email &lt;code&gt;unset_manual_mx_redirect&lt;/code&gt; function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lets you create a manual Exim mail exchanger (MX) redirect for a domain.
An MX redirection lets you bypass the domain&#39;s MX lookup via the Domain Name System (DNS).
This function adds the manual redirect entries to the <code>/etc/manualmx</code> file.</p>
<p><strong>Note:</strong></p>
<p>  To remove a domain&#39;s manual MX redirection, use the UAPI Email <code>unset_manual_mx_redirect</code> function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=&#x27;example.com&#x27;</span> - Add a single manual MX redirect entry.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com&amp;domain-1=example1.com&amp;domain-2=example2.com</span> - Add multiple manual MX redirect entries.</li></ul><div><div html="&lt;p&gt;The domain for which to add a manual MX redirect entry.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;To add multiple domain entries, increment the parameter. For example, use the &lt;code&gt;domain&lt;/code&gt;, &lt;code&gt;domain-1&lt;/code&gt;, and &lt;code&gt;domain-2&lt;/code&gt; parameters.&lt;/li&gt;
&lt;li&gt;For multiple domains, you &lt;strong&gt;must&lt;/strong&gt; include its corresponding &lt;code&gt;mx_host&lt;/code&gt; value.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain for which to add a manual MX redirect entry.</p>
<p><strong>Note:</strong></p>
<ul>
<li>To add multiple domain entries, increment the parameter. For example, use the <code>domain</code>, <code>domain-1</code>, and <code>domain-2</code> parameters.</li>
<li>For multiple domains, you <strong>must</strong> include its corresponding <code>mx_host</code> value.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="mx_host" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand mx_host"><span class="property-name">mx_host</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or string or string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">mx_host=&#x27;mailhostexample&#x27;</span> - Add a single manual MX host.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">mx_host=mailhostexample&amp;mx_host-1=mailhostexample&amp;mx_host-2=mailhostexample</span> - Add multiple manual MX hosts.</li></ul><div><div html="&lt;p&gt;The domain, IPv4, or IPv6 address to redirect the domain value&amp;#39;s emails to.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;To add multiple MX hosts, increment the parameter. For example, use the &lt;code&gt;mx_host&lt;/code&gt;, &lt;code&gt;mx_host-1&lt;/code&gt;, and &lt;code&gt;mx_host-2&lt;/code&gt; parameters.&lt;/li&gt;
&lt;li&gt;For multiple MX hosts, you &lt;strong&gt;must&lt;/strong&gt; include its corresponding &lt;code&gt;domain&lt;/code&gt; value.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain, IPv4, or IPv6 address to redirect the domain value&#39;s emails to.</p>
<p><strong>Note:</strong></p>
<ul>
<li>To add multiple MX hosts, increment the parameter. For example, use the <code>mx_host</code>, <code>mx_host-1</code>, and <code>mx_host-2</code> parameters.</li>
<li>For multiple MX hosts, you <strong>must</strong> include its corresponding <code>domain</code> value.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/set_manual_mx_redirects</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/set_manual_mx_redirects</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aci36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aci36a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aci36a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aci36a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2aci36a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aci36a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2aci36a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aci36a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aci36a:0" aria-labelledby="tab:R2aci36a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token parameter variable">--user</span><span class="token operator">=</span>username Email set_manual_mx_redirects <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span> <span class="token assign-left variable">mx_host</span><span class="token operator">=</span><span class="token string">'mailhostexample.com'</span></pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aci36a:1" aria-labelledby="tab:R2aci36a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aci36a:2" aria-labelledby="tab:R2aci36a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aci36a:3" aria-labelledby="tab:R2aci36a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eci36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eci36a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eci36a:0" aria-labelledby="tab:R2eci36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_manual_mx_redirects&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"example.com"</span>: <span class="token string">&quot;mailhostexample.com&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/unset_manual_mx_redirects" data-section-id="tag/Email-Accounts/operation/unset_manual_mx_redirects" class="sc-dntaoT ceciOs"><div data-section-id="operation/unset_manual_mx_redirects" id="operation/unset_manual_mx_redirects" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/unset_manual_mx_redirects" aria-label="tag/Email-Accounts/operation/unset_manual_mx_redirects"></a>Remove manual MX redirection </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lets you create a manual Exim mail exchanger (MX) redirect for a domain.
An MX redirection lets you bypass the domain&amp;#39;s MX lookup via the Domain Name System (DNS).
This function adds the manual redirect entries to the &lt;code&gt;/etc/manualmx&lt;/code&gt; file.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  To remove a domain&amp;#39;s manual MX redirection, use the UAPI Email &lt;code&gt;unset_manual_mx_redirect&lt;/code&gt; function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lets you create a manual Exim mail exchanger (MX) redirect for a domain.
An MX redirection lets you bypass the domain&#39;s MX lookup via the Domain Name System (DNS).
This function adds the manual redirect entries to the <code>/etc/manualmx</code> file.</p>
<p><strong>Note:</strong></p>
<p>  To remove a domain&#39;s manual MX redirection, use the UAPI Email <code>unset_manual_mx_redirect</code> function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=&#x27;example.com&#x27;</span> - Add a single manual MX redirect entry.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com&amp;domain-1=example1.com&amp;domain-2=example2.com</span> - Add multiple manual MX redirect entries.</li></ul><div><div html="&lt;p&gt;The domain for which to add a manual MX redirect entry.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;To add multiple domain entries, increment the parameter. For example, use the &lt;code&gt;domain&lt;/code&gt;, &lt;code&gt;domain-1&lt;/code&gt;, and &lt;code&gt;domain-2&lt;/code&gt; parameters.&lt;/li&gt;
&lt;li&gt;For multiple domains, you &lt;strong&gt;must&lt;/strong&gt; include its corresponding &lt;code&gt;mx_host&lt;/code&gt; value.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain for which to add a manual MX redirect entry.</p>
<p><strong>Note:</strong></p>
<ul>
<li>To add multiple domain entries, increment the parameter. For example, use the <code>domain</code>, <code>domain-1</code>, and <code>domain-2</code> parameters.</li>
<li>For multiple domains, you <strong>must</strong> include its corresponding <code>mx_host</code> value.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/unset_manual_mx_redirects</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/unset_manual_mx_redirects</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2acm36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2acm36a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2acm36a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acm36a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2acm36a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acm36a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2acm36a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acm36a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2acm36a:0" aria-labelledby="tab:R2acm36a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token parameter variable">--user</span><span class="token operator">=</span>username Email unset_manual_mx_redirects <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span></pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acm36a:1" aria-labelledby="tab:R2acm36a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acm36a:2" aria-labelledby="tab:R2acm36a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acm36a:3" aria-labelledby="tab:R2acm36a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ecm36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ecm36a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ecm36a:0" aria-labelledby="tab:R2ecm36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;unset_manual_mx_redirects&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"example.com"</span>: <span class="token string">&quot;mailhostexample.com&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Accounts/operation/email-terminate_mailbox_sessions" data-section-id="tag/Email-Accounts/operation/email-terminate_mailbox_sessions" class="sc-dntaoT ceciOs"><div data-section-id="operation/email-terminate_mailbox_sessions" id="operation/email-terminate_mailbox_sessions" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Accounts/operation/email-terminate_mailbox_sessions" aria-label="tag/Email-Accounts/operation/email-terminate_mailbox_sessions"></a>Stop cPanel account IMAP and POP3 connections </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function terminates all IMAP and POP3 connections for a cPanel account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This function ends connections for every email address, which includes the &lt;a href=&quot;https://go.cpanel.net/cpaneldocsDefaultAddress&quot;&gt;default address&lt;/a&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function terminates all IMAP and POP3 connections for a cPanel account.</p>
<p><strong>Note:</strong></p>
<p>This function ends connections for every email address, which includes the <a href="https://go.cpanel.net/cpaneldocsDefaultAddress">default address</a>.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="metadata" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand metadata"><span class="property-name">metadata</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/terminate_mailbox_sessions</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/terminate_mailbox_sessions</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2acq36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2acq36a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2acq36a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acq36a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2acq36a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acq36a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2acq36a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acq36a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2acq36a:0" aria-labelledby="tab:R2acq36a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  terminate_mailbox_sessions
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acq36a:1" aria-labelledby="tab:R2acq36a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acq36a:2" aria-labelledby="tab:R2acq36a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acq36a:3" aria-labelledby="tab:R2acq36a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ecq36a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ecq36a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ecq36a:0" aria-labelledby="tab:R2ecq36a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"command"</span>: <span class="token string">&quot;terminate_mailbox_sessions&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">&quot;OK&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Filtering" data-section-id="tag/Email-Filtering" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Filtering" aria-label="tag/Email-Filtering"></a>Email Filtering</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Email / Email Filtering&lt;/p&gt;
"><p>Email / Email Filtering</p>
</div></div></div><div id="tag/Email-Filtering/operation/count_filters" data-section-id="tag/Email-Filtering/operation/count_filters" class="sc-dntaoT ceciOs"><div data-section-id="operation/count_filters" id="operation/count_filters" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Filtering/operation/count_filters" aria-label="tag/Email-Filtering/operation/count_filters"></a>Return cPanel account&#x27;s email filters total </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the number of &lt;a href=&quot;https://go.cpanel.net/cpaneldocsEmailFilters&quot;&gt;email filters&lt;/a&gt; for every email address on a cPanel account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt; or the &lt;a href=&quot;https://go.cpanel.net/whmdocsFeatureManager&quot;&gt;&lt;em&gt;IP Blocker&lt;/em&gt;&lt;/a&gt; feature, the system &lt;strong&gt;disables&lt;/strong&gt; this function. For more information, read our &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles&quot;&gt;How to Use Server Profiles&lt;/a&gt; documentation.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the number of <a href="https://go.cpanel.net/cpaneldocsEmailFilters">email filters</a> for every email address on a cPanel account.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a> or the <a href="https://go.cpanel.net/whmdocsFeatureManager"><em>IP Blocker</em></a> feature, the system <strong>disables</strong> this function. For more information, read our <a href="https://go.cpanel.net/howtouseserverprofiles">How to Use Server Profiles</a> documentation.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/count_filters</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/count_filters</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rii656a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rii656a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rii656a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii656a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rii656a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii656a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rii656a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii656a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rii656a:0" aria-labelledby="tab:Rii656a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  count_filters
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii656a:1" aria-labelledby="tab:Rii656a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii656a:2" aria-labelledby="tab:Rii656a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii656a:3" aria-labelledby="tab:Rii656a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rji656a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rji656a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rji656a:0" aria-labelledby="tab:Rji656a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;count_filters&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Filtering/operation/disable_filter" data-section-id="tag/Email-Filtering/operation/disable_filter" class="sc-dntaoT ceciOs"><div data-section-id="operation/disable_filter" id="operation/disable_filter" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Filtering/operation/disable_filter" aria-label="tag/Email-Filtering/operation/disable_filter"></a>Disable email filter for email account </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function disables an email filter.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables an email filter.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="account" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">account</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">account=user@example.com</span></div><div><div html="&lt;p&gt;The email address that owns the filter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email address that owns the filter.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="filtername" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">filtername</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">filtername=coffee</span></div><div><div html="&lt;p&gt;The filter&amp;#39;s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The filter&#39;s name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/disable_filter</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/disable_filter</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riia56a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riia56a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riia56a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riia56a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riia56a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riia56a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riia56a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riia56a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riia56a:0" aria-labelledby="tab:Riia56a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  disable_filter <span class="token punctuation">\</span>
  <span class="token assign-left variable">account</span><span class="token operator">=</span><span class="token string">'user@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">filtername</span><span class="token operator">=</span><span class="token string">'coffee'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riia56a:1" aria-labelledby="tab:Riia56a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riia56a:2" aria-labelledby="tab:Riia56a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riia56a:3" aria-labelledby="tab:Riia56a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjia56a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjia56a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjia56a:0" aria-labelledby="tab:Rjia56a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;disable_filter&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"filtername"</span>: <span class="token string">&quot;coffee&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updated"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Filtering/operation/enable_filter" data-section-id="tag/Email-Filtering/operation/enable_filter" class="sc-dntaoT ceciOs"><div data-section-id="operation/enable_filter" id="operation/enable_filter" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Filtering/operation/enable_filter" aria-label="tag/Email-Filtering/operation/enable_filter"></a>Enable email filter for email account </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function enables an email filter.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables an email filter.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="account" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">account</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">account=username@example.com</span></div><div><div html="&lt;p&gt;The email address that owns the filter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email address that owns the filter.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="filtername" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">filtername</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">filtername=coffee</span></div><div><div html="&lt;p&gt;The filter&amp;#39;s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The filter&#39;s name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/enable_filter</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/enable_filter</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riie56a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riie56a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riie56a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riie56a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riie56a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riie56a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riie56a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riie56a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riie56a:0" aria-labelledby="tab:Riie56a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  enable_filter <span class="token punctuation">\</span>
  <span class="token assign-left variable">account</span><span class="token operator">=</span><span class="token string">'username@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">filtername</span><span class="token operator">=</span><span class="token string">'coffee'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riie56a:1" aria-labelledby="tab:Riie56a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riie56a:2" aria-labelledby="tab:Riie56a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riie56a:3" aria-labelledby="tab:Riie56a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjie56a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjie56a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjie56a:0" aria-labelledby="tab:Rjie56a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;enable_filter&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"filtername"</span>: <span class="token string">&quot;coffee&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updated"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Filtering/operation/get_filter" data-section-id="tag/Email-Filtering/operation/get_filter" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_filter" id="operation/get_filter" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Filtering/operation/get_filter" aria-label="tag/Email-Filtering/operation/get_filter"></a>Return email filter&#x27;s information </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves an email filter&amp;#39;s information.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail&lt;/a&gt; role, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves an email filter&#39;s information.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail</a> role, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="account" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">account</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">account=user@example.com</span></div><div><div html="&lt;p&gt;The email address that owns the filter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email address that owns the filter.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="filtername" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">filtername</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">filtername=coffee</span></div><div><div html="&lt;p&gt;The filter&amp;#39;s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The filter&#39;s name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/get_filter</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/get_filter</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riii56a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riii56a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riii56a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riii56a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riii56a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riii56a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riii56a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riii56a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riii56a:0" aria-labelledby="tab:Riii56a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  get_filter <span class="token punctuation">\</span>
  <span class="token assign-left variable">account</span><span class="token operator">=</span><span class="token string">'user@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">filtername</span><span class="token operator">=</span><span class="token string">'coffee'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riii56a:1" aria-labelledby="tab:Riii56a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riii56a:2" aria-labelledby="tab:Riii56a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riii56a:3" aria-labelledby="tab:Riii56a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjii56a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjii56a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjii56a:0" aria-labelledby="tab:Rjii56a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_filter&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"actions"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"action"</span>: <span class="token string">&quot;deliver&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dest"</span>: <span class="token string">&quot;/dev/null&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"number"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"filtername"</span>: <span class="token string">&quot;coffee&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rules"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"match"</span>: <span class="token string">&quot;contains&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"number"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"opt"</span>: <span class="token string">&quot;or&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"part"</span>: <span class="token string">&quot;$message_body&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"val"</span>: <span class="token string">&quot;coconut&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Filtering/operation/list_filters" data-section-id="tag/Email-Filtering/operation/list_filters" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_filters" id="operation/list_filters" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Filtering/operation/list_filters" aria-label="tag/Email-Filtering/operation/list_filters"></a>Return account-level email filters </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists account-level mail filters. For more information about Exim filters, read &lt;a href=&quot;http://www.exim.org/exim-html-3.30/doc/html/filter.html&quot;&gt;Exim’s documentation&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important&lt;/strong&gt;:&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Mail Receive role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists account-level mail filters. For more information about Exim filters, read <a href="http://www.exim.org/exim-html-3.30/doc/html/filter.html">Exim’s documentation</a>.</p>
<p><strong>Important</strong>:</p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">Mail Receive role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="account" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand account"><span class="property-name">account</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or string</span></div> <div><div html="&lt;p&gt;The email address or cPanel account username for which to return a list of filters. If you do not specify this value, the function lists all of the cPanel account’s account-level filters.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email address or cPanel account username for which to return a list of filters. If you do not specify this value, the function lists all of the cPanel account’s account-level filters.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/list_filters</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/list_filters</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riim56a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riim56a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riim56a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riim56a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riim56a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riim56a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riim56a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riim56a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riim56a:0" aria-labelledby="tab:Riim56a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  list_filters
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riim56a:1" aria-labelledby="tab:Riim56a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riim56a:2" aria-labelledby="tab:Riim56a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riim56a:3" aria-labelledby="tab:Riim56a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjim56a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjim56a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjim56a:0" aria-labelledby="tab:Rjim56a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_filters&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"actions"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"action"</span>: <span class="token string">&quot;string&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dest"</span>: <span class="token string">&quot;/dev/null&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"filtername"</span>: <span class="token string">&quot;coffee&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rules"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"match"</span>: <span class="token string">&quot;contains&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"opt"</span>: <span class="token string">&quot;or&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"part"</span>: <span class="token string">&quot;$message_body&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"val"</span>: <span class="token string">&quot;coconut&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"unescaped"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Filtering/operation/list_filters_backups" data-section-id="tag/Email-Filtering/operation/list_filters_backups" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_filters_backups" id="operation/list_filters_backups" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Filtering/operation/list_filters_backups" aria-label="tag/Email-Filtering/operation/list_filters_backups"></a>Return domains with domain-level email filters </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists all of the cPanel account&amp;#39;s domains that use domain-level filters.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists all of the cPanel account&#39;s domains that use domain-level filters.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/list_filters_backups</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/list_filters_backups</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiq56a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiq56a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiq56a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiq56a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riiq56a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiq56a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riiq56a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiq56a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiq56a:0" aria-labelledby="tab:Riiq56a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  list_filters_backups
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiq56a:1" aria-labelledby="tab:Riiq56a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiq56a:2" aria-labelledby="tab:Riiq56a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiq56a:3" aria-labelledby="tab:Riiq56a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjiq56a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiq56a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiq56a:0" aria-labelledby="tab:Rjiq56a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_filters_backups&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Filtering/operation/list_system_filter_info" data-section-id="tag/Email-Filtering/operation/list_system_filter_info" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_system_filter_info" id="operation/list_system_filter_info" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Filtering/operation/list_system_filter_info" aria-label="tag/Email-Filtering/operation/list_system_filter_info"></a>Return system-level email filter file information </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves a &lt;code&gt;.yaml.gz&lt;/code&gt; file that contains system-level filter information.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a <code>.yaml.gz</code> file that contains system-level filter information.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/list_system_filter_info</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/list_system_filter_info</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiu56a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiu56a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiu56a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiu56a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riiu56a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiu56a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riiu56a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiu56a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiu56a:0" aria-labelledby="tab:Riiu56a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  list_system_filter_info
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiu56a:1" aria-labelledby="tab:Riiu56a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiu56a:2" aria-labelledby="tab:Riiu56a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiu56a:3" aria-labelledby="tab:Riiu56a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjiu56a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiu56a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiu56a:0" aria-labelledby="tab:Rjiu56a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_system_filter_info&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"filter_info"</span>: <span class="token string">&quot;filter_info.username.yaml.gz&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Filtering/operation/reorder_filters" data-section-id="tag/Email-Filtering/operation/reorder_filters" class="sc-dntaoT ceciOs"><div data-section-id="operation/reorder_filters" id="operation/reorder_filters" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Filtering/operation/reorder_filters" aria-label="tag/Email-Filtering/operation/reorder_filters"></a>Update email address&#x27;s email filter order </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function modifies the filter order for an email address. For more information about Exim filters, read &lt;a href=&quot;http://www.exim.org/exim-html-3.30/doc/html/filter.html&quot;&gt;Exim&amp;#39;s documentation&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function modifies the filter order for an email address. For more information about Exim filters, read <a href="http://www.exim.org/exim-html-3.30/doc/html/filter.html">Exim&#39;s documentation</a>.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="filter*" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">filter*</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">filter*=coffee</span></div><div><div html="&lt;p&gt;A mail filter name.&lt;/p&gt;
&lt;p&gt;For each mail filter to reorder, supply a &lt;code&gt;filter*&lt;/code&gt; parameter, where &lt;code&gt;*&lt;/code&gt; is a number that represents the filter&amp;#39;s order.&lt;/p&gt;
&lt;p&gt;For example, to set &lt;code&gt;coffee&lt;/code&gt; as the first email filter and &lt;code&gt;cheesecloth&lt;/code&gt; as the second, set &lt;code&gt;coffee&lt;/code&gt; as the &lt;code&gt;filter1&lt;/code&gt; parameter&amp;#39;s value, and &lt;code&gt;cheesecloth&lt;/code&gt; as the value for the &lt;code&gt;filter2&lt;/code&gt; parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A mail filter name.</p>
<p>For each mail filter to reorder, supply a <code>filter*</code> parameter, where <code>*</code> is a number that represents the filter&#39;s order.</p>
<p>For example, to set <code>coffee</code> as the first email filter and <code>cheesecloth</code> as the second, set <code>coffee</code> as the <code>filter1</code> parameter&#39;s value, and <code>cheesecloth</code> as the value for the <code>filter2</code> parameter.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="mailbox" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">mailbox</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">mailbox=user@example.com</span></div><div><div html="&lt;p&gt;The email address.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email address.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/reorder_filters</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/reorder_filters</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rij256a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rij256a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rij256a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij256a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rij256a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij256a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rij256a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij256a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rij256a:0" aria-labelledby="tab:Rij256a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  reorder_filters <span class="token punctuation">\</span>
  <span class="token assign-left variable">mailbox</span><span class="token operator">=</span><span class="token string">'user@example.com'</span> <span class="token punctuation">\</span>
  filter*<span class="token operator">=</span><span class="token string">'coffee'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij256a:1" aria-labelledby="tab:Rij256a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij256a:2" aria-labelledby="tab:Rij256a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij256a:3" aria-labelledby="tab:Rij256a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjj256a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj256a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj256a:0" aria-labelledby="tab:Rjj256a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;reorder_filters&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Filtering/operation/store_filter" data-section-id="tag/Email-Filtering/operation/store_filter" class="sc-dntaoT ceciOs"><div data-section-id="operation/store_filter" id="operation/store_filter" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Filtering/operation/store_filter" aria-label="tag/Email-Filtering/operation/store_filter"></a>Create email filter </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function creates a new email filter. For more information about Exim filters, read &lt;a href=&quot;http://www.exim.org/exim-html-3.30/doc/html/filter.html&quot;&gt;Exim&amp;#39;s documentation&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
&lt;h3 id=&quot;create-multiple-rules&quot;&gt;Create multiple rules&lt;/h3&gt;
&lt;p&gt;You may create up to 4,096 separate sets of conditions in one filter. To do this, append numbers to the parameter names.&lt;/p&gt;
&lt;p&gt;To create a filter with two sets of actions and conditions, use the following parameters:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;Assign the information for the first filter rule to the &lt;code&gt;action1&lt;/code&gt;, &lt;code&gt;dest1&lt;/code&gt;, &lt;code&gt;match1&lt;/code&gt;, &lt;code&gt;opt1&lt;/code&gt;, &lt;code&gt;part1&lt;/code&gt;, and &lt;code&gt;val1&lt;/code&gt; parameters.&lt;/li&gt;
&lt;li&gt;Assign the information for the second filter rule to the &lt;code&gt;action2&lt;/code&gt;, &lt;code&gt;dest2&lt;/code&gt;, &lt;code&gt;match2&lt;/code&gt;, &lt;code&gt;opt2&lt;/code&gt;, &lt;code&gt;part2&lt;/code&gt;, and &lt;code&gt;val2&lt;/code&gt; parameters.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;To create a filter that uses one set of actions but two sets of conditions, use the following parameters:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;Assign the actions to the &lt;code&gt;action1&lt;/code&gt; and &lt;code&gt;dest1&lt;/code&gt; parameters.&lt;/li&gt;
&lt;li&gt;Assign the first set of conditions to the &lt;code&gt;match1&lt;/code&gt;, &lt;code&gt;opt1&lt;/code&gt;, &lt;code&gt;part1&lt;/code&gt;, and &lt;code&gt;val1&lt;/code&gt; parameters.&lt;/li&gt;
&lt;li&gt;Assign the second set of conditions to the &lt;code&gt;match2&lt;/code&gt;, &lt;code&gt;opt2&lt;/code&gt;, &lt;code&gt;part2&lt;/code&gt;, and &lt;code&gt;val2&lt;/code&gt; parameters.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a new email filter. For more information about Exim filters, read <a href="http://www.exim.org/exim-html-3.30/doc/html/filter.html">Exim&#39;s documentation</a>.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
<h3 id="create-multiple-rules">Create multiple rules</h3>
<p>You may create up to 4,096 separate sets of conditions in one filter. To do this, append numbers to the parameter names.</p>
<p>To create a filter with two sets of actions and conditions, use the following parameters:</p>
<ul>
<li>Assign the information for the first filter rule to the <code>action1</code>, <code>dest1</code>, <code>match1</code>, <code>opt1</code>, <code>part1</code>, and <code>val1</code> parameters.</li>
<li>Assign the information for the second filter rule to the <code>action2</code>, <code>dest2</code>, <code>match2</code>, <code>opt2</code>, <code>part2</code>, and <code>val2</code> parameters.</li>
</ul>
<p>To create a filter that uses one set of actions but two sets of conditions, use the following parameters:</p>
<ul>
<li>Assign the actions to the <code>action1</code> and <code>dest1</code> parameters.</li>
<li>Assign the first set of conditions to the <code>match1</code>, <code>opt1</code>, <code>part1</code>, and <code>val1</code> parameters.</li>
<li>Assign the second set of conditions to the <code>match2</code>, <code>opt2</code>, <code>part2</code>, and <code>val2</code> parameters.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="account" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">account</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">account=user@example.com</span></div><div><div html="&lt;p&gt;The email address, for user-level filters. If you do not use this parameter, the function creates an account-level filter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email address, for user-level filters. If you do not use this parameter, the function creates an account-level filter.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="action*" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand action*"><span class="property-name">action*</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">action*=action1=deliver action2=save</span> - Use multiple filter actions.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">action*=deliver</span> - Use a single filter action.</li></ul><div><div html="&lt;p&gt;The filter&amp;#39;s action.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;deliver&lt;/code&gt; - Deliver the message to the &lt;code&gt;dest*&lt;/code&gt; address.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;fail&lt;/code&gt; - Force a delivery failure.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;finish&lt;/code&gt; - Stop processing the message.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;save&lt;/code&gt; - Save the message to the &lt;code&gt;dest*&lt;/code&gt; file.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;pipe&lt;/code&gt; - Pipe the message to the &lt;code&gt;dest*&lt;/code&gt; application.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;You &lt;strong&gt;must&lt;/strong&gt; increment each action. For example, pass the first action as &lt;code&gt;action1&lt;/code&gt; and the second action as &lt;code&gt;action2&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;This value &lt;strong&gt;requires&lt;/strong&gt; the &lt;code&gt;FileStorage&lt;/code&gt; role. For more information, read our &lt;a href=&quot;https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles&quot;&gt;How to Use Server Profiles&lt;/a&gt; documentation.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The filter&#39;s action.</p>
<ul>
<li><code>deliver</code> - Deliver the message to the <code>dest*</code> address.</li>
<li><code>fail</code> - Force a delivery failure.</li>
<li><code>finish</code> - Stop processing the message.</li>
<li><code>save</code> - Save the message to the <code>dest*</code> file.</li>
<li><code>pipe</code> - Pipe the message to the <code>dest*</code> application.</li>
</ul>
<p><strong>Important:</strong></p>
<ul>
<li>You <strong>must</strong> increment each action. For example, pass the first action as <code>action1</code> and the second action as <code>action2</code>.</li>
<li>This value <strong>requires</strong> the <code>FileStorage</code> role. For more information, read our <a href="https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles">How to Use Server Profiles</a> documentation.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="dest*" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand dest*"><span class="property-name">dest*</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;&quot;</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">dest*=dest1=user@example.com dest2=user2@example.com</span> - Use multiple destinations for filtered mail.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">dest*=user@example.com</span> - Use a single destination for filtered mail.</li></ul><div><div html="&lt;p&gt;The destination for filtered mail.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;This parameter is &lt;strong&gt;required&lt;/strong&gt; if the action value is &lt;code&gt;deliver&lt;/code&gt;, &lt;code&gt;save&lt;/code&gt;, or &lt;code&gt;pipe&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;You &lt;strong&gt;must&lt;/strong&gt; increment each destination. For example, pass the first destination as &lt;code&gt;dest1&lt;/code&gt; and the second destination as &lt;code&gt;dest2&lt;/code&gt;.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The destination for filtered mail.</p>
<p><strong>Important:</strong></p>
<ul>
<li>This parameter is <strong>required</strong> if the action value is <code>deliver</code>, <code>save</code>, or <code>pipe</code>.</li>
<li>You <strong>must</strong> increment each destination. For example, pass the first destination as <code>dest1</code> and the second destination as <code>dest2</code>.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="filtername" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">filtername</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">filtername=coffee</span></div><div><div html="&lt;p&gt;The filter name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The filter name.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="match*" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand match*"><span class="property-name">match*</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">match*=match1=contains match2=matches</span> - Use multiple match types.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">match*=contains</span> - Use a single match type.</li></ul><div><div html="&lt;p&gt;The filter&amp;#39;s &lt;a href=&quot;http://www.exim.org/exim-html-current/doc/html/spec_html/filter_ch-exim_filter_files.html&quot;&gt;match type&lt;/a&gt;.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;If the &lt;code&gt;val*&lt;/code&gt; parameter is a string, use a string operator.&lt;/li&gt;
&lt;li&gt;If the &lt;code&gt;val*&lt;/code&gt; parameter is an integer, use a numeric operator.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;String operators:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;is&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;matches&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;contains&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;does not contain&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;begins&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;does not begin&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;ends&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;does not end&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;does not match&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;Numeric operators:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;is above&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;is not above&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;is below&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;is not below&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; You &lt;strong&gt;must&lt;/strong&gt; increment each match type. For example, pass the first match type as &lt;code&gt;match1&lt;/code&gt; and the second match type as &lt;code&gt;match2&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The filter&#39;s <a href="http://www.exim.org/exim-html-current/doc/html/spec_html/filter_ch-exim_filter_files.html">match type</a>.</p>
<ul>
<li>If the <code>val*</code> parameter is a string, use a string operator.</li>
<li>If the <code>val*</code> parameter is an integer, use a numeric operator.</li>
</ul>
<p>String operators:</p>
<ul>
<li><code>is</code></li>
<li><code>matches</code></li>
<li><code>contains</code></li>
<li><code>does not contain</code></li>
<li><code>begins</code></li>
<li><code>does not begin</code></li>
<li><code>ends</code></li>
<li><code>does not end</code></li>
<li><code>does not match</code></li>
</ul>
<p>Numeric operators:</p>
<ul>
<li><code>is above</code></li>
<li><code>is not above</code></li>
<li><code>is below</code></li>
<li><code>is not below</code></li>
</ul>
<p><strong>Important:</strong></p>
<p> You <strong>must</strong> increment each match type. For example, pass the first match type as <code>match1</code> and the second match type as <code>match2</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="oldfiltername" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">oldfiltername</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">oldfiltername=pool</span></div><div><div html="&lt;p&gt;The name of an existing filter, to rename it. If you do not use this parameter, the function creates a new filter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of an existing filter, to rename it. If you do not use this parameter, the function creates a new filter.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="opt*" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand opt*"><span class="property-name">opt*</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;and&quot;</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">opt*=opt1=and opt2=and</span> - Use multiple connections between conditions.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">opt*=and</span> - Use a single connection between conditions.</li></ul><div><div html="&lt;p&gt;The connection between multiple conditions.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You &lt;strong&gt;must&lt;/strong&gt; increment each connection. For example, pass the first connection as &lt;code&gt;opt1&lt;/code&gt; and the second connection as &lt;code&gt;opt2&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The connection between multiple conditions.</p>
<p><strong>Important:</strong></p>
<p>You <strong>must</strong> increment each connection. For example, pass the first connection as <code>opt1</code> and the second connection as <code>opt2</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="part*" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand part*"><span class="property-name">part*</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">part*=part1=$header_from part2=$message_body</span> - Query multiple email sections.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">part*=$header_from</span> - Query a single email section.</li></ul><div><div html="&lt;p&gt;The email section to query.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;$h_x-Spam-Bar:&lt;/code&gt; - Match against the message&amp;#39;s spam score value, measured in plus(&lt;code&gt;+&lt;/code&gt;) characters.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;$h_x-Spam-Score:&lt;/code&gt; - Match against the message&amp;#39;s spam score value.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;$h_X-Spam-Status:&lt;/code&gt; - Match against whether the system detected the message as spam.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;$h_List-Id:&lt;/code&gt; - Match against the message&amp;#39;s &lt;code&gt;List-ID&lt;/code&gt; header value.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;$header_from:&lt;/code&gt; - Match against the &lt;code&gt;From:&lt;/code&gt; section.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;$header_subject:&lt;/code&gt; - Match against the &lt;code&gt;Subject:&lt;/code&gt; section.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;$header_to:&lt;/code&gt; - Match against the &lt;code&gt;To:&lt;/code&gt; section.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;$reply_address:&lt;/code&gt; - Match against the &lt;code&gt;Reply To:&lt;/code&gt; section.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;$message_body:&lt;/code&gt; - Match against the message&amp;#39;s body.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;$message_headers:&lt;/code&gt; - Match against the message&amp;#39;s headers.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;foranyaddress $h_to:, $h_cc:&lt;/code&gt; - Match against all message recipients.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;not delivered&lt;/code&gt; - Match if the message is not queued for delivery.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;error_message&lt;/code&gt; - Match if the incoming message is bounced.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You &lt;strong&gt;must&lt;/strong&gt; increment each section. For example, pass the first section as &lt;code&gt;part1&lt;/code&gt; and the second section as &lt;code&gt;part2&lt;/code&gt;.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;Generally, the recipient does &lt;strong&gt;not&lt;/strong&gt; receive the &lt;code&gt;BCC&lt;/code&gt; field in an email&amp;#39;s header. For this reason you &lt;strong&gt;cannot&lt;/strong&gt; use the &lt;code&gt;BCC&lt;/code&gt; field in a filter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email section to query.</p>
<ul>
<li><code>$h_x-Spam-Bar:</code> - Match against the message&#39;s spam score value, measured in plus(<code>+</code>) characters.</li>
<li><code>$h_x-Spam-Score:</code> - Match against the message&#39;s spam score value.</li>
<li><code>$h_X-Spam-Status:</code> - Match against whether the system detected the message as spam.</li>
<li><code>$h_List-Id:</code> - Match against the message&#39;s <code>List-ID</code> header value.</li>
<li><code>$header_from:</code> - Match against the <code>From:</code> section.</li>
<li><code>$header_subject:</code> - Match against the <code>Subject:</code> section.</li>
<li><code>$header_to:</code> - Match against the <code>To:</code> section.</li>
<li><code>$reply_address:</code> - Match against the <code>Reply To:</code> section.</li>
<li><code>$message_body:</code> - Match against the message&#39;s body.</li>
<li><code>$message_headers:</code> - Match against the message&#39;s headers.</li>
<li><code>foranyaddress $h_to:, $h_cc:</code> - Match against all message recipients.</li>
<li><code>not delivered</code> - Match if the message is not queued for delivery.</li>
<li><code>error_message</code> - Match if the incoming message is bounced.</li>
</ul>
<p><strong>Important:</strong></p>
<p>You <strong>must</strong> increment each section. For example, pass the first section as <code>part1</code> and the second section as <code>part2</code>.</p>
<p><strong>Note:</strong></p>
<p>Generally, the recipient does <strong>not</strong> receive the <code>BCC</code> field in an email&#39;s header. For this reason you <strong>cannot</strong> use the <code>BCC</code> field in a filter.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="val*" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand val*"><span class="property-name">val*</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or integer</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">val*=val1=coconut val2=12</span> - Match multiple values.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">val*=coconut</span> - Match a single value.</li></ul><div><div html="&lt;p&gt;The value to match.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You &lt;strong&gt;must&lt;/strong&gt; increment each value. For example, pass the first value as &lt;code&gt;val1&lt;/code&gt; and the second value as &lt;code&gt;val2&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The value to match.</p>
<p><strong>Important:</strong></p>
<p>You <strong>must</strong> increment each value. For example, pass the first value as <code>val1</code> and the second value as <code>val2</code>.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/store_filter</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/store_filter</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rij656a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rij656a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rij656a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij656a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rij656a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij656a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rij656a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij656a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rij656a:0" aria-labelledby="tab:Rij656a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  store_filter <span class="token punctuation">\</span>
  <span class="token assign-left variable">filtername</span><span class="token operator">=</span><span class="token string">'coffee'</span> <span class="token punctuation">\</span>
  action*<span class="token operator">=</span><span class="token string">'deliver'</span> <span class="token punctuation">\</span>
  match*<span class="token operator">=</span><span class="token string">'contains'</span> <span class="token punctuation">\</span>
  part*<span class="token operator">=</span><span class="token string">'$header_from'</span> <span class="token punctuation">\</span>
  val*<span class="token operator">=</span><span class="token string">'coconut'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij656a:1" aria-labelledby="tab:Rij656a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij656a:2" aria-labelledby="tab:Rij656a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij656a:3" aria-labelledby="tab:Rij656a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjj656a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj656a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj656a:0" aria-labelledby="tab:Rjj656a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;store_filter&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"account"</span>: <span class="token string">&quot;user@example.com&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Filtering/operation/trace_filter" data-section-id="tag/Email-Filtering/operation/trace_filter" class="sc-dntaoT ceciOs"><div data-section-id="operation/trace_filter" id="operation/trace_filter" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Filtering/operation/trace_filter" aria-label="tag/Email-Filtering/operation/trace_filter"></a>Run test for main domain email filters </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function tests mail filters. The function &lt;strong&gt;only&lt;/strong&gt; tests filters for the cPanel account&amp;#39;s main domain, and only tests against the message&amp;#39;s body. For more information about Exim filters, read &lt;a href=&quot;http://www.exim.org/exim-html-3.30/doc/html/filter.html&quot;&gt;Exim&amp;#39;s documentation&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If the domain or account does not contain a filter file, this function will fail.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail&lt;/a&gt; role, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function tests mail filters. The function <strong>only</strong> tests filters for the cPanel account&#39;s main domain, and only tests against the message&#39;s body. For more information about Exim filters, read <a href="http://www.exim.org/exim-html-3.30/doc/html/filter.html">Exim&#39;s documentation</a>.</p>
<p><strong>Note:</strong></p>
<p>If the domain or account does not contain a filter file, this function will fail.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail</a> role, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="account" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">account</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">account=user@example.com</span></div><div><div html="&lt;p&gt;The email address, to test legacy cPanel filters in the filters directory. If you do not use this parameter, the function tests the main domain&amp;#39;s filters in the &lt;code&gt;/etc/vfilters&lt;/code&gt; directory.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email address, to test legacy cPanel filters in the filters directory. If you do not use this parameter, the function tests the main domain&#39;s filters in the <code>/etc/vfilters</code> directory.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="msg" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">msg</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">msg=Test</span></div><div><div html="&lt;p&gt;The string to test. The function uses this string as the body of an email message, to check whether filters would match the string.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The string to test. The function uses this string as the body of an email message, to check whether filters would match the string.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/trace_filter</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/trace_filter</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rija56a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rija56a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rija56a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rija56a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rija56a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rija56a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rija56a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rija56a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rija56a:0" aria-labelledby="tab:Rija56a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  trace_filter <span class="token punctuation">\</span>
  <span class="token assign-left variable">msg</span><span class="token operator">=</span><span class="token string">'Test'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rija56a:1" aria-labelledby="tab:Rija56a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rija56a:2" aria-labelledby="tab:Rija56a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rija56a:3" aria-labelledby="tab:Rija56a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjja56a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjja56a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjja56a:0" aria-labelledby="tab:Rjja56a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;trace_filter&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"trace"</span>: <span class="token string">&quot;Warning: no message headers read\\nReturn-path copied from sender\\nSender = user@example.com\\nRecipient = user@example.com\\nTesting Exim filter file &amp;quot;/etc/vfilters/example.com&amp;quot;\\n\\nFiltering did not set up a significant delivery.\\n&lt;b&gt;Normal delivery will occur.\\n&lt;/b&gt;&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Filtering/operation/delete_filter" data-section-id="tag/Email-Filtering/operation/delete_filter" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete_filter" id="operation/delete_filter" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Filtering/operation/delete_filter" aria-label="tag/Email-Filtering/operation/delete_filter"></a>Delete email account&#x27;s email filter </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function deletes an email filter.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes an email filter.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="account" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">account</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">account=user@example.com</span></div><div><div html="&lt;p&gt;The email address that owns the filter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email address that owns the filter.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="filtername" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">filtername</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">filtername=coffee</span></div><div><div html="&lt;p&gt;The filter&amp;#39;s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The filter&#39;s name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/delete_filter</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/delete_filter</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rije56a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rije56a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rije56a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rije56a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rije56a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rije56a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rije56a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rije56a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rije56a:0" aria-labelledby="tab:Rije56a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  delete_filter <span class="token punctuation">\</span>
  <span class="token assign-left variable">account</span><span class="token operator">=</span><span class="token string">'user@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">filtername</span><span class="token operator">=</span><span class="token string">'coffee'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rije56a:1" aria-labelledby="tab:Rije56a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rije56a:2" aria-labelledby="tab:Rije56a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rije56a:3" aria-labelledby="tab:Rije56a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjje56a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjje56a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjje56a:0" aria-labelledby="tab:Rjje56a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;delete_filter&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Forwarding" data-section-id="tag/Email-Forwarding" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Forwarding" aria-label="tag/Email-Forwarding"></a>Email Forwarding</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Email / Email Forwarding&lt;/p&gt;
"><p>Email / Email Forwarding</p>
</div></div></div><div id="tag/Email-Forwarding/operation/add_domain_forwarder" data-section-id="tag/Email-Forwarding/operation/add_domain_forwarder" class="sc-dntaoT ceciOs"><div data-section-id="operation/add_domain_forwarder" id="operation/add_domain_forwarder" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Forwarding/operation/add_domain_forwarder" aria-label="tag/Email-Forwarding/operation/add_domain_forwarder"></a>Create domain-level forwarder </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function creates a domain-level forwarder.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a domain-level forwarder.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="destdomain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">destdomain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">destdomain=forwardtome.com</span></div><div><div html="&lt;p&gt;The domain to receive forwarded mail.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain to receive forwarded mail.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The domain on the cPanel account from which to forward mail.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain on the cPanel account from which to forward mail.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/add_domain_forwarder</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/add_domain_forwarder</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rii676a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rii676a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rii676a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii676a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rii676a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii676a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rii676a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii676a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rii676a:0" aria-labelledby="tab:Rii676a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  add_domain_forwarder <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">destdomain</span><span class="token operator">=</span><span class="token string">'forwardtome.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii676a:1" aria-labelledby="tab:Rii676a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii676a:2" aria-labelledby="tab:Rii676a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii676a:3" aria-labelledby="tab:Rii676a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rji676a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rji676a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rji676a:0" aria-labelledby="tab:Rji676a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;add_domain_forwarder&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token string">&quot;File updated \&quot;/etc/vdomainaliases/example.com\&quot;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Forwarding/operation/add_forwarder" data-section-id="tag/Email-Forwarding/operation/add_forwarder" class="sc-dntaoT ceciOs"><div data-section-id="operation/add_forwarder" id="operation/add_forwarder" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Forwarding/operation/add_forwarder" aria-label="tag/Email-Forwarding/operation/add_forwarder"></a>Create email account forwarder </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function creates an email forwarder.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the MailReceive role, the system disables this function. 
  For more information, read our &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles&quot;&gt;How to Use Server Profiles&lt;/a&gt; 
  documentation.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates an email forwarder.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the MailReceive role, the system disables this function. 
  For more information, read our <a href="https://go.cpanel.net/howtouseserverprofiles">How to Use Server Profiles</a> 
  documentation.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=forwardme@example.com</span></div><div><div html="&lt;p&gt;The email address to forward.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email address to forward.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="failmsgs" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">failmsgs</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;No such person at this address&quot;</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">failmsgs=Nobody home.</span></div><div><div html="&lt;p&gt;The failure message for the message&amp;#39;s sender.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; Use this parameter if you used the fail method for the fwdopt parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The failure message for the message&#39;s sender.</p>
<p><strong>Note:</strong></p>
<p> Use this parameter if you used the fail method for the fwdopt parameter.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="fwdemail" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">fwdemail</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">fwdemail=fwdtome@example.com</span></div><div><div html="&lt;p&gt;The email address to which the system forwards messages.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; You must use this parameter if you used the fwd method for the fwdopt parameter. You can pass multiple addresses to this parameter as a comma-separated list.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email address to which the system forwards messages.</p>
<p><strong>Note:</strong></p>
<p> You must use this parameter if you used the fwd method for the fwdopt parameter. You can pass multiple addresses to this parameter as a comma-separated list.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="fwdopt" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">fwdopt</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">fwdopt=fwd</span></div><div><div html="&lt;p&gt;The method to use to handle the email address&amp;#39;s mail.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The method to use to handle the email address&#39;s mail.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="fwdsystem" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">fwdsystem</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">fwdsystem=user</span></div><div><div html="&lt;p&gt;The system user to whom the system forwards messages.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; You must use this parameter if you used the system method for the fwdopt parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The system user to whom the system forwards messages.</p>
<p><strong>Note:</strong></p>
<p> You must use this parameter if you used the system method for the fwdopt parameter.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="pipefwd" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">pipefwd</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">pipefwd=mailscript.pl</span></div><div><div html="&lt;p&gt;The application to which the system pipes messages.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; You must use this parameter if you used the pipe method for the fwdopt parameter.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  This parameter requires the FileStorage role. For more information, read our 
  &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles&quot;&gt;How to Use Server Profiles&lt;/a&gt; documentation.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The application to which the system pipes messages.</p>
<p><strong>Note:</strong></p>
<p> You must use this parameter if you used the pipe method for the fwdopt parameter.</p>
<p><strong>Important:</strong></p>
<p>  This parameter requires the FileStorage role. For more information, read our 
  <a href="https://go.cpanel.net/howtouseserverprofiles">How to Use Server Profiles</a> documentation.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/add_forwarder</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/add_forwarder</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riia76a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riia76a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riia76a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riia76a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riia76a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riia76a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riia76a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riia76a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riia76a:0" aria-labelledby="tab:Riia76a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  add_forwarder <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'forwardme@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">fwdopt</span><span class="token operator">=</span><span class="token string">'fwd'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riia76a:1" aria-labelledby="tab:Riia76a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riia76a:2" aria-labelledby="tab:Riia76a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riia76a:3" aria-labelledby="tab:Riia76a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjia76a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjia76a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjia76a:0" aria-labelledby="tab:Rjia76a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;add_forwarder&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"forward"</span>: <span class="token string">&quot;fwdtome@example.com&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Forwarding/operation/delete_domain_forwarder" data-section-id="tag/Email-Forwarding/operation/delete_domain_forwarder" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete_domain_forwarder" id="operation/delete_domain_forwarder" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Forwarding/operation/delete_domain_forwarder" aria-label="tag/Email-Forwarding/operation/delete_domain_forwarder"></a>Delete domain-level forwarder </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function deletes a domain-level forwarder.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes a domain-level forwarder.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The domain name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/delete_domain_forwarder</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/delete_domain_forwarder</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riie76a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riie76a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riie76a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riie76a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riie76a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riie76a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riie76a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riie76a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riie76a:0" aria-labelledby="tab:Riie76a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  delete_domain_forwarder <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riie76a:1" aria-labelledby="tab:Riie76a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riie76a:2" aria-labelledby="tab:Riie76a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riie76a:3" aria-labelledby="tab:Riie76a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjie76a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjie76a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjie76a:0" aria-labelledby="tab:Rjie76a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;delete_domain_forwarder&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Forwarding/operation/count_forwarders" data-section-id="tag/Email-Forwarding/operation/count_forwarders" class="sc-dntaoT ceciOs"><div data-section-id="operation/count_forwarders" id="operation/count_forwarders" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Forwarding/operation/count_forwarders" aria-label="tag/Email-Forwarding/operation/count_forwarders"></a>Return cPanel account&#x27;s mail forwarder total </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the number of &lt;a href=&quot;https://go.cpanel.net/Forwarders&quot;&gt;forwarders&lt;/a&gt; for every email address on a cPanel account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles#roles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the number of <a href="https://go.cpanel.net/Forwarders">forwarders</a> for every email address on a cPanel account.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles#roles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/count_forwarders</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/count_forwarders</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riii76a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riii76a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riii76a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riii76a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riii76a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riii76a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riii76a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riii76a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riii76a:0" aria-labelledby="tab:Riii76a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  count_forwarders
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riii76a:1" aria-labelledby="tab:Riii76a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riii76a:2" aria-labelledby="tab:Riii76a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riii76a:3" aria-labelledby="tab:Riii76a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjii76a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjii76a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjii76a:0" aria-labelledby="tab:Rjii76a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;count_forwarders&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Forwarding/operation/delete_forwarder" data-section-id="tag/Email-Forwarding/operation/delete_forwarder" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete_forwarder" id="operation/delete_forwarder" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Forwarding/operation/delete_forwarder" aria-label="tag/Email-Forwarding/operation/delete_forwarder"></a>Delete email account&#x27;s email forwarder </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function deletes an email forwarder.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes an email forwarder.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="address" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">address</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">address=user@example.com</span></div><div><div html="&lt;p&gt;The forwarder&amp;#39;s email address.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The forwarder&#39;s email address.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="forwarder" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">forwarder</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">forwarder=fwdtome@example.com</span></div><div><div html="&lt;p&gt;The forwarder&amp;#39;s destination.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;A valid email address.&lt;/li&gt;
&lt;li&gt;A script location.&lt;/li&gt;
&lt;li&gt;A system account.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The forwarder&#39;s destination.</p>
<ul>
<li>A valid email address.</li>
<li>A script location.</li>
<li>A system account.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/delete_forwarder</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/delete_forwarder</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riim76a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riim76a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riim76a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riim76a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riim76a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riim76a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riim76a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riim76a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riim76a:0" aria-labelledby="tab:Riim76a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  delete_forwarder <span class="token punctuation">\</span>
  <span class="token assign-left variable">address</span><span class="token operator">=</span><span class="token string">'user@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">forwarder</span><span class="token operator">=</span><span class="token string">'fwdtome@example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riim76a:1" aria-labelledby="tab:Riim76a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riim76a:2" aria-labelledby="tab:Riim76a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riim76a:3" aria-labelledby="tab:Riim76a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjim76a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjim76a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjim76a:0" aria-labelledby="tab:Rjim76a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;delete_forwarder&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Forwarding/operation/list_domain_forwarders" data-section-id="tag/Email-Forwarding/operation/list_domain_forwarders" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_domain_forwarders" id="operation/list_domain_forwarders" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Forwarding/operation/list_domain_forwarders" aria-label="tag/Email-Forwarding/operation/list_domain_forwarders"></a>Return domain-level forwarders </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists domain-level forwarders.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists domain-level forwarders.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The domain name to query. If you do not use this parameter, the function returns all domain-level forwarders on the cPanel account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain name to query. If you do not use this parameter, the function returns all domain-level forwarders on the cPanel account.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/list_domain_forwarders</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/list_domain_forwarders</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiq76a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiq76a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiq76a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiq76a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riiq76a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiq76a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riiq76a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiq76a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiq76a:0" aria-labelledby="tab:Riiq76a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  list_domain_forwarders
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiq76a:1" aria-labelledby="tab:Riiq76a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiq76a:2" aria-labelledby="tab:Riiq76a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiq76a:3" aria-labelledby="tab:Riiq76a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjiq76a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiq76a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiq76a:0" aria-labelledby="tab:Rjiq76a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_domain_forwarders&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dest"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"forward"</span>: <span class="token string">&quot;forwardtome.com&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Forwarding/operation/list_forwarders" data-section-id="tag/Email-Forwarding/operation/list_forwarders" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_forwarders" id="operation/list_forwarders" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Forwarding/operation/list_forwarders" aria-label="tag/Email-Forwarding/operation/list_forwarders"></a>Return domain&#x27;s forwarders </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists a domain&amp;#39;s forwarders.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists a domain&#39;s forwarders.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="regex" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">regex</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">regex=user</span></div><div><div html="&lt;p&gt;A &lt;a href=&quot;https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions&quot;&gt;Perl Compatible Regular Expression (PCRE)&lt;/a&gt; that filters the results. If you do &lt;strong&gt;not&lt;/strong&gt; use this parameter, the function returns results for all of the account&amp;#39;s filters.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A <a href="https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions">Perl Compatible Regular Expression (PCRE)</a> that filters the results. If you do <strong>not</strong> use this parameter, the function returns results for all of the account&#39;s filters.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/list_forwarders</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/list_forwarders</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiu76a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiu76a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiu76a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiu76a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riiu76a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiu76a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riiu76a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiu76a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiu76a:0" aria-labelledby="tab:Riiu76a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  list_forwarders <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiu76a:1" aria-labelledby="tab:Riiu76a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiu76a:2" aria-labelledby="tab:Riiu76a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiu76a:3" aria-labelledby="tab:Riiu76a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjiu76a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiu76a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiu76a:0" aria-labelledby="tab:Rjiu76a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_forwarders&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dest"</span>: <span class="token string">&quot;forwarded@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"forward"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"html_dest"</span>: <span class="token string">&quot;forwarded@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"html_forward"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"uri_dest"</span>: <span class="token string">&quot;forwarded%40example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"uri_forward"</span>: <span class="token string">&quot;user%40example.com&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Forwarding/operation/list_forwarders_backups" data-section-id="tag/Email-Forwarding/operation/list_forwarders_backups" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_forwarders_backups" id="operation/list_forwarders_backups" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Forwarding/operation/list_forwarders_backups" aria-label="tag/Email-Forwarding/operation/list_forwarders_backups"></a>Return domains with domain-level forwarders </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the domains with domain-level forwarders.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the domains with domain-level forwarders.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/list_forwarders_backups</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/list_forwarders_backups</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rij276a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rij276a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rij276a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij276a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rij276a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij276a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rij276a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij276a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rij276a:0" aria-labelledby="tab:Rij276a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  list_forwarders_backups
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij276a:1" aria-labelledby="tab:Rij276a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij276a:2" aria-labelledby="tab:Rij276a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij276a:3" aria-labelledby="tab:Rij276a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjj276a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj276a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj276a:0" aria-labelledby="tab:Rjj276a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_forwarders_backups&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Server-Information" data-section-id="tag/Email-Server-Information" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Server-Information" aria-label="tag/Email-Server-Information"></a>Email Server Information</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Email / Email Server Information.&lt;/p&gt;
"><p>Email / Email Server Information.</p>
</div></div></div><div id="tag/Email-Server-Information/operation/check_fastmail" data-section-id="tag/Email-Server-Information/operation/check_fastmail" class="sc-dntaoT ceciOs"><div data-section-id="operation/check_fastmail" id="operation/check_fastmail" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Server-Information/operation/check_fastmail" aria-label="tag/Email-Server-Information/operation/check_fastmail"></a>Return BlackBerry FastMail support status </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function checks whether &lt;a href=&quot;https://go.cpanel.net/blackberryfastmail&quot;&gt;BlackBerry® FastMail&lt;/a&gt; support is enabled.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles#roles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether <a href="https://go.cpanel.net/blackberryfastmail">BlackBerry® FastMail</a> support is enabled.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles#roles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/check_fastmail</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/check_fastmail</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rii696a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rii696a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rii696a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii696a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rii696a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii696a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rii696a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii696a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rii696a:0" aria-labelledby="tab:Rii696a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  check_fastmail
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii696a:1" aria-labelledby="tab:Rii696a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii696a:2" aria-labelledby="tab:Rii696a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii696a:3" aria-labelledby="tab:Rii696a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rji696a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rji696a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rji696a:0" aria-labelledby="tab:Rji696a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;check_fastmail&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token string">&quot;2&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Server-Information/operation/disable_mailbox_autocreate" data-section-id="tag/Email-Server-Information/operation/disable_mailbox_autocreate" class="sc-dntaoT ceciOs"><div data-section-id="operation/disable_mailbox_autocreate" id="operation/disable_mailbox_autocreate" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Server-Information/operation/disable_mailbox_autocreate" aria-label="tag/Email-Server-Information/operation/disable_mailbox_autocreate"></a>Disable cPanel account mailbox autocreation </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function disables the system&amp;#39;s ability to automatically create mailboxes for a cPanel account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you &lt;strong&gt;enable&lt;/strong&gt; the UAPI&amp;#39;s &lt;code&gt;Email::enable_mailbox_autocreate&lt;/code&gt; function, the system automatically creates mailboxes. The system creates a new mailbox when it receives an email address in &lt;a href=&quot;https://en.wikipedia.org/wiki/Email_address#Sub-addressing&quot;&gt;plus address format&lt;/a&gt; and that mailbox does &lt;strong&gt;not&lt;/strong&gt; exist. For example, receiving an email from the &lt;code&gt;user+newmailbox@example.com&lt;/code&gt; address creates the &lt;code&gt;newmailbox&lt;/code&gt; mailbox if the &lt;code&gt;newmailbox&lt;/code&gt; mailbox does not exist.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables the system&#39;s ability to automatically create mailboxes for a cPanel account.</p>
<p><strong>Note:</strong></p>
<p>  When you <strong>enable</strong> the UAPI&#39;s <code>Email::enable_mailbox_autocreate</code> function, the system automatically creates mailboxes. The system creates a new mailbox when it receives an email address in <a href="https://en.wikipedia.org/wiki/Email_address#Sub-addressing">plus address format</a> and that mailbox does <strong>not</strong> exist. For example, receiving an email from the <code>user+newmailbox@example.com</code> address creates the <code>newmailbox</code> mailbox if the <code>newmailbox</code> mailbox does not exist.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=username@example.com</span></div><div><div html="&lt;p&gt;The email account address for which to disable mailbox autocreation.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account address for which to disable mailbox autocreation.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/disable_mailbox_autocreate</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/disable_mailbox_autocreate</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riia96a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riia96a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riia96a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riia96a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riia96a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riia96a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riia96a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riia96a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riia96a:0" aria-labelledby="tab:Riia96a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  disable_mailbox_autocreate <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'username@example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riia96a:1" aria-labelledby="tab:Riia96a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riia96a:2" aria-labelledby="tab:Riia96a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riia96a:3" aria-labelledby="tab:Riia96a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjia96a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjia96a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjia96a:0" aria-labelledby="tab:Rjia96a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;disable_mailbox_autocreate&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Server-Information/operation/enable_mailbox_autocreate" data-section-id="tag/Email-Server-Information/operation/enable_mailbox_autocreate" class="sc-dntaoT ceciOs"><div data-section-id="operation/enable_mailbox_autocreate" id="operation/enable_mailbox_autocreate" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Server-Information/operation/enable_mailbox_autocreate" aria-label="tag/Email-Server-Information/operation/enable_mailbox_autocreate"></a>Enable cPanel account mailbox autocreation </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function allows the system to automatically create mailboxes for a cPanel account. The system will create a new mailbox when it receives an email address in plus address format and that mailbox does not exist. For example, receiving an email from the &lt;a href=&quot;mailto:&amp;#x75;&amp;#x73;&amp;#101;&amp;#x72;&amp;#x2b;&amp;#x6e;&amp;#101;&amp;#x77;&amp;#x6d;&amp;#x61;&amp;#x69;&amp;#108;&amp;#98;&amp;#111;&amp;#120;&amp;#x40;&amp;#101;&amp;#x78;&amp;#x61;&amp;#109;&amp;#x70;&amp;#x6c;&amp;#x65;&amp;#46;&amp;#99;&amp;#111;&amp;#109;&quot;&gt;&amp;#x75;&amp;#x73;&amp;#101;&amp;#x72;&amp;#x2b;&amp;#x6e;&amp;#101;&amp;#x77;&amp;#x6d;&amp;#x61;&amp;#x69;&amp;#108;&amp;#98;&amp;#111;&amp;#120;&amp;#x40;&amp;#101;&amp;#x78;&amp;#x61;&amp;#109;&amp;#x70;&amp;#x6c;&amp;#x65;&amp;#46;&amp;#99;&amp;#111;&amp;#109;&lt;/a&gt; address creates the newmailbox mailbox if the newmailbox mailbox does not exist.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  To disable this functionality, use the UAPI Email::disable_mailbox_autocreate function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function allows the system to automatically create mailboxes for a cPanel account. The system will create a new mailbox when it receives an email address in plus address format and that mailbox does not exist. For example, receiving an email from the <a href="mailto:&#x75;&#x73;&#101;&#x72;&#x2b;&#x6e;&#101;&#x77;&#x6d;&#x61;&#x69;&#108;&#98;&#111;&#120;&#x40;&#101;&#x78;&#x61;&#109;&#x70;&#x6c;&#x65;&#46;&#99;&#111;&#109;">&#x75;&#x73;&#101;&#x72;&#x2b;&#x6e;&#101;&#x77;&#x6d;&#x61;&#x69;&#108;&#98;&#111;&#120;&#x40;&#101;&#x78;&#x61;&#109;&#x70;&#x6c;&#x65;&#46;&#99;&#111;&#109;</a> address creates the newmailbox mailbox if the newmailbox mailbox does not exist.</p>
<p><strong>Note:</strong></p>
<p>  To disable this functionality, use the UAPI Email::disable_mailbox_autocreate function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=username@example.com</span></div><div><div html="&lt;p&gt;The email account for which to enable mailbox autocreation.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account for which to enable mailbox autocreation.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/enable_mailbox_autocreate</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/enable_mailbox_autocreate</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riie96a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riie96a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riie96a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riie96a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riie96a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riie96a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riie96a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riie96a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riie96a:0" aria-labelledby="tab:Riie96a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  enable_mailbox_autocreate <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'username@example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riie96a:1" aria-labelledby="tab:Riie96a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riie96a:2" aria-labelledby="tab:Riie96a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riie96a:3" aria-labelledby="tab:Riie96a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjie96a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjie96a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjie96a:0" aria-labelledby="tab:Rjie96a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;enable_mailbox_autocreate&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Server-Information/operation/fetch_charmaps" data-section-id="tag/Email-Server-Information/operation/fetch_charmaps" class="sc-dntaoT ceciOs"><div data-section-id="operation/fetch_charmaps" id="operation/fetch_charmaps" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Server-Information/operation/fetch_charmaps" aria-label="tag/Email-Server-Information/operation/fetch_charmaps"></a>Return server&#x27;s supported character encodings </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the available character encodings.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the available character encodings.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/fetch_charmaps</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/fetch_charmaps</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riii96a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riii96a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riii96a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riii96a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riii96a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riii96a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riii96a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riii96a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riii96a:0" aria-labelledby="tab:Riii96a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  fetch_charmaps
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riii96a:1" aria-labelledby="tab:Riii96a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riii96a:2" aria-labelledby="tab:Riii96a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riii96a:3" aria-labelledby="tab:Riii96a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjii96a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjii96a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjii96a:0" aria-labelledby="tab:Rjii96a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;fetch_charmaps&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"map"</span>: <span class="token string">&quot;utf-8&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Server-Information/operation/fts_rescan_mailbox" data-section-id="tag/Email-Server-Information/operation/fts_rescan_mailbox" class="sc-dntaoT ceciOs"><div data-section-id="operation/fts_rescan_mailbox" id="operation/fts_rescan_mailbox" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Server-Information/operation/fts_rescan_mailbox" aria-label="tag/Email-Server-Information/operation/fts_rescan_mailbox"></a>Start IMAP Full-Text Search scan for email account </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function requests that the IMAP Full-Text Search Indexing (powered by Apache Solr™) plugin rescan an email account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To enable this function, you &lt;strong&gt;must&lt;/strong&gt; install the &lt;em&gt;IMAP Full-Text Search Indexing (powered by Apache Solr™)&lt;/em&gt; plugin in WHM&amp;#39;s &lt;a href=&quot;https://go.cpanel.net/whmdocsManagePlugins&quot;&gt;&lt;em&gt;Manage Plugins&lt;/em&gt;&lt;/a&gt; interface (&lt;em&gt;WHM &amp;gt;&amp;gt; Home &amp;gt;&amp;gt; cPanel &amp;gt;&amp;gt; Manage Plugins&lt;/em&gt;). For more information, read our &lt;a href=&quot;https://go.cpanel.net/installdovecotftsscript&quot;&gt;install_dovecot_fts script&lt;/a&gt; documentation.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail role&lt;/a&gt;, the system disables this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function requests that the IMAP Full-Text Search Indexing (powered by Apache Solr™) plugin rescan an email account.</p>
<p><strong>Note:</strong></p>
<p>To enable this function, you <strong>must</strong> install the <em>IMAP Full-Text Search Indexing (powered by Apache Solr™)</em> plugin in WHM&#39;s <a href="https://go.cpanel.net/whmdocsManagePlugins"><em>Manage Plugins</em></a> interface (<em>WHM &gt;&gt; Home &gt;&gt; cPanel &gt;&gt; Manage Plugins</em>). For more information, read our <a href="https://go.cpanel.net/installdovecotftsscript">install_dovecot_fts script</a> documentation.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail role</a>, the system disables this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="account" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">account</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">account=username@example.com</span></div><div><div html="&lt;p&gt;The email user&amp;#39;s account name.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If you do not enter an email address, the function rescans the default email account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email user&#39;s account name.</p>
<p><strong>Note:</strong></p>
<p>If you do not enter an email address, the function rescans the default email account.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/fts_rescan_mailbox</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/fts_rescan_mailbox</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riim96a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riim96a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riim96a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riim96a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riim96a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riim96a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riim96a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riim96a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riim96a:0" aria-labelledby="tab:Riim96a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  fts_rescan_mailbox <span class="token punctuation">\</span>
  <span class="token assign-left variable">account</span><span class="token operator">=</span><span class="token string">'username@example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riim96a:1" aria-labelledby="tab:Riim96a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riim96a:2" aria-labelledby="tab:Riim96a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riim96a:3" aria-labelledby="tab:Riim96a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjim96a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjim96a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjim96a:0" aria-labelledby="tab:Rjim96a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;fts_rescan_mailbox&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Server-Information/operation/get_charsets" data-section-id="tag/Email-Server-Information/operation/get_charsets" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_charsets" id="operation/get_charsets" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Server-Information/operation/get_charsets" aria-label="tag/Email-Server-Information/operation/get_charsets"></a>Return mail server&#x27;s supported character encodings </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists character encodings that the mail server supports.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists character encodings that the mail server supports.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/get_charsets</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/get_charsets</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiq96a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiq96a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiq96a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiq96a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riiq96a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiq96a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riiq96a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiq96a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiq96a:0" aria-labelledby="tab:Riiq96a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  get_charsets
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiq96a:1" aria-labelledby="tab:Riiq96a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiq96a:2" aria-labelledby="tab:Riiq96a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiq96a:3" aria-labelledby="tab:Riiq96a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjiq96a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiq96a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiq96a:0" aria-labelledby="tab:Rjiq96a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_charsets&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;utf-8&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Server-Information/operation/get_mailbox_autocreate" data-section-id="tag/Email-Server-Information/operation/get_mailbox_autocreate" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_mailbox_autocreate" id="operation/get_mailbox_autocreate" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Server-Information/operation/get_mailbox_autocreate" aria-label="tag/Email-Server-Information/operation/get_mailbox_autocreate"></a>Return cPanel account&#x27;s mailbox autocreate status </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function checks whether a cPanel account will automatically create mailboxes when it receives an email address in &lt;a href=&quot;https://en.wikipedia.org/wiki/Email_address#Sub-addressing&quot;&gt;plus address format&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To enable or disable this functionality, use the UAPI&amp;#39;s &lt;code&gt;Email::enable_mailbox_autocreate&lt;/code&gt; and &lt;code&gt;Email::disable_mailbox_autocreate&lt;/code&gt; functions.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether a cPanel account will automatically create mailboxes when it receives an email address in <a href="https://en.wikipedia.org/wiki/Email_address#Sub-addressing">plus address format</a>.</p>
<p><strong>Note:</strong></p>
<p>To enable or disable this functionality, use the UAPI&#39;s <code>Email::enable_mailbox_autocreate</code> and <code>Email::disable_mailbox_autocreate</code> functions.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=username@example.com</span></div><div><div html="&lt;p&gt;The email account address to query.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account address to query.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/get_mailbox_autocreate</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/get_mailbox_autocreate</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiu96a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiu96a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiu96a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiu96a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riiu96a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiu96a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riiu96a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiu96a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiu96a:0" aria-labelledby="tab:Riiu96a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  get_mailbox_autocreate <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'username@example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiu96a:1" aria-labelledby="tab:Riiu96a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiu96a:2" aria-labelledby="tab:Riiu96a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiu96a:3" aria-labelledby="tab:Riiu96a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjiu96a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiu96a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiu96a:0" aria-labelledby="tab:Rjiu96a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_mailbox_autocreate&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Server-Information/operation/has_plaintext_authentication" data-section-id="tag/Email-Server-Information/operation/has_plaintext_authentication" class="sc-dntaoT ceciOs"><div data-section-id="operation/has_plaintext_authentication" id="operation/has_plaintext_authentication" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Server-Information/operation/has_plaintext_authentication" aria-label="tag/Email-Server-Information/operation/has_plaintext_authentication"></a>Return whether plaintext authentication is enabled </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function checks whether plaintext authentication is enabled on the Dovecot mail server.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether plaintext authentication is enabled on the Dovecot mail server.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/has_plaintext_authentication</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/has_plaintext_authentication</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rij296a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rij296a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rij296a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij296a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rij296a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij296a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rij296a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij296a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rij296a:0" aria-labelledby="tab:Rij296a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  has_plaintext_authentication
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij296a:1" aria-labelledby="tab:Rij296a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij296a:2" aria-labelledby="tab:Rij296a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij296a:3" aria-labelledby="tab:Rij296a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjj296a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj296a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj296a:0" aria-labelledby="tab:Rjj296a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;has_plaintext_authentication&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Server-Information/operation/set_always_accept" data-section-id="tag/Email-Server-Information/operation/set_always_accept" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_always_accept" id="operation/set_always_accept" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Server-Information/operation/set_always_accept" aria-label="tag/Email-Server-Information/operation/set_always_accept"></a>Update Mail Exchanger type </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function sets the Mail Exchanger (MX) type.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  This function &lt;strong&gt;only&lt;/strong&gt; affects the cPanel configuration. You &lt;strong&gt;must&lt;/strong&gt; configure the mail exchanger&amp;#39;s DNS entry separately.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;DNS role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets the Mail Exchanger (MX) type.</p>
<p><strong>Note:</strong></p>
<p>  This function <strong>only</strong> affects the cPanel configuration. You <strong>must</strong> configure the mail exchanger&#39;s DNS entry separately.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles">DNS role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="alwaysaccept" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">alwaysaccept</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;auto&quot;</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;auto&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;local&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;secondary&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;remote&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">alwaysaccept=auto</span></div><div><div html="&lt;p&gt;The mail exchanger type.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;auto&lt;/code&gt; — Allow cPanel to determine the appropriate role.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;local&lt;/code&gt; — Always accept the domain&amp;#39;s mail.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;secondary&lt;/code&gt; — Accept mail until a higher priority mail server is available.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;remote&lt;/code&gt; — Do &lt;strong&gt;not&lt;/strong&gt; accept mail.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This parameter is redundant with the &lt;code&gt;mxcheck&lt;/code&gt; parameter. Do &lt;strong&gt;not&lt;/strong&gt; enter the &lt;code&gt;mxcheck&lt;/code&gt; and &lt;code&gt;alwaysaccept&lt;/code&gt;
parameters at the same time. &lt;a href=&quot;https://en.wikipedia.org/wiki/Undefined_behavior&quot;&gt;Undefined behavior&lt;/a&gt; may occur if this
happens.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mail exchanger type.</p>
<ul>
<li><code>auto</code> — Allow cPanel to determine the appropriate role.</li>
<li><code>local</code> — Always accept the domain&#39;s mail.</li>
<li><code>secondary</code> — Accept mail until a higher priority mail server is available.</li>
<li><code>remote</code> — Do <strong>not</strong> accept mail.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This parameter is redundant with the <code>mxcheck</code> parameter. Do <strong>not</strong> enter the <code>mxcheck</code> and <code>alwaysaccept</code>
parameters at the same time. <a href="https://en.wikipedia.org/wiki/Undefined_behavior">Undefined behavior</a> may occur if this
happens.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The mail exchanger&amp;#39;s domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mail exchanger&#39;s domain.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="mxcheck" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">mxcheck</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;auto&quot;</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;auto&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;local&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;secondary&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;remote&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">mxcheck=auto</span></div><div><div html="&lt;p&gt;The mail exchanger type.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;auto&lt;/code&gt; — Allow cPanel to determine the appropriate role.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;local&lt;/code&gt; — Always accept the domain&amp;#39;s mail.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;secondary&lt;/code&gt; — Accept mail until a higher priority mail server is available.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;remote&lt;/code&gt; — Do &lt;strong&gt;not&lt;/strong&gt; accept mail.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This parameter is redundant with the &lt;code&gt;alwaysaccept&lt;/code&gt; parameter. Do &lt;strong&gt;not&lt;/strong&gt; enter the &lt;code&gt;mxcheck&lt;/code&gt; and &lt;code&gt;alwaysaccept&lt;/code&gt;
parameters at the same time. &lt;a href=&quot;https://en.wikipedia.org/wiki/Undefined_behavior&quot;&gt;Undefined behavior&lt;/a&gt; may occur if this
happens.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mail exchanger type.</p>
<ul>
<li><code>auto</code> — Allow cPanel to determine the appropriate role.</li>
<li><code>local</code> — Always accept the domain&#39;s mail.</li>
<li><code>secondary</code> — Accept mail until a higher priority mail server is available.</li>
<li><code>remote</code> — Do <strong>not</strong> accept mail.</li>
</ul>
<p><strong>Note:</strong></p>
<p>This parameter is redundant with the <code>alwaysaccept</code> parameter. Do <strong>not</strong> enter the <code>mxcheck</code> and <code>alwaysaccept</code>
parameters at the same time. <a href="https://en.wikipedia.org/wiki/Undefined_behavior">Undefined behavior</a> may occur if this
happens.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/set_always_accept</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/set_always_accept</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rij696a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rij696a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rij696a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij696a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rij696a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij696a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rij696a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij696a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rij696a:0" aria-labelledby="tab:Rij696a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  set_always_accept <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij696a:1" aria-labelledby="tab:Rij696a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij696a:2" aria-labelledby="tab:Rij696a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij696a:3" aria-labelledby="tab:Rij696a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjj696a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj696a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj696a:0" aria-labelledby="tab:Rjj696a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_always_accept&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"checkmx"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"changed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"detected"</span>: <span class="token string">&quot;auto&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"isprimary"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issecondary"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"local"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mxcheck"</span>: <span class="token string">&quot;auto&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"remote"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"secondary"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;Auto Detect of MX configuration not possible due to non-resolving MX entries. Defaulting to last known setting: local.&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"detected"</span>: <span class="token string">&quot;auto&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"local"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mxcheck"</span>: <span class="token string">&quot;auto&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"remote"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"results"</span>: <span class="token string">&quot;Set Always Accept Status to: local&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"secondary"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"statusmsg"</span>: <span class="token string">&quot;Set Always Accept Status to: local&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Server-Information/operation/stats_db_status" data-section-id="tag/Email-Server-Information/operation/stats_db_status" class="sc-dntaoT ceciOs"><div data-section-id="operation/stats_db_status" id="operation/stats_db_status" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Server-Information/operation/stats_db_status" aria-label="tag/Email-Server-Information/operation/stats_db_status"></a>Return eximstats SQLite database status </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the status of the eximstats SQLite Database.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the status of the eximstats SQLite Database.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/stats_db_status</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/stats_db_status</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rija96a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rija96a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rija96a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rija96a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rija96a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rija96a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rija96a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rija96a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rija96a:0" aria-labelledby="tab:Rija96a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  stats_db_status
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rija96a:1" aria-labelledby="tab:Rija96a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rija96a:2" aria-labelledby="tab:Rija96a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rija96a:3" aria-labelledby="tab:Rija96a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjja96a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjja96a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjja96a:0" aria-labelledby="tab:Rjja96a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;stats_db_status&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token string">&quot;active&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Suspensions" data-section-id="tag/Email-Suspensions" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Suspensions" aria-label="tag/Email-Suspensions"></a>Email Suspensions</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Email / Email Suspensions&lt;/p&gt;
"><p>Email / Email Suspensions</p>
</div></div></div><div id="tag/Email-Suspensions/operation/suspend_incoming" data-section-id="tag/Email-Suspensions/operation/suspend_incoming" class="sc-dntaoT ceciOs"><div data-section-id="operation/suspend_incoming" id="operation/suspend_incoming" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Suspensions/operation/suspend_incoming" aria-label="tag/Email-Suspensions/operation/suspend_incoming"></a>Suspend email account incoming (SMTP) mail </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function suspends incoming email for an account. The system will reject incoming email while the account is suspended.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Notes:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;The user can still log in to the email account. To suspend a user&amp;#39;s ability to log in to, send mail from, and read their account, use the UAPI &lt;code&gt;Email::suspend_login&lt;/code&gt; function.&lt;/li&gt;
&lt;li&gt;Use the UAPI &lt;code&gt;Email::unsuspend_incoming&lt;/code&gt; function to allow the account to receive email.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function suspends incoming email for an account. The system will reject incoming email while the account is suspended.</p>
<p><strong>Notes:</strong></p>
<ul>
<li>The user can still log in to the email account. To suspend a user&#39;s ability to log in to, send mail from, and read their account, use the UAPI <code>Email::suspend_login</code> function.</li>
<li>Use the UAPI <code>Email::unsuspend_incoming</code> function to allow the account to receive email.</li>
</ul>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user@example.com</span></div><div><div html="&lt;p&gt;The email user&amp;#39;s account name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email user&#39;s account name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/suspend_incoming</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/suspend_incoming</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R996b6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R996b6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R996b6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R996b6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R996b6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R996b6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R996b6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R996b6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R996b6a:0" aria-labelledby="tab:R996b6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  suspend_incoming
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R996b6a:1" aria-labelledby="tab:R996b6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R996b6a:2" aria-labelledby="tab:R996b6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R996b6a:3" aria-labelledby="tab:R996b6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p6b6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p6b6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p6b6a:0" aria-labelledby="tab:R9p6b6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;suspend_incoming&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Suspensions/operation/suspend_login" data-section-id="tag/Email-Suspensions/operation/suspend_login" class="sc-dntaoT ceciOs"><div data-section-id="operation/suspend_login" id="operation/suspend_login" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Suspensions/operation/suspend_login" aria-label="tag/Email-Suspensions/operation/suspend_login"></a>Suspend email account login </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function suspends a user&amp;#39;s ability to log in to their email account. This function immediately suspends the user&amp;#39;s login credentials and prevents future authenticated connections to the email account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Notes:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;When you suspend an account, the user&amp;#39;s account still receives email.&lt;/li&gt;
&lt;li&gt;To suspend incoming email for an account, use the UAPI &lt;code&gt;Email::suspend_incoming&lt;/code&gt; function.&lt;/li&gt;
&lt;li&gt;To remove the login suspension for an account, use the UAPI &lt;code&gt;Email::unsuspend_login&lt;/code&gt; function.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function suspends a user&#39;s ability to log in to their email account. This function immediately suspends the user&#39;s login credentials and prevents future authenticated connections to the email account.</p>
<p><strong>Notes:</strong></p>
<ul>
<li>When you suspend an account, the user&#39;s account still receives email.</li>
<li>To suspend incoming email for an account, use the UAPI <code>Email::suspend_incoming</code> function.</li>
<li>To remove the login suspension for an account, use the UAPI <code>Email::unsuspend_login</code> function.</li>
</ul>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user@example.com</span></div><div><div html="&lt;p&gt;The email user&amp;#39;s account name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email user&#39;s account name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/suspend_login</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/suspend_login</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99ab6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99ab6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99ab6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99ab6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99ab6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99ab6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99ab6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99ab6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99ab6a:0" aria-labelledby="tab:R99ab6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  suspend_login <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'user@example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99ab6a:1" aria-labelledby="tab:R99ab6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99ab6a:2" aria-labelledby="tab:R99ab6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99ab6a:3" aria-labelledby="tab:R99ab6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pab6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pab6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pab6a:0" aria-labelledby="tab:R9pab6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;suspend_login&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Suspensions/operation/unsuspend_login" data-section-id="tag/Email-Suspensions/operation/unsuspend_login" class="sc-dntaoT ceciOs"><div data-section-id="operation/unsuspend_login" id="operation/unsuspend_login" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Suspensions/operation/unsuspend_login" aria-label="tag/Email-Suspensions/operation/unsuspend_login"></a>Unsuspend email account login </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function restores a user&amp;#39;s ability to log in to their email account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;To suspend a user&amp;#39;s ability to log in, use the UAPI &lt;code&gt;Email::suspend_login&lt;/code&gt; function.&lt;/li&gt;
&lt;li&gt;To suspend incoming email for an account, use the UAPI &lt;code&gt;Email::suspend_incoming&lt;/code&gt; function.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles#roles&quot;&gt;Receive Mail role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function restores a user&#39;s ability to log in to their email account.</p>
<p><strong>Note:</strong></p>
<ul>
<li>To suspend a user&#39;s ability to log in, use the UAPI <code>Email::suspend_login</code> function.</li>
<li>To suspend incoming email for an account, use the UAPI <code>Email::suspend_incoming</code> function.</li>
</ul>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles#roles">Receive Mail role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=username@example.com</span></div><div><div html="&lt;p&gt;The email user&amp;#39;s account name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email user&#39;s account name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/unsuspend_login</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/unsuspend_login</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99eb6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99eb6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99eb6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99eb6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99eb6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99eb6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99eb6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99eb6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99eb6a:0" aria-labelledby="tab:R99eb6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  unsuspend_login
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99eb6a:1" aria-labelledby="tab:R99eb6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99eb6a:2" aria-labelledby="tab:R99eb6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99eb6a:3" aria-labelledby="tab:R99eb6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9peb6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9peb6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9peb6a:0" aria-labelledby="tab:R9peb6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;unsuspend_login&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Suspensions/operation/suspend_outgoing" data-section-id="tag/Email-Suspensions/operation/suspend_outgoing" class="sc-dntaoT ceciOs"><div data-section-id="operation/suspend_outgoing" id="operation/suspend_outgoing" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Suspensions/operation/suspend_outgoing" aria-label="tag/Email-Suspensions/operation/suspend_outgoing"></a>Suspend email account outgoing mail </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function rejects outgoing mail for a suspended email account. This function does &lt;strong&gt;not&lt;/strong&gt; disable a user&amp;#39;s login credentials or access permissions to their email account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Notes:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;To suspend a user&amp;#39;s login credentials and prevent authenticated connections to the email account, use the UAPI &lt;code&gt;Email::suspend_login&lt;/code&gt; function.&lt;/li&gt;
&lt;li&gt;To allow an email account to send mail, use the UAPI &lt;code&gt;Email::unsuspend_outgoing&lt;/code&gt; function.&lt;/li&gt;
&lt;li&gt;To hold outgoing mail in Exim&amp;#39;s queue, use the UAPI &lt;code&gt;Email::hold_outgoing&lt;/code&gt; function.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Send Mail role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function rejects outgoing mail for a suspended email account. This function does <strong>not</strong> disable a user&#39;s login credentials or access permissions to their email account.</p>
<p><strong>Notes:</strong></p>
<ul>
<li>To suspend a user&#39;s login credentials and prevent authenticated connections to the email account, use the UAPI <code>Email::suspend_login</code> function.</li>
<li>To allow an email account to send mail, use the UAPI <code>Email::unsuspend_outgoing</code> function.</li>
<li>To hold outgoing mail in Exim&#39;s queue, use the UAPI <code>Email::hold_outgoing</code> function.</li>
</ul>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Send Mail role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=username@example.com</span></div><div><div html="&lt;p&gt;The email account&amp;#39;s username.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account&#39;s username.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/suspend_outgoing</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/suspend_outgoing</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99ib6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99ib6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99ib6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99ib6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99ib6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99ib6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99ib6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99ib6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99ib6a:0" aria-labelledby="tab:R99ib6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  suspend_outgoing <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'username@example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99ib6a:1" aria-labelledby="tab:R99ib6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99ib6a:2" aria-labelledby="tab:R99ib6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99ib6a:3" aria-labelledby="tab:R99ib6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pib6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pib6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pib6a:0" aria-labelledby="tab:R9pib6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;suspend_outgoing&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Suspensions/operation/unsuspend_incoming" data-section-id="tag/Email-Suspensions/operation/unsuspend_incoming" class="sc-dntaoT ceciOs"><div data-section-id="operation/unsuspend_incoming" id="operation/unsuspend_incoming" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Suspensions/operation/unsuspend_incoming" aria-label="tag/Email-Suspensions/operation/unsuspend_incoming"></a>Unsuspend email account incoming mail </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function unsuspends incoming email for an email account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function unsuspends incoming email for an email account.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user@example.com</span></div><div><div html="&lt;p&gt;The email user&amp;#39;s account name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email user&#39;s account name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/unsuspend_incoming</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/unsuspend_incoming</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99mb6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99mb6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99mb6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99mb6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99mb6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99mb6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99mb6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99mb6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99mb6a:0" aria-labelledby="tab:R99mb6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  unsuspend_incoming
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99mb6a:1" aria-labelledby="tab:R99mb6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99mb6a:2" aria-labelledby="tab:R99mb6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99mb6a:3" aria-labelledby="tab:R99mb6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pmb6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pmb6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pmb6a:0" aria-labelledby="tab:R9pmb6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;unsuspend_incoming&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Email-Suspensions/operation/unsuspend_outgoing" data-section-id="tag/Email-Suspensions/operation/unsuspend_outgoing" class="sc-dntaoT ceciOs"><div data-section-id="operation/unsuspend_outgoing" id="operation/unsuspend_outgoing" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Email-Suspensions/operation/unsuspend_outgoing" aria-label="tag/Email-Suspensions/operation/unsuspend_outgoing"></a>Unsuspend email account outgoing mail </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function cancels the suspension action put in place by the UAPI &lt;code&gt;Email::suspend_outgoing&lt;/code&gt;
function for outgoing mail for an email account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To suspend an email account and reject all outgoing mail, use the UAPI &lt;code&gt;Email::suspend_outgoing&lt;/code&gt; function.        &lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function cancels the suspension action put in place by the UAPI <code>Email::suspend_outgoing</code>
function for outgoing mail for an email account.</p>
<p><strong>Note:</strong></p>
<p>To suspend an email account and reject all outgoing mail, use the UAPI <code>Email::suspend_outgoing</code> function.        </p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=username@example.com</span></div><div><div html="&lt;p&gt;The email account&amp;#39;s username.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account&#39;s username.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/unsuspend_outgoing</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/unsuspend_outgoing</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99qb6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99qb6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99qb6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99qb6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99qb6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99qb6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99qb6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99qb6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99qb6a:0" aria-labelledby="tab:R99qb6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  unsuspend_outgoing <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'username@example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99qb6a:1" aria-labelledby="tab:R99qb6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99qb6a:2" aria-labelledby="tab:R99qb6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99qb6a:3" aria-labelledby="tab:R99qb6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pqb6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pqb6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pqb6a:0" aria-labelledby="tab:R9pqb6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;unsuspend_outgoing&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Mail-Server-Information" data-section-id="tag/Mail-Server-Information" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mail-Server-Information" aria-label="tag/Mail-Server-Information"></a>Mail Server Information</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Email / Mail Server Information&lt;/p&gt;
"><p>Email / Mail Server Information</p>
</div></div></div><div id="tag/Mail-Server-Information/operation/get_exim_ports_ssl" data-section-id="tag/Mail-Server-Information/operation/get_exim_ports_ssl" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_exim_ports_ssl" id="operation/get_exim_ports_ssl" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mail-Server-Information/operation/get_exim_ports_ssl" aria-label="tag/Mail-Server-Information/operation/get_exim_ports_ssl"></a>Return outgoing mail (SMTP) SSL-secured port </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves Exim&amp;#39;s SSL port.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves Exim&#39;s SSL port.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Chkservd/get_exim_ports_ssl</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Chkservd/get_exim_ports_ssl</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kmd6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kmd6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kmd6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kmd6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kmd6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kmd6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kmd6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kmd6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kmd6a:0" aria-labelledby="tab:R4kmd6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Chkservd <span class="token punctuation">\</span>
  get_exim_ports_ssl
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kmd6a:1" aria-labelledby="tab:R4kmd6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kmd6a:2" aria-labelledby="tab:R4kmd6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kmd6a:3" aria-labelledby="tab:R4kmd6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4smd6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4smd6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4smd6a:0" aria-labelledby="tab:R4smd6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_exim_ports_ssl&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Chkservd&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"ports"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">465</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Mail-Server-Information/operation/get_exim_ports" data-section-id="tag/Mail-Server-Information/operation/get_exim_ports" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_exim_ports" id="operation/get_exim_ports" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mail-Server-Information/operation/get_exim_ports" aria-label="tag/Mail-Server-Information/operation/get_exim_ports"></a>Return outgoing (SMTP) mail port </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the ports on which Exim listens.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the ports on which Exim listens.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Chkservd/get_exim_ports</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Chkservd/get_exim_ports</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kqd6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kqd6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kqd6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kqd6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kqd6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kqd6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kqd6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kqd6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kqd6a:0" aria-labelledby="tab:R4kqd6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Chkservd <span class="token punctuation">\</span>
  get_exim_ports
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kqd6a:1" aria-labelledby="tab:R4kqd6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kqd6a:2" aria-labelledby="tab:R4kqd6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kqd6a:3" aria-labelledby="tab:R4kqd6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sqd6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sqd6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sqd6a:0" aria-labelledby="tab:R4sqd6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_exim_ports&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Chkservd&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"ports"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">25</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Mailbox-Management" data-section-id="tag/Mailbox-Management" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mailbox-Management" aria-label="tag/Mailbox-Management"></a>Mailbox Management</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Email / Mailbox Management&lt;/p&gt;
"><p>Email / Mailbox Management</p>
</div></div></div><div id="tag/Mailbox-Management/operation/get_mailbox_status_list" data-section-id="tag/Mailbox-Management/operation/get_mailbox_status_list" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_mailbox_status_list" id="operation/get_mailbox_status_list" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mailbox-Management/operation/get_mailbox_status_list" aria-label="tag/Mailbox-Management/operation/get_mailbox_status_list"></a>Return cPanel account&#x27;s mailbox status </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the account&amp;#39;s mailbox size and globally unique identifier (GUID) by folder.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the account&#39;s mailbox size and globally unique identifier (GUID) by folder.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="account" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">account</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">account=user@example.com</span></div><div><div html="&lt;p&gt;The email account for which you you wish to request the status.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account for which you you wish to request the status.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mailboxes/get_mailbox_status_list</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mailboxes/get_mailbox_status_list</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R996f6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R996f6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R996f6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R996f6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R996f6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R996f6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R996f6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R996f6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R996f6a:0" aria-labelledby="tab:R996f6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mailboxes <span class="token punctuation">\</span>
  get_mailbox_status_list <span class="token punctuation">\</span>
  <span class="token assign-left variable">account</span><span class="token operator">=</span><span class="token string">'user@example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R996f6a:1" aria-labelledby="tab:R996f6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R996f6a:2" aria-labelledby="tab:R996f6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R996f6a:3" aria-labelledby="tab:R996f6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p6f6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p6f6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p6f6a:0" aria-labelledby="tab:R9p6f6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_mailbox_status_list&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mailboxes&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">&quot;1234560f0c58d158c92a000044f0d230&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mailbox"</span>: <span class="token string">&quot;INBOX.marla_singer@example_com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vsize"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">&quot;11234560f0c58d158c92a000044f0d23&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mailbox"</span>: <span class="token string">&quot;INBOX.angel_face@example_com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vsize"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">&quot;111234560f0c58d158c92a000044f0d2&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mailbox"</span>: <span class="token string">&quot;INBOX.tyler_durden@example_com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vsize"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">&quot;1111234560f0c58d158c92a000044f0d&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mailbox"</span>: <span class="token string">&quot;INBOX.Trash&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vsize"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">&quot;11111234560f0c58d158c92a000044f0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mailbox"</span>: <span class="token string">&quot;INBOX.narrator@example_com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vsize"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">&quot;111111234560f0c58d158c92a000044f&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mailbox"</span>: <span class="token string">&quot;INBOX&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vsize"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">&quot;1111111234560f0c58d158c92a000004&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mailbox"</span>: <span class="token string">&quot;INBOX.Sent&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vsize"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">&quot;11111111234560f0c58d158c92a00000&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mailbox"</span>: <span class="token string">&quot;INBOX.Drafts&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vsize"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">&quot;111111111234560f0c58d158c92a0000&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mailbox"</span>: <span class="token string">&quot;INBOX.robert_paulsen@example_com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vsize"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Mailbox-Management/operation/expunge_mailbox_messages" data-section-id="tag/Mailbox-Management/operation/expunge_mailbox_messages" class="sc-dntaoT ceciOs"><div data-section-id="operation/expunge_mailbox_messages" id="operation/expunge_mailbox_messages" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mailbox-Management/operation/expunge_mailbox_messages" aria-label="tag/Mailbox-Management/operation/expunge_mailbox_messages"></a>Delete selected messages in mailbox </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function marks the selected mail messages as deleted.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function marks the selected mail messages as deleted.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="account" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand account"><span class="property-name">account</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">account=_mainaccount@example.com</span> - The `_mainaccount` alias, which represents the cPanel user&#x27;s mailbox.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">account=example</span> - The cPanel user&#x27;s account name.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">account=user@example.com</span> - A valid email account.</li></ul><div><div html="&lt;p&gt;The email account&amp;#39;s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account&#39;s name.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="mailbox" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">mailbox</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">mailbox=INBOX.user@example_com</span></div><div><div html="&lt;p&gt;The mailbox to operate on.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;Use the &lt;code&gt;Mailboxes::get_mailbox_status_list&lt;/code&gt; function to list possible values for the mailbox parameter.&lt;/li&gt;
&lt;li&gt;Because you cannot escape wildcard characters such as (&lt;code&gt;*&lt;/code&gt;), we recommend that you use functions that use the &lt;code&gt;mailbox_guid&lt;/code&gt; parameter instead. For example, the &lt;code&gt;Mailboxes::expunge_messages_for_mailbox_guid&lt;/code&gt; function.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mailbox to operate on.</p>
<p><strong>Note:</strong></p>
<ul>
<li>Use the <code>Mailboxes::get_mailbox_status_list</code> function to list possible values for the mailbox parameter.</li>
<li>Because you cannot escape wildcard characters such as (<code>*</code>), we recommend that you use functions that use the <code>mailbox_guid</code> parameter instead. For example, the <code>Mailboxes::expunge_messages_for_mailbox_guid</code> function.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="query" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">query</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">query=savedbefore 52w</span></div><div><div html="&lt;p&gt;The Dovecot query to execute.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;The query parameter prevents accidental removal of all messages in the mailbox. For more information, read Dovecot&amp;#39;s &lt;a href=&quot;http://wiki2.dovecot.org/Tools/Doveadm/SearchQuery&quot;&gt;Search Query&lt;/a&gt; documentation.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Dovecot query to execute.</p>
<p><strong>Note:</strong></p>
<p>The query parameter prevents accidental removal of all messages in the mailbox. For more information, read Dovecot&#39;s <a href="http://wiki2.dovecot.org/Tools/Doveadm/SearchQuery">Search Query</a> documentation.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mailboxes/expunge_mailbox_messages</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mailboxes/expunge_mailbox_messages</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99af6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99af6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99af6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99af6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99af6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99af6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99af6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99af6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99af6a:0" aria-labelledby="tab:R99af6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mailboxes <span class="token punctuation">\</span>
  expunge_mailbox_messages <span class="token punctuation">\</span>
  <span class="token assign-left variable">account</span><span class="token operator">=</span><span class="token string">'_mainaccount@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">mailbox</span><span class="token operator">=</span><span class="token string">'INBOX.user@example_com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">query</span><span class="token operator">=</span><span class="token string">'savedbefore 52w'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99af6a:1" aria-labelledby="tab:R99af6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99af6a:2" aria-labelledby="tab:R99af6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99af6a:3" aria-labelledby="tab:R99af6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9paf6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9paf6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9paf6a:0" aria-labelledby="tab:R9paf6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;expunge_mailbox_messages&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mailboxes&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Mailbox-Management/operation/expunge_messages_for_mailbox_guid" data-section-id="tag/Mailbox-Management/operation/expunge_messages_for_mailbox_guid" class="sc-dntaoT ceciOs"><div data-section-id="operation/expunge_messages_for_mailbox_guid" id="operation/expunge_messages_for_mailbox_guid" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mailbox-Management/operation/expunge_messages_for_mailbox_guid" aria-label="tag/Mailbox-Management/operation/expunge_messages_for_mailbox_guid"></a>Delete selected messages in mailbox by GUID </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function marks the selected mailbox&amp;#39;s messages as deleted.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function marks the selected mailbox&#39;s messages as deleted.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="account" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand account"><span class="property-name">account</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">account=_mainaccount@example.com</span> - The `_mainaccount` alias, which represents the cPanel user&#x27;s mailbox.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">account=example</span> - The cPanel user&#x27;s account name.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">account=user@example.com</span> - A valid email account.</li></ul><div><div html="&lt;p&gt;The email account&amp;#39;s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account&#39;s name.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="mailbox_guid" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">mailbox_guid</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">mailbox_guid=2550860f0c58d158c92a000044f0d230</span></div><div><div html="&lt;p&gt;The mailbox&amp;#39;s globally unique identifier (GUID).&lt;/p&gt;
&lt;p&gt;Use the &lt;code&gt;Mailboxes::get_mailbox_status_list&lt;/code&gt; function to list possible values for the &lt;code&gt;mailbox_guid&lt;/code&gt; parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mailbox&#39;s globally unique identifier (GUID).</p>
<p>Use the <code>Mailboxes::get_mailbox_status_list</code> function to list possible values for the <code>mailbox_guid</code> parameter.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="query" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">query</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">query=savedbefore 52w</span></div><div><div html="&lt;p&gt;The query to select which messages you wish to remove from the mailbox.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The query to select which messages you wish to remove from the mailbox.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mailboxes/expunge_messages_for_mailbox_guid</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mailboxes/expunge_messages_for_mailbox_guid</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99ef6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99ef6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99ef6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99ef6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99ef6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99ef6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99ef6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99ef6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99ef6a:0" aria-labelledby="tab:R99ef6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mailboxes <span class="token punctuation">\</span>
  expunge_messages_for_mailbox_guid <span class="token punctuation">\</span>
  <span class="token assign-left variable">account</span><span class="token operator">=</span><span class="token string">'_mainaccount@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">mailbox_guid</span><span class="token operator">=</span><span class="token string">'2550860f0c58d158c92a000044f0d230'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">query</span><span class="token operator">=</span><span class="token string">'savedbefore 52w'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99ef6a:1" aria-labelledby="tab:R99ef6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99ef6a:2" aria-labelledby="tab:R99ef6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99ef6a:3" aria-labelledby="tab:R99ef6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pef6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pef6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pef6a:0" aria-labelledby="tab:R9pef6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;expunge_messages_for_mailbox_guid&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mailboxes&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Mailbox-Management/operation/has_utf8_mailbox_names" data-section-id="tag/Mailbox-Management/operation/has_utf8_mailbox_names" class="sc-dntaoT ceciOs"><div data-section-id="operation/has_utf8_mailbox_names" id="operation/has_utf8_mailbox_names" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mailbox-Management/operation/has_utf8_mailbox_names" aria-label="tag/Mailbox-Management/operation/has_utf8_mailbox_names"></a>Return if cPanel account&#x27;s mailboxes use UTF-8 </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function determines whether a cPanel user currently uses UTF-8 character-encoded mailbox names.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function determines whether a cPanel user currently uses UTF-8 character-encoded mailbox names.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;username&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=user</span></div><div><div html="&lt;p&gt;The user for whom to determine whether they currently use UTF-8
character-encoded mailbox names.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This parameter defaults to the currently-logged in user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user for whom to determine whether they currently use UTF-8
character-encoded mailbox names.</p>
<p><strong>Note:</strong></p>
<p>This parameter defaults to the currently-logged in user.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mailboxes/has_utf8_mailbox_names</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mailboxes/has_utf8_mailbox_names</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99if6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99if6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99if6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99if6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99if6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99if6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99if6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99if6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99if6a:0" aria-labelledby="tab:R99if6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mailboxes <span class="token punctuation">\</span>
  has_utf8_mailbox_names
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99if6a:1" aria-labelledby="tab:R99if6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99if6a:2" aria-labelledby="tab:R99if6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99if6a:3" aria-labelledby="tab:R99if6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pif6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pif6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pif6a:0" aria-labelledby="tab:R9pif6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;has_utf8_mailbox_names&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mailboxes&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Mailbox-Management/operation/set_utf8_mailbox_names" data-section-id="tag/Mailbox-Management/operation/set_utf8_mailbox_names" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_utf8_mailbox_names" id="operation/set_utf8_mailbox_names" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mailbox-Management/operation/set_utf8_mailbox_names" aria-label="tag/Mailbox-Management/operation/set_utf8_mailbox_names"></a>Enable or disable Webmail mailbox UTF-8 encoding </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function enables or disables UTF-8-encoded mailbox names on Roundcube webmail for a cPanel user&amp;#39;s email accounts.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables or disables UTF-8-encoded mailbox names on Roundcube webmail for a cPanel user&#39;s email accounts.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="enabled" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">enabled</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">enabled=1</span></div><div><div html="&lt;p&gt;Whether to enable or disable UTF-8 character-encoded mailbox
names.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Enable UTF-8 encoded mailbox names.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Disable UTF-8 encoded mailbox names.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to enable or disable UTF-8 character-encoded mailbox
names.</p>
<ul>
<li><code>1</code> - Enable UTF-8 encoded mailbox names.</li>
<li><code>0</code> - Disable UTF-8 encoded mailbox names.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mailboxes/set_utf8_mailbox_names</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mailboxes/set_utf8_mailbox_names</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99mf6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99mf6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99mf6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99mf6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99mf6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99mf6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99mf6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99mf6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99mf6a:0" aria-labelledby="tab:R99mf6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mailboxes <span class="token punctuation">\</span>
  set_utf8_mailbox_names <span class="token punctuation">\</span>
  <span class="token assign-left variable">enabled</span><span class="token operator">=</span><span class="token string">'1'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99mf6a:1" aria-labelledby="tab:R99mf6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99mf6a:2" aria-labelledby="tab:R99mf6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99mf6a:3" aria-labelledby="tab:R99mf6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pmf6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pmf6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pmf6a:0" aria-labelledby="tab:R9pmf6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_utf8_mailbox_names&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mailboxes&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"success"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Mailing-Lists" data-section-id="tag/Mailing-Lists" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mailing-Lists" aria-label="tag/Mailing-Lists"></a>Mailing Lists</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Email / Mailing Lists&lt;/p&gt;
"><p>Email / Mailing Lists</p>
</div></div></div><div id="tag/Mailing-Lists/operation/add_mailman_delegates" data-section-id="tag/Mailing-Lists/operation/add_mailman_delegates" class="sc-dntaoT ceciOs"><div data-section-id="operation/add_mailman_delegates" id="operation/add_mailman_delegates" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mailing-Lists/operation/add_mailman_delegates" aria-label="tag/Mailing-Lists/operation/add_mailman_delegates"></a>Add administrators to mailing list </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function grants mailing list administrative privileges to users.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function grants mailing list administrative privileges to users.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="delegates" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">delegates</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">delegates=delegates=user@example.com,admin@example.com</span> - Multiple delegates</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">delegates=user@example.com</span> - A single delegate.</li></ul><div><div html="&lt;p&gt;A list of the administrators to add.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  Separate multiple email addresses with commas.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A list of the administrators to add.</p>
<p><strong>Note:</strong></p>
<p>  Separate multiple email addresses with commas.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="list" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">list</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">list=mylist</span></div><div><div html="&lt;p&gt;The mailing list.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mailing list.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/add_mailman_delegates</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/add_mailman_delegates</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rii6h6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rii6h6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rii6h6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii6h6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rii6h6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii6h6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rii6h6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii6h6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rii6h6a:0" aria-labelledby="tab:Rii6h6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  add_mailman_delegates <span class="token punctuation">\</span>
  <span class="token assign-left variable">list</span><span class="token operator">=</span><span class="token string">'mylist'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">delegates</span><span class="token operator">=</span><span class="token string">'user@example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii6h6a:1" aria-labelledby="tab:Rii6h6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii6h6a:2" aria-labelledby="tab:Rii6h6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii6h6a:3" aria-labelledby="tab:Rii6h6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rji6h6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rji6h6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rji6h6a:0" aria-labelledby="tab:Rji6h6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;add_mailman_delegates&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"delegates"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;admin@example.com, user@example.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Mailing-Lists/operation/count_lists" data-section-id="tag/Mailing-Lists/operation/count_lists" class="sc-dntaoT ceciOs"><div data-section-id="operation/count_lists" id="operation/count_lists" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mailing-Lists/operation/count_lists" aria-label="tag/Mailing-Lists/operation/count_lists"></a>Return cPanel account&#x27;s mailing list total </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the number of &lt;a href=&quot;https://go.cpanel.net/MailingLists&quot;&gt;mailing lists&lt;/a&gt; for every email address on a cPanel account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles#roles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the number of <a href="https://go.cpanel.net/MailingLists">mailing lists</a> for every email address on a cPanel account.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles#roles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/count_lists</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/count_lists</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiah6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiah6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiah6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiah6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riiah6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiah6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riiah6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiah6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiah6a:0" aria-labelledby="tab:Riiah6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  count_lists
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiah6a:1" aria-labelledby="tab:Riiah6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiah6a:2" aria-labelledby="tab:Riiah6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiah6a:3" aria-labelledby="tab:Riiah6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjiah6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiah6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiah6a:0" aria-labelledby="tab:Rjiah6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;count_lists&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Mailing-Lists/operation/export_lists" data-section-id="tag/Mailing-Lists/operation/export_lists" class="sc-dntaoT ceciOs"><div data-section-id="operation/export_lists" id="operation/export_lists" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mailing-Lists/operation/export_lists" aria-label="tag/Mailing-Lists/operation/export_lists"></a>Export cPanel account&#x27;s Mailman mailing lists to a file </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function exports a cPanel account&amp;#39;s Mailman mailing lists into a CSV file.
This file is located in mail/exported_lists under the user&amp;#39;s home directory.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function exports a cPanel account&#39;s Mailman mailing lists into a CSV file.
This file is located in mail/exported_lists under the user&#39;s home directory.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/export_lists</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/export_lists</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riieh6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riieh6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riieh6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riieh6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riieh6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riieh6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riieh6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riieh6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riieh6a:0" aria-labelledby="tab:Riieh6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  export_lists
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riieh6a:1" aria-labelledby="tab:Riieh6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riieh6a:2" aria-labelledby="tab:Riieh6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riieh6a:3" aria-labelledby="tab:Riieh6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjieh6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjieh6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjieh6a:0" aria-labelledby="tab:Rjieh6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;export_lists&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Mailing-Lists/operation/delete_list" data-section-id="tag/Mailing-Lists/operation/delete_list" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete_list" id="operation/delete_list" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mailing-Lists/operation/delete_list" aria-label="tag/Mailing-Lists/operation/delete_list"></a>Delete mailing list </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function deletes a Mailman mailing list.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes a Mailman mailing list.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="list" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">list</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">list=mylist</span></div><div><div html="&lt;p&gt;The mailing list.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mailing list.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/delete_list</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/delete_list</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiih6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiih6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiih6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiih6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riiih6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiih6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riiih6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiih6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiih6a:0" aria-labelledby="tab:Riiih6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  delete_list <span class="token punctuation">\</span>
  <span class="token assign-left variable">list</span><span class="token operator">=</span><span class="token string">'mylist'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiih6a:1" aria-labelledby="tab:Riiih6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiih6a:2" aria-labelledby="tab:Riiih6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiih6a:3" aria-labelledby="tab:Riiih6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjiih6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiih6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiih6a:0" aria-labelledby="tab:Rjiih6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;delete_list&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Mailing-Lists/operation/generate_mailman_otp" data-section-id="tag/Mailing-Lists/operation/generate_mailman_otp" class="sc-dntaoT ceciOs"><div data-section-id="operation/generate_mailman_otp" id="operation/generate_mailman_otp" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mailing-Lists/operation/generate_mailman_otp" aria-label="tag/Mailing-Lists/operation/generate_mailman_otp"></a>Create one-time password for a mailing list </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function generates a one-time password (OTP) for a mailing list.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;The generated password expires after one use.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function generates a one-time password (OTP) for a mailing list.</p>
<p><strong>Note:</strong></p>
<p>The generated password expires after one use.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="list" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">list</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">list=mylist</span></div><div><div html="&lt;p&gt;The mailing list.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mailing list.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/generate_mailman_otp</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/generate_mailman_otp</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riimh6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riimh6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riimh6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riimh6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riimh6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riimh6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riimh6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riimh6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riimh6a:0" aria-labelledby="tab:Riimh6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  generate_mailman_otp <span class="token punctuation">\</span>
  <span class="token assign-left variable">list</span><span class="token operator">=</span><span class="token string">'mylist'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riimh6a:1" aria-labelledby="tab:Riimh6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riimh6a:2" aria-labelledby="tab:Riimh6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riimh6a:3" aria-labelledby="tab:Riimh6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjimh6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjimh6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjimh6a:0" aria-labelledby="tab:Rjimh6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;generate_mailman_otp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token string">&quot;LfFYLPRT_UoS4EDi9lGKuOFK8FaWQsozzPYn8WjM3&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Mailing-Lists/operation/get_lists_total_disk_usage" data-section-id="tag/Mailing-Lists/operation/get_lists_total_disk_usage" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_lists_total_disk_usage" id="operation/get_lists_total_disk_usage" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mailing-Lists/operation/get_lists_total_disk_usage" aria-label="tag/Mailing-Lists/operation/get_lists_total_disk_usage"></a>Return cPanel account&#x27;s mailing list disk usage </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the total disk usage for the &lt;a href=&quot;https://go.cpanel.net/cpaneldocsMailingLists&quot;&gt;mailing lists&lt;/a&gt; of a cPanel account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the total disk usage for the <a href="https://go.cpanel.net/cpaneldocsMailingLists">mailing lists</a> of a cPanel account.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/get_lists_total_disk_usage</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/get_lists_total_disk_usage</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiqh6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiqh6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiqh6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiqh6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riiqh6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiqh6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riiqh6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiqh6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiqh6a:0" aria-labelledby="tab:Riiqh6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  get_lists_total_disk_usage
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiqh6a:1" aria-labelledby="tab:Riiqh6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiqh6a:2" aria-labelledby="tab:Riiqh6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiqh6a:3" aria-labelledby="tab:Riiqh6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjiqh6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiqh6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiqh6a:0" aria-labelledby="tab:Rjiqh6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_lists_total_disk_usage&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">1024</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Mailing-Lists/operation/get_mailman_delegates" data-section-id="tag/Mailing-Lists/operation/get_mailman_delegates" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_mailman_delegates" id="operation/get_mailman_delegates" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mailing-Lists/operation/get_mailman_delegates" aria-label="tag/Mailing-Lists/operation/get_mailman_delegates"></a>Return mailing list administrators </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists a mailing list&amp;#39;s administrators.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail&lt;/a&gt; role, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists a mailing list&#39;s administrators.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail</a> role, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="list" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">list</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">list=mylist</span></div><div><div html="&lt;p&gt;The name of a Mailman mailing list on the cPanel account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of a Mailman mailing list on the cPanel account.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/get_mailman_delegates</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/get_mailman_delegates</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiuh6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiuh6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiuh6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiuh6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riiuh6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiuh6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riiuh6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiuh6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiuh6a:0" aria-labelledby="tab:Riiuh6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  get_mailman_delegates <span class="token punctuation">\</span>
  <span class="token assign-left variable">list</span><span class="token operator">=</span><span class="token string">'mylist'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiuh6a:1" aria-labelledby="tab:Riiuh6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiuh6a:2" aria-labelledby="tab:Riiuh6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiuh6a:3" aria-labelledby="tab:Riiuh6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjiuh6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiuh6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiuh6a:0" aria-labelledby="tab:Rjiuh6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_mailman_delegates&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"delegates"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;secondadmin@example.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Mailing-Lists/operation/passwd_list" data-section-id="tag/Mailing-Lists/operation/passwd_list" class="sc-dntaoT ceciOs"><div data-section-id="operation/passwd_list" id="operation/passwd_list" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mailing-Lists/operation/passwd_list" aria-label="tag/Mailing-Lists/operation/passwd_list"></a>Update mailing list password </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function changes a mailing list&amp;#39;s password.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt;&lt;/a&gt; role, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function changes a mailing list&#39;s password.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em></a> role, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="list" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">list</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">list=mylist@example.com</span></div><div><div html="&lt;p&gt;The full name (including the domain) of a Mailman mailing list on the cPanel account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The full name (including the domain) of a Mailman mailing list on the cPanel account.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="password" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">password</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">password=12345luggage</span></div><div><div html="&lt;p&gt;The new password.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new password.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/passwd_list</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/passwd_list</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rij2h6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rij2h6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rij2h6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij2h6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rij2h6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij2h6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rij2h6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij2h6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rij2h6a:0" aria-labelledby="tab:Rij2h6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  passwd_list <span class="token punctuation">\</span>
  <span class="token assign-left variable">list</span><span class="token operator">=</span><span class="token string">'mylist@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">password</span><span class="token operator">=</span><span class="token string">'12345luggage'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij2h6a:1" aria-labelledby="tab:Rij2h6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij2h6a:2" aria-labelledby="tab:Rij2h6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij2h6a:3" aria-labelledby="tab:Rij2h6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjj2h6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj2h6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj2h6a:0" aria-labelledby="tab:Rjj2h6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;passwd_list&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Mailing-Lists/operation/has_delegated_mailman_lists" data-section-id="tag/Mailing-Lists/operation/has_delegated_mailman_lists" class="sc-dntaoT ceciOs"><div data-section-id="operation/has_delegated_mailman_lists" id="operation/has_delegated_mailman_lists" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mailing-Lists/operation/has_delegated_mailman_lists" aria-label="tag/Mailing-Lists/operation/has_delegated_mailman_lists"></a>Return email account&#x27;s mailing list privileges </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function checks an account&amp;#39;s administrative privileges on mailing lists.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks an account&#39;s administrative privileges on mailing lists.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="delegate" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">delegate</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">delegate=user@example.com</span></div><div><div html="&lt;p&gt;The email address.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email address.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/has_delegated_mailman_lists</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/has_delegated_mailman_lists</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rij6h6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rij6h6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rij6h6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij6h6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rij6h6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij6h6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rij6h6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij6h6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rij6h6a:0" aria-labelledby="tab:Rij6h6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  has_delegated_mailman_lists <span class="token punctuation">\</span>
  <span class="token assign-left variable">delegate</span><span class="token operator">=</span><span class="token string">'user@example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij6h6a:1" aria-labelledby="tab:Rij6h6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij6h6a:2" aria-labelledby="tab:Rij6h6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij6h6a:3" aria-labelledby="tab:Rij6h6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjj6h6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj6h6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj6h6a:0" aria-labelledby="tab:Rjj6h6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;has_delegated_mailman_lists&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Mailing-Lists/operation/list_lists" data-section-id="tag/Mailing-Lists/operation/list_lists" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_lists" id="operation/list_lists" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mailing-Lists/operation/list_lists" aria-label="tag/Mailing-Lists/operation/list_lists"></a>Return cPanel account&#x27;s mailing lists </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the account&amp;#39;s Mailman mailing lists.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the account&#39;s Mailman mailing lists.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The domain to query. If you do &lt;strong&gt;not&lt;/strong&gt; use this parameter, the function lists mailing lists for all of the cPanel account&amp;#39;s domains.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain to query. If you do <strong>not</strong> use this parameter, the function lists mailing lists for all of the cPanel account&#39;s domains.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="regex" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">regex</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">regex=user</span></div><div><div html="&lt;p&gt;A &lt;a href=&quot;https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions&quot;&gt;Perl Compatible Regular Expression (PCRE)&lt;/a&gt; that filters the results.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A <a href="https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions">Perl Compatible Regular Expression (PCRE)</a> that filters the results.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/list_lists</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/list_lists</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rijah6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rijah6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rijah6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijah6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rijah6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijah6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rijah6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijah6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rijah6a:0" aria-labelledby="tab:Rijah6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  list_lists
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijah6a:1" aria-labelledby="tab:Rijah6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijah6a:2" aria-labelledby="tab:Rijah6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijah6a:3" aria-labelledby="tab:Rijah6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjjah6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjjah6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjjah6a:0" aria-labelledby="tab:Rjjah6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_lists&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"accesstype"</span>: <span class="token string">&quot;public&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"advertised"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"archive_private"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"desthost"</span>: <span class="token string">&quot;172.16.254.1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"diskused"</span>: <span class="token number">20379</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"humandiskused"</span>: <span class="token string">&quot;19.9\\u00a0KB&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"list"</span>: <span class="token string">&quot;list@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"listadmin"</span>: <span class="token string">&quot;admin@example.com,admin2@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"listid"</span>: <span class="token string">&quot;list_example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subscribe_policy"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Mailing-Lists/operation/remove_mailman_delegates" data-section-id="tag/Mailing-Lists/operation/remove_mailman_delegates" class="sc-dntaoT ceciOs"><div data-section-id="operation/remove_mailman_delegates" id="operation/remove_mailman_delegates" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mailing-Lists/operation/remove_mailman_delegates" aria-label="tag/Mailing-Lists/operation/remove_mailman_delegates"></a>Remove account mailing list admin privileges </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function removes an account&amp;#39;s mailing list administrative privileges.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes an account&#39;s mailing list administrative privileges.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="delegates" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">delegates</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">delegates=user@example.com,admin@example.com</span></div><div><div html="&lt;p&gt;list of the administrators to remove.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>list of the administrators to remove.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="list" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">list</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">list=mylist</span></div><div><div html="&lt;p&gt;The mailing list.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mailing list.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/remove_mailman_delegates</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/remove_mailman_delegates</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rijeh6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rijeh6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rijeh6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijeh6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rijeh6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijeh6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rijeh6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijeh6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rijeh6a:0" aria-labelledby="tab:Rijeh6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  remove_mailman_delegates <span class="token punctuation">\</span>
  <span class="token assign-left variable">list</span><span class="token operator">=</span><span class="token string">'mylist'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">delegates</span><span class="token operator">=</span><span class="token string">'user@example.com,admin@example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijeh6a:1" aria-labelledby="tab:Rijeh6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijeh6a:2" aria-labelledby="tab:Rijeh6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijeh6a:3" aria-labelledby="tab:Rijeh6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjjeh6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjjeh6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjjeh6a:0" aria-labelledby="tab:Rjjeh6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;remove_mailman_delegates&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"delegates"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;secondadmin@example.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Mailing-Lists/operation/set_list_privacy_options" data-section-id="tag/Mailing-Lists/operation/set_list_privacy_options" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_list_privacy_options" id="operation/set_list_privacy_options" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mailing-Lists/operation/set_list_privacy_options" aria-label="tag/Mailing-Lists/operation/set_list_privacy_options"></a>Update mailing list privacy options </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function modifies a Mailman mailing list&amp;#39;s privacy options.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function modifies a Mailman mailing list&#39;s privacy options.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="advertised" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">advertised</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">advertised=1</span></div><div><div html="&lt;p&gt;Whether the Mailman directory page displays the list.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Display.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Does &lt;strong&gt;not&lt;/strong&gt; display.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the Mailman directory page displays the list.</p>
<ul>
<li><code>1</code> - Display.</li>
<li><code>0</code> - Does <strong>not</strong> display.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="archive_private" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">archive_private</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">archive_private=1</span></div><div><div html="&lt;p&gt;Whether the mailing list archive is private.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Private.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Public.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the mailing list archive is private.</p>
<ul>
<li><code>1</code> - Private.</li>
<li><code>0</code> - Public.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="list" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">list</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">list=mylist</span></div><div><div html="&lt;p&gt;The mailing list name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mailing list name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="subscribe_policy" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">subscribe_policy</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">2</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">3</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">subscribe_policy=1</span></div><div><div html="&lt;p&gt;The level of control that the mailing list administrator has over new subscribers.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Anyone can subscribe. The system sends a confirmation email.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;2&lt;/code&gt; - The administrator &lt;strong&gt;must&lt;/strong&gt; approve subscriptions. The system does &lt;strong&gt;not&lt;/strong&gt; send a confirmation email.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;3&lt;/code&gt; - The administrator &lt;strong&gt;must&lt;/strong&gt; approve subscriptions. The system sends a confirmation email.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The level of control that the mailing list administrator has over new subscribers.</p>
<ul>
<li><code>1</code> - Anyone can subscribe. The system sends a confirmation email.</li>
<li><code>2</code> - The administrator <strong>must</strong> approve subscriptions. The system does <strong>not</strong> send a confirmation email.</li>
<li><code>3</code> - The administrator <strong>must</strong> approve subscriptions. The system sends a confirmation email.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/set_list_privacy_options</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/set_list_privacy_options</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rijih6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rijih6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rijih6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijih6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rijih6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijih6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rijih6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijih6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rijih6a:0" aria-labelledby="tab:Rijih6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  set_list_privacy_options <span class="token punctuation">\</span>
  <span class="token assign-left variable">list</span><span class="token operator">=</span><span class="token string">'mylist'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">advertised</span><span class="token operator">=</span><span class="token string">'1'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">archive_private</span><span class="token operator">=</span><span class="token string">'1'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">subscribe_policy</span><span class="token operator">=</span><span class="token string">'1'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijih6a:1" aria-labelledby="tab:Rijih6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijih6a:2" aria-labelledby="tab:Rijih6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijih6a:3" aria-labelledby="tab:Rijih6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjjih6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjjih6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjjih6a:0" aria-labelledby="tab:Rjjih6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_list_privacy_options&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Mailing-Lists/operation/add_list" data-section-id="tag/Mailing-Lists/operation/add_list" class="sc-dntaoT ceciOs"><div data-section-id="operation/add_list" id="operation/add_list" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mailing-Lists/operation/add_list" aria-label="tag/Mailing-Lists/operation/add_list"></a>Create mailing list </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function creates a Mailman mailing list.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a Mailman mailing list.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="list" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">list</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">list=newlist</span></div><div><div html="&lt;p&gt;The mailing list name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mailing list name.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="password" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">password</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">password=12345luggage</span></div><div><div html="&lt;p&gt;The mailing list password.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The mailing list password.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="private" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">private</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">private=0</span></div><div><div html="&lt;p&gt;Whether the mailing list is private.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Private.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Public.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the mailing list is private.</p>
<ul>
<li><code>1</code> — Private.</li>
<li><code>0</code> — Public.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="rebuildonly" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">rebuildonly</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">rebuildonly=0</span></div><div><div html="&lt;p&gt;Whether to rebuild the mailing list.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Rebuild the mailing list.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Do &lt;strong&gt;not&lt;/strong&gt; rebuild the mailing list.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to rebuild the mailing list.</p>
<ul>
<li><code>1</code> — Rebuild the mailing list.</li>
<li><code>0</code> — Do <strong>not</strong> rebuild the mailing list.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/add_list</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/add_list</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rijmh6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rijmh6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rijmh6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijmh6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rijmh6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijmh6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rijmh6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijmh6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rijmh6a:0" aria-labelledby="tab:Rijmh6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  add_list <span class="token punctuation">\</span>
  <span class="token assign-left variable">list</span><span class="token operator">=</span><span class="token string">'newlist'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">password</span><span class="token operator">=</span><span class="token string">'12345luggage'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijmh6a:1" aria-labelledby="tab:Rijmh6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijmh6a:2" aria-labelledby="tab:Rijmh6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijmh6a:3" aria-labelledby="tab:Rijmh6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjjmh6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjjmh6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjjmh6a:0" aria-labelledby="tab:Rjjmh6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;add_list&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Signing-and-Encryption-(GnuPG-Keys)" data-section-id="tag/Signing-and-Encryption-(GnuPG-Keys)" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Signing-and-Encryption-(GnuPG-Keys)" aria-label="tag/Signing-and-Encryption-(GnuPG-Keys)"></a>Signing and Encryption (GnuPG Keys)</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Email / Signing and Encryption (GnuPG Keys)&lt;/p&gt;
"><p>Email / Signing and Encryption (GnuPG Keys)</p>
</div></div></div><div id="tag/Signing-and-Encryption-(GnuPG-Keys)/operation/delete_keypair" data-section-id="tag/Signing-and-Encryption-(GnuPG-Keys)/operation/delete_keypair" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete_keypair" id="operation/delete_keypair" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Signing-and-Encryption-(GnuPG-Keys)/operation/delete_keypair" aria-label="tag/Signing-and-Encryption-(GnuPG-Keys)/operation/delete_keypair"></a>Delete GnuPG key pair </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function deletes a GnuPG (GPG) key pair.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes a GnuPG (GPG) key pair.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="key_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">key_id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key_id=ACFFDB37176B680D</span></div><div><div html="&lt;p&gt;The ID of the GPG key that you wish to delete.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;The function will delete &lt;strong&gt;all&lt;/strong&gt; keys that match this ID.&lt;ul&gt;
&lt;li&gt;If you set this parameter to a public key, the function will delete the public key. &lt;/li&gt;
&lt;li&gt;If you set this parameter to a public and private key pair, the function will delete the public and private keys.&lt;/li&gt;
&lt;/ul&gt;
&lt;/li&gt;
&lt;li&gt;To obtain the desired key, call the UAPI &lt;code&gt;GPG::list_secret_keys&lt;/code&gt; function.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The ID of the GPG key that you wish to delete.</p>
<p><strong>Note:</strong></p>
<ul>
<li>The function will delete <strong>all</strong> keys that match this ID.<ul>
<li>If you set this parameter to a public key, the function will delete the public key. </li>
<li>If you set this parameter to a public and private key pair, the function will delete the public and private keys.</li>
</ul>
</li>
<li>To obtain the desired key, call the UAPI <code>GPG::list_secret_keys</code> function.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/GPG/delete_keypair</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/GPG/delete_keypair</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R996j6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R996j6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R996j6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R996j6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R996j6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R996j6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R996j6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R996j6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R996j6a:0" aria-labelledby="tab:R996j6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  GPG <span class="token punctuation">\</span>
  delete_keypair <span class="token punctuation">\</span>
  <span class="token assign-left variable">key_id</span><span class="token operator">=</span><span class="token string">'ACFFDB37176B680D'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R996j6a:1" aria-labelledby="tab:R996j6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R996j6a:2" aria-labelledby="tab:R996j6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R996j6a:3" aria-labelledby="tab:R996j6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p6j6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p6j6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p6j6a:0" aria-labelledby="tab:R9p6j6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;delete_keypair&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;GPG&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Signing-and-Encryption-(GnuPG-Keys)/operation/export_public_key" data-section-id="tag/Signing-and-Encryption-(GnuPG-Keys)/operation/export_public_key" class="sc-dntaoT ceciOs"><div data-section-id="operation/export_public_key" id="operation/export_public_key" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Signing-and-Encryption-(GnuPG-Keys)/operation/export_public_key" aria-label="tag/Signing-and-Encryption-(GnuPG-Keys)/operation/export_public_key"></a>Export GnuPG public key </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function exports a GnuPG (GPG) public key.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function exports a GnuPG (GPG) public key.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="key_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">key_id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key_id=48BEA5A16FCA746E</span></div><div><div html="&lt;p&gt;The ID of the GPG key.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The ID of the GPG key.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/GPG/export_public_key</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/GPG/export_public_key</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99aj6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99aj6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99aj6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99aj6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99aj6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99aj6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99aj6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99aj6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99aj6a:0" aria-labelledby="tab:R99aj6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  GPG <span class="token punctuation">\</span>
  export_public_key <span class="token punctuation">\</span>
  <span class="token assign-left variable">key_id</span><span class="token operator">=</span><span class="token string">'48BEA5A16FCA746E'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99aj6a:1" aria-labelledby="tab:R99aj6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99aj6a:2" aria-labelledby="tab:R99aj6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99aj6a:3" aria-labelledby="tab:R99aj6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9paj6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9paj6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9paj6a:0" aria-labelledby="tab:R9paj6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;export_public_key&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;GPG&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"key_data"</span>: <span class="token string">&quot;-----BEGIN PGP PUBLIC KEY BLOCK-----\nVersion: GnuPG v2.0.22 (GNU/Linux)\n\nmQMuBFzwFyMRCADgNf7GHvCgb2/HWBYVAzu408eXEO4ucWGfbD5c5BOHg7WBVOkh\nj+J0HYaeh9FwOXLJAzesiGtTU/HQ5wNkBbKRYR2oNEUbiefBgQhjllIGJNnFCQbD\nTcyxXjKUF4aQBw6InqzM9akVChLvGoCfom/y1fcwrQ5OQ46EEjhe9lSnj1E2DIi+\n0PvOsWeehChtn28WkmXPcl+XovfsCl5vh2RnJQeJwkSwBogA1GObj9fnPBbrIUt2\nF5JDaJ7/R8aDwV1Pg2mBmRqTBIKvx6gxEQgCL52OWCKVJfqy5oVGDl/2u0BGCaRt\n3Tnh9B14Lk8frBaOjYMtMq1Rl3rPDc3KCRnLAQC6dMNJCxIoyfeEFqj0HgwHETYn\nQNGwUaRrOGKLJbMnewf/Yq0S2R6YvMl8pDQeSExYJaqv/u2Hch6GM0f3CSvMnPSg\noB2c/h4MmhmiAbymSO5GBaM4Nx3NTNYU0JpghkTTJpucFZ8hK/aJ8PDQzBnS0zTY\nF8ZqSMFL84QB1NTd1nlJnilpKCkBC6NHUh76IyLQEsH7jgOG9L28qnLxm8bGHwaJ\nmhEH2Y859WzN9hUTZEMxdklI8uwdI+msI7md0uNYiWr5svtM+rrpU+LCZMG+nTCy\n6q0CNLXM0T0Fa642mYSqV307Ouv5rjGvfohIOo5X8ikBoEIOAQk6LX800OzzYGG4\nX75Q4irMuehEK3tId5VIRToy9MRLP6fyOVHwfhzD6Af/R2TJjIdEkEGdspuw9875\nN4z9xV2QNVNgURIOutrfeKSbb7gRLgV7TWpKWItMoEO1njzb4YqoHwcAASj4TDaT\niCYun6u12Mb97L0S3QDaD3sLk7P5sZvnO//k/YxbGISv+HGl5rSF87kVectLYpAL\nehL2EBmyxP4nxhSDOqhc0rbaqOZ+b4F1ns4NsUJjxIqQJZ+ovTqkmKnh3YbBeMAb\nsPcjyfQNmYE9qFXw17vJMm6ypNsuDIvxKCDq4QpO3/MujYX0Hg7aGOq4aWtndcL0\nPfpukTLvTA+AedMj+0QHWiP15bSxCJKqa0O62mKWnrzL0Tju8FKTwVHgRoW57GY/\nZbQmYmVuZGVyIChpcyBncmVhdCkgPGJlbmRlckBleGFtcGxlLmNvbT6IgQQTEQgA\nKQUCXPAXIwIbIwUJAeEzgAcLCQgHAwIBBhUIAgkKCwQWAgMBAh4BAheAAAoJEEi+\npaFvynRuACUA/1/usChuLicDwCbBlJpcYWaAkt4bC4z+wFAONKnwwlHoAQCq3GRM\nto4CkoB6pK1Zh+s5SitojUFrKEj8CJNkAQOGaLkCDQRc8BcjEAgA4CY3AKnkIvSz\nfcsFCf1NmZipQGLChs3iIhqa3NPiopYpYMNTdCZkkDMSDM40+d/LthpYnbzYVgPB\nN9OFMdL/ndf/yu0jPEZE1uEpxvH1X/x2IecMy7wm51usxpBWwSw7BTLfA9ASzDtH\n8fnkid2qY2J6fNWZDA5wrNR4auVKDkqKsatMC75GkHcT2NevLdh8SuYH60kQsmvD\nOkuE4ufIwzlnQ4HFKsYTxn6QIQY18entu563f+RCoUCNv2J0zxXFzvy+eo568+Uh\nx4Irz9OQRNUh/82a2HF10oUvkPEtCDlMy8gISEqnU1i2Ry8IsbUrvhz+my5yb5Gm\nZz+xOKWTiwADBQf/YOYKvHIWw4/vsbLUPMmjDdMfsnT0haDlLerCSHhY+ZLzYQdz\n/7hC4Qt/5EvaGeXkwAPzr0T4PvVOQUUAiskvDNScYQxS5KxyrHAqoKkF4EDJ9MyK\nDqEN6dF9IDOxuA1g0cOX7THPm3GjRh3BjOaHnN5jXKwT85Cs7hj7u1q9Cm59RUzJ\nwRKyxo9eR3pJMR+8E0VW8oRe/7O/Qvh54ShD7NkfgUhIWcriR9MjoGp0gnpCOH52\nLrfdczCIzAoUC4Q3Jm80sCeZAqf4CNHZ0TxqxuwG+ZkfbCBViM4TVXDEufA4IENM\nmEu2bNWDLkRrrNme+S4HEeNRuSg8EOpFUuwPI4hnBBgRCAAPBQJc8BcjAhsMBQkB\n4TOAAAoJEEi+paFvynRu0YsA/0rluXh9ij3Np4O/KWuL2L8zcOrJJ7mNFuw0wkpY\nfZ3NAP9ayHG+70XellsQ/E3lR8fkRwqDDRh43w7ukhJEfkcY9A==\n=yyST\n-----END PGP PUBLIC KEY BLOCK-----\n&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Signing-and-Encryption-(GnuPG-Keys)/operation/export_secret_key" data-section-id="tag/Signing-and-Encryption-(GnuPG-Keys)/operation/export_secret_key" class="sc-dntaoT ceciOs"><div data-section-id="operation/export_secret_key" id="operation/export_secret_key" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Signing-and-Encryption-(GnuPG-Keys)/operation/export_secret_key" aria-label="tag/Signing-and-Encryption-(GnuPG-Keys)/operation/export_secret_key"></a>Export GnuPG secret key </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function exports a GnuPG (GPG) secret key.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function exports a GnuPG (GPG) secret key.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="key_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">key_id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key_id=48BEA5A16FCA746E</span></div><div><div html="&lt;p&gt;The ID of the GPG secret key that you wish to retrieve.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The ID of the GPG secret key that you wish to retrieve.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="passphrase" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">passphrase</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">passphrase=whatever</span></div><div><div html="&lt;p&gt;The passphrase of the GPG secret key that you wish to retrieve.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The passphrase of the GPG secret key that you wish to retrieve.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/GPG/export_secret_key</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/GPG/export_secret_key</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99ej6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99ej6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99ej6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99ej6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99ej6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99ej6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99ej6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99ej6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99ej6a:0" aria-labelledby="tab:R99ej6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  GPG <span class="token punctuation">\</span>
  export_secret_key <span class="token punctuation">\</span>
  <span class="token assign-left variable">key_id</span><span class="token operator">=</span><span class="token string">'48BEA5A16FCA746E'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99ej6a:1" aria-labelledby="tab:R99ej6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99ej6a:2" aria-labelledby="tab:R99ej6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99ej6a:3" aria-labelledby="tab:R99ej6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pej6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pej6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pej6a:0" aria-labelledby="tab:R9pej6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;export_secret_key&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;GPG&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"key_data"</span>: <span class="token string">&quot;-----BEGIN PGP PRIVATE KEY BLOCK-----\nVersion: GnuPG v2.0.22 (GNU/Linux)\n\nlQNTBFzwFyMRCADgNf7GHvCgb2/HWBYVAzu408eXEO4ucWGfbD5c5BOHg7WBVOkh\nj+J0HYaeh9FwOXLJAzesiGtTU/HQ5wNkBbKRYR2oNEUbiefBgQhjllIGJNnFCQbD\nTcyxXjKUF4aQBw6InqzM9akVChLvGoCfom/y1fcwrQ5OQ46EEjhe9lSnj1E2DIi+\n0PvOsWeehChtn28WkmXPcl+XovfsCl5vh2RnJQeJwkSwBogA1GObj9fnPBbrIUt2\nF5JDaJ7/R8aDwV1Pg2mBmRqTBIKvx6gxEQgCL52OWCKVJfqy5oVGDl/2u0BGCaRt\n3Tnh9B14Lk8frBaOjYMtMq1Rl3rPDc3KCRnLAQC6dMNJCxIoyfeEFqj0HgwHETYn\nQNGwUaRrOGKLJbMnewf/Yq0S2R6YvMl8pDQeSExYJaqv/u2Hch6GM0f3CSvMnPSg\noB2c/h4MmhmiAbymSO5GBaM4Nx3NTNYU0JpghkTTJpucFZ8hK/aJ8PDQzBnS0zTY\nF8ZqSMFL84QB1NTd1nlJnilpKCkBC6NHUh76IyLQEsH7jgOG9L28qnLxm8bGHwaJ\nmhEH2Y859WzN9hUTZEMxdklI8uwdI+msI7md0uNYiWr5svtM+rrpU+LCZMG+nTCy\n6q0CNLXM0T0Fa642mYSqV307Ouv5rjGvfohIOo5X8ikBoEIOAQk6LX800OzzYGG4\nX75Q4irMuehEK3tId5VIRToy9MRLP6fyOVHwfhzD6Af/R2TJjIdEkEGdspuw9875\nN4z9xV2QNVNgURIOutrfeKSbb7gRLgV7TWpKWItMoEO1njzb4YqoHwcAASj4TDaT\niCYun6u12Mb97L0S3QDaD3sLk7P5sZvnO//k/YxbGISv+HGl5rSF87kVectLYpAL\nehL2EBmyxP4nxhSDOqhc0rbaqOZ+b4F1ns4NsUJjxIqQJZ+ovTqkmKnh3YbBeMAb\nsPcjyfQNmYE9qFXw17vJMm6ypNsuDIvxKCDq4QpO3/MujYX0Hg7aGOq4aWtndcL0\nPfpukTLvTA+AedMj+0QHWiP15bSxCJKqa0O62mKWnrzL0Tju8FKTwVHgRoW57GY/\nZQABALMunDJSN+b/VyFzqifGvopLxJFqA4un4WjGEY9jvJooD7e0JmJlbmRlciAo\naXMgZ3JlYXQpIDxiZW5kZXJAZXhhbXBsZS5jb20+iIEEExEIACkFAlzwFyMCGyMF\nCQHhM4AHCwkIBwMCAQYVCAIJCgsEFgIDAQIeAQIXgAAKCRBIvqWhb8p0bgAlAP9f\n7rAobi4nA8AmwZSaXGFmgJLeGwuM/sBQDjSp8MJR6AEAqtxkTLaOApKAeqStWYfr\nOUoraI1BayhI/AiTZAEDhmidAj0EXPAXIxAIAOAmNwCp5CL0s33LBQn9TZmYqUBi\nwobN4iIamtzT4qKWKWDDU3QmZJAzEgzONPnfy7YaWJ282FYDwTfThTHS/53X/8rt\nIzxGRNbhKcbx9V/8diHnDMu8JudbrMaQVsEsOwUy3wPQEsw7R/H55IndqmNienzV\nmQwOcKzUeGrlSg5KirGrTAu+RpB3E9jXry3YfErmB+tJELJrwzpLhOLnyMM5Z0OB\nxSrGE8Z+kCEGNfHp7buet3/kQqFAjb9idM8Vxc78vnqOevPlIceCK8/TkETVIf/N\nmthxddKFL5DxLQg5TMvICEhKp1NYtkcvCLG1K74c/psucm+Rpmc/sTilk4sAAwUH\n/2DmCrxyFsOP77Gy1DzJow3TH7J09IWg5S3qwkh4WPmS82EHc/+4QuELf+RL2hnl\n5MAD869E+D71TkFFAIrJLwzUnGEMUuSscqxwKqCpBeBAyfTMig6hDenRfSAzsbgN\nYNHDl+0xz5txo0YdwYzmh5zeY1ysE/OQrO4Y+7tavQpufUVMycESssaPXkd6STEf\nvBNFVvKEXv+zv0L4eeEoQ+zZH4FISFnK4kfTI6BqdIJ6Qjh+di633XMwiMwKFAuE\nNyZvNLAnmQKn+AjR2dE8asbsBvmZH2wgVYjOE1VwxLnwOCBDTJhLtmzVgy5Ea6zZ\nnvkuBxHjUbkoPBDqRVLsDyMAAVIC+56gmf2bW2mDuoFFUW6KT6jorvvbmXSZHi1L\nAGhQj/Q83gRejq2g+DYiFlCIZwQYEQgADwUCXPAXIwIbDAUJAeEzgAAKCRBIvqWh\nb8p0btGLAPsFHEqEg/qrEpjFu/9B8KvBWBgqIJm9XtDgaVaaHjzR4AD/XcrEvMuc\nPVYssXICwKbDwxWEYqhpI6ms0IOob0PH8hE=\n=W2NA\n-----END PGP PRIVATE KEY BLOCK-----&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Signing-and-Encryption-(GnuPG-Keys)/operation/import_key" data-section-id="tag/Signing-and-Encryption-(GnuPG-Keys)/operation/import_key" class="sc-dntaoT ceciOs"><div data-section-id="operation/import_key" id="operation/import_key" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Signing-and-Encryption-(GnuPG-Keys)/operation/import_key" aria-label="tag/Signing-and-Encryption-(GnuPG-Keys)/operation/import_key"></a>Import GnuPG key </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function imports a GnuPG (GPG) key.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function imports a GnuPG (GPG) key.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="key_data" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">key_data</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key_data=%0A-----BEGIN%20PGP%20PUBLIC%20KEY%20BLOCK-----%0AVersion%3A%20GnuPG%20v2.0.14%20(GNU%2FLinux)%0A%0AmQENBFN0%2BOsBCADoFvyf8gHIKZ%2F%2B5KwbWb3Ht%2Fz1ukyQqFNGpBVIqHossmjmyF9e%0APn6iiZ0fHnt7r6XGGXaP%2BKKjIxAcqOTiFiP%2BHIx6GQubzVih6Ol0YNjzmK%2Ft4f%2B4%0AfSElEVnyzeyJa4LmC%2Fui%2FvvtptJ8JX6su7f11BwUTSyuqnk204AfN5uVpAcZNPT0%0A0qNNky1bxYvPUxU6Imvi1q3NtpFzqsQ4u%2FyZuLpUe7uwmgMPeO0lAms1kCa3Guot%0A3mfSt0vrUAMdcV4drY1FGtYZdYSa4rSTzpFuB7o9Ze%2BE3fUbCWs1%2B0FiN3JQNGO1%0AS2lnqjEqbpz2nHtA50elJRGqxZLEi8zkFqlTABEBAAG0Z2NQYW5lbCBTZWN1cml0%0AeSBUZWFtIC0gVEVTVCAoVEhJUyBJUyBBIFRFU1QgS0VZOyBETyBOT1QgVVNFIEZP%0AUiBBTllUSElORyBSRUFMISkgPHNlY3RlYW1zaXhAY3BhbmVsLm5ldD6JAT4EEwEC%0AACgFAlN0%2BOsCGwMFCQHhM4AGCwkIBwMCBhUIAgkKCwQWAgMBAh4BAheAAAoJEOhU%0A60c9RtoRkhMIAIe2yDKj55mGD3zbuGqxx6NNNIyiuEujw31N8yOS9BKTqGtIiK9i%0AGu4lzrzmHISKi0rjKmJdbckap7OouUoo9WR3ewjN6S5EHyjKfrrMwMzTWMPZOkTj%0A7A698X0vGc9yZ6KyBj8mM8J9duvNtRS285hfXfQxYO%2FuiyrJGBedI%2FWVZ3a7mcfq%0A7FhC8t6jU6sz9uIvYHAzywcVdmhEK5rS%2FuE%2F9e37h46jn2%2BkzlIWEe%2FYgpa%2BuWdT%0AO%2BOyqteW51LEjXLWMyP8AJEq8EoqbqKnm4Q1g0etOQ9trrkLUnPxaSwD5R6i4KLH%0AMR%2Fh7m%2FOoz8yOhUlrCGJwX7v9qDEdaYYFLQ%3D%0A%3DMEFZ%0A-----END%20PGP%20PUBLIC%20KEY%20BLOCK-----%0A</span></div><div><div html="&lt;p&gt;The key to import.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You must URI-encode this value.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key to import.</p>
<p><strong>Note:</strong></p>
<p>You must URI-encode this value.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/GPG/import_key</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/GPG/import_key</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99ij6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99ij6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99ij6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99ij6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99ij6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99ij6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99ij6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99ij6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99ij6a:0" aria-labelledby="tab:R99ij6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  GPG <span class="token punctuation">\</span>
  import_key <span class="token punctuation">\</span>
  <span class="token assign-left variable">key_data</span><span class="token operator">=</span><span class="token string">'%0A-----BEGIN%20PGP%20PUBLIC%20KEY%20BLOCK-----%0AVersion%3A%20GnuPG%20v2.0.14%20(GNU%2FLinux)%0A%0AmQENBFN0%2BOsBCADoFvyf8gHIKZ%2F%2B5KwbWb3Ht%2Fz1ukyQqFNGpBVIqHossmjmyF9e%0APn6iiZ0fHnt7r6XGGXaP%2BKKjIxAcqOTiFiP%2BHIx6GQubzVih6Ol0YNjzmK%2Ft4f%2B4%0AfSElEVnyzeyJa4LmC%2Fui%2FvvtptJ8JX6su7f11BwUTSyuqnk204AfN5uVpAcZNPT0%0A0qNNky1bxYvPUxU6Imvi1q3NtpFzqsQ4u%2FyZuLpUe7uwmgMPeO0lAms1kCa3Guot%0A3mfSt0vrUAMdcV4drY1FGtYZdYSa4rSTzpFuB7o9Ze%2BE3fUbCWs1%2B0FiN3JQNGO1%0AS2lnqjEqbpz2nHtA50elJRGqxZLEi8zkFqlTABEBAAG0Z2NQYW5lbCBTZWN1cml0%0AeSBUZWFtIC0gVEVTVCAoVEhJUyBJUyBBIFRFU1QgS0VZOyBETyBOT1QgVVNFIEZP%0AUiBBTllUSElORyBSRUFMISkgPHNlY3RlYW1zaXhAY3BhbmVsLm5ldD6JAT4EEwEC%0AACgFAlN0%2BOsCGwMFCQHhM4AGCwkIBwMCBhUIAgkKCwQWAgMBAh4BAheAAAoJEOhU%0A60c9RtoRkhMIAIe2yDKj55mGD3zbuGqxx6NNNIyiuEujw31N8yOS9BKTqGtIiK9i%0AGu4lzrzmHISKi0rjKmJdbckap7OouUoo9WR3ewjN6S5EHyjKfrrMwMzTWMPZOkTj%0A7A698X0vGc9yZ6KyBj8mM8J9duvNtRS285hfXfQxYO%2FuiyrJGBedI%2FWVZ3a7mcfq%0A7FhC8t6jU6sz9uIvYHAzywcVdmhEK5rS%2FuE%2F9e37h46jn2%2BkzlIWEe%2FYgpa%2BuWdT%0AO%2BOyqteW51LEjXLWMyP8AJEq8EoqbqKnm4Q1g0etOQ9trrkLUnPxaSwD5R6i4KLH%0AMR%2Fh7m%2FOoz8yOhUlrCGJwX7v9qDEdaYYFLQ%3D%0A%3DMEFZ%0A-----END%20PGP%20PUBLIC%20KEY%20BLOCK-----%0A'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99ij6a:1" aria-labelledby="tab:R99ij6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99ij6a:2" aria-labelledby="tab:R99ij6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99ij6a:3" aria-labelledby="tab:R99ij6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pij6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pij6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pij6a:0" aria-labelledby="tab:R9pij6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;import_key&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;GPG&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"key_id"</span>: <span class="token string">&quot;59E79B6904616529&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Signing-and-Encryption-(GnuPG-Keys)/operation/list_public_keys" data-section-id="tag/Signing-and-Encryption-(GnuPG-Keys)/operation/list_public_keys" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_public_keys" id="operation/list_public_keys" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Signing-and-Encryption-(GnuPG-Keys)/operation/list_public_keys" aria-label="tag/Signing-and-Encryption-(GnuPG-Keys)/operation/list_public_keys"></a>Return current user&#x27;s GnuPG public keys </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the GnuPG (GPG) public keys for the
currently-authenticated account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the GnuPG (GPG) public keys for the
currently-authenticated account.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/GPG/list_public_keys</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/GPG/list_public_keys</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99mj6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99mj6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99mj6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99mj6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99mj6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99mj6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99mj6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99mj6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99mj6a:0" aria-labelledby="tab:R99mj6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  GPG <span class="token punctuation">\</span>
  list_public_keys
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99mj6a:1" aria-labelledby="tab:R99mj6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99mj6a:2" aria-labelledby="tab:R99mj6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99mj6a:3" aria-labelledby="tab:R99mj6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pmj6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pmj6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pmj6a:0" aria-labelledby="tab:R9pmj6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_public_keys&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;GPG&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"algorithm"</span>: <span class="token string">&quot;DSA&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"bits"</span>: <span class="token number">2048</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token string">&quot;1559238435&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires"</span>: <span class="token string">&quot;1590774435&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;C801294347601B8F&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;pub&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">&quot;bender (is great) &lt;bender@example.com&gt;&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Signing-and-Encryption-(GnuPG-Keys)/operation/list_secret_keys" data-section-id="tag/Signing-and-Encryption-(GnuPG-Keys)/operation/list_secret_keys" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_secret_keys" id="operation/list_secret_keys" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Signing-and-Encryption-(GnuPG-Keys)/operation/list_secret_keys" aria-label="tag/Signing-and-Encryption-(GnuPG-Keys)/operation/list_secret_keys"></a>Return current user&#x27;s GnuPG secret keys </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the GnuPG (GPG) secret keys for the currently-authenticated account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the GnuPG (GPG) secret keys for the currently-authenticated account.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/GPG/list_secret_keys</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/GPG/list_secret_keys</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99qj6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99qj6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99qj6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99qj6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99qj6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99qj6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99qj6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99qj6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99qj6a:0" aria-labelledby="tab:R99qj6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  GPG <span class="token punctuation">\</span>
  list_secret_keys
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99qj6a:1" aria-labelledby="tab:R99qj6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99qj6a:2" aria-labelledby="tab:R99qj6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99qj6a:3" aria-labelledby="tab:R99qj6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pqj6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pqj6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pqj6a:0" aria-labelledby="tab:R9pqj6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_secret_keys&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;GPG&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"algorithm"</span>: <span class="token string">&quot;DSA&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"bits"</span>: <span class="token number">2048</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token number">1559238435</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires"</span>: <span class="token number">1590774435</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;738538C1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sec&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">&quot;username (John Doe) &lt;username@example.com&gt;&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Signing-and-Encryption-(GnuPG-Keys)/operation/generate_key" data-section-id="tag/Signing-and-Encryption-(GnuPG-Keys)/operation/generate_key" class="sc-dntaoT ceciOs"><div data-section-id="operation/generate_key" id="operation/generate_key" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Signing-and-Encryption-(GnuPG-Keys)/operation/generate_key" aria-label="tag/Signing-and-Encryption-(GnuPG-Keys)/operation/generate_key"></a>Create GnuPG key </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function generates a GnuPG (GPG) key. The system saves the key in the user&amp;#39;s &lt;code&gt;.gnupg&lt;/code&gt; directory.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This function uses &lt;a href=&quot;https://en.wikipedia.org/wiki/Entropy_(computing)&quot;&gt;the system&amp;#39;s entropy&lt;/a&gt; to generate the key. Systems with low entropy levels may cause long generation times or timeouts.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function generates a GnuPG (GPG) key. The system saves the key in the user&#39;s <code>.gnupg</code> directory.</p>
<p><strong>Note:</strong></p>
<p>This function uses <a href="https://en.wikipedia.org/wiki/Entropy_(computing)">the system&#39;s entropy</a> to generate the key. Systems with low entropy levels may cause long generation times or timeouts.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="comment" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">comment</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">null</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">comment=Username&#x27;s Key</span></div><div><div html="&lt;p&gt;A comment about the key.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A comment about the key.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user@example.com</span></div><div><div html="&lt;p&gt;The user&amp;#39;s email address.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user&#39;s email address.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="expire" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">expire</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">expire=1560363242</span></div><div><div html="&lt;p&gt;The desired expiration date of the key
as a timestamp in &lt;a href=&quot;http://en.wikipedia.org/wiki/Unix_time&quot;&gt;Unix time format&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This will default to one year from the current date.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The desired expiration date of the key
as a timestamp in <a href="http://en.wikipedia.org/wiki/Unix_time">Unix time format</a>.</p>
<p><strong>Note:</strong></p>
<p>This will default to one year from the current date.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="keysize" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">keysize</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> [ 1024 .. 4096 ] </span></span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">2048</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1024</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">2048</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">3072</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">4096</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">keysize=2048</span></div><div><div html="&lt;p&gt;The new key&amp;#39;s size, in bytes.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;Large keys require more time to generate.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new key&#39;s size, in bytes.</p>
<p><strong>Note:</strong></p>
<p>Large keys require more time to generate.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">name</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;username&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=username</span></div><div><div html="&lt;p&gt;The name of the user for whom to generate the key.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the user for whom to generate the key.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="no_expire" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">no_expire</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">no_expire=0</span></div><div><div html="&lt;p&gt;Whether to generate the key without an expiration date.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - The key will expire.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - The key will &lt;strong&gt;not&lt;/strong&gt; expire.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to generate the key without an expiration date.</p>
<ul>
<li><code>0</code> - The key will expire.</li>
<li><code>1</code> - The key will <strong>not</strong> expire.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="passphrase" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">passphrase</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">null</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">passphrase=123456luggage</span></div><div><div html="&lt;p&gt;The key&amp;#39;s password.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key&#39;s password.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/GPG/generate_key</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/GPG/generate_key</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99uj6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99uj6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99uj6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99uj6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99uj6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99uj6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99uj6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99uj6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99uj6a:0" aria-labelledby="tab:R99uj6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  GPG <span class="token punctuation">\</span>
  generate_key <span class="token punctuation">\</span>
  <span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'username'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'user@example.com'</span>
  <span class="token assign-left variable">passphrase</span><span class="token operator">=</span><span class="token string">'123456luggage'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99uj6a:1" aria-labelledby="tab:R99uj6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99uj6a:2" aria-labelledby="tab:R99uj6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99uj6a:3" aria-labelledby="tab:R99uj6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9puj6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9puj6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9puj6a:0" aria-labelledby="tab:R9puj6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;generate_key&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;GPG&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Filtering-(Greylisting)" data-section-id="tag/Spam-Filtering-(Greylisting)" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Filtering-(Greylisting)" aria-label="tag/Spam-Filtering-(Greylisting)"></a>Spam Filtering (Greylisting)</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Email / Spam Filtering (Greylisting)&lt;/p&gt;
"><p>Email / Spam Filtering (Greylisting)</p>
</div></div></div><div id="tag/Spam-Filtering-(Greylisting)/operation/has_greylisting_enabled" data-section-id="tag/Spam-Filtering-(Greylisting)/operation/has_greylisting_enabled" class="sc-dntaoT ceciOs"><div data-section-id="operation/has_greylisting_enabled" id="operation/has_greylisting_enabled" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Filtering-(Greylisting)/operation/has_greylisting_enabled" aria-label="tag/Spam-Filtering-(Greylisting)/operation/has_greylisting_enabled"></a>Return whether Greylisting is enabled </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function checks whether Greylisting is enabled for the cPanel account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether Greylisting is enabled for the cPanel account.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/cPGreyList/has_greylisting_enabled</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/cPGreyList/has_greylisting_enabled</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R996l6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R996l6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R996l6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R996l6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R996l6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R996l6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R996l6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R996l6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R996l6a:0" aria-labelledby="tab:R996l6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  cPGreyList <span class="token punctuation">\</span>
  has_greylisting_enabled
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R996l6a:1" aria-labelledby="tab:R996l6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R996l6a:2" aria-labelledby="tab:R996l6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R996l6a:3" aria-labelledby="tab:R996l6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p6l6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p6l6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p6l6a:0" aria-labelledby="tab:R9p6l6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;has_greylisting_enabled&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;cPGreyList&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Filtering-(Greylisting)/operation/cPGreyList-enable_all_domains" data-section-id="tag/Spam-Filtering-(Greylisting)/operation/cPGreyList-enable_all_domains" class="sc-dntaoT ceciOs"><div data-section-id="operation/cPGreyList-enable_all_domains" id="operation/cPGreyList-enable_all_domains" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Filtering-(Greylisting)/operation/cPGreyList-enable_all_domains" aria-label="tag/Spam-Filtering-(Greylisting)/operation/cPGreyList-enable_all_domains"></a>Enable Greylisting for all domains </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function enables Greylisting on all of the cPanel account&amp;#39;s domains.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables Greylisting on all of the cPanel account&#39;s domains.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/cPGreyList/enable_all_domains</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/cPGreyList/enable_all_domains</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99al6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99al6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99al6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99al6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99al6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99al6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99al6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99al6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99al6a:0" aria-labelledby="tab:R99al6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  cPGreyList <span class="token punctuation">\</span>
  enable_all_domains
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99al6a:1" aria-labelledby="tab:R99al6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99al6a:2" aria-labelledby="tab:R99al6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99al6a:3" aria-labelledby="tab:R99al6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pal6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pal6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pal6a:0" aria-labelledby="tab:R9pal6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;enable_all_domains&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;cPGreyList&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dependencies"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;this.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;that.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;theother.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchhint"</span>: <span class="token string">&quot;this, that, and the other.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;main&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Filtering-(Greylisting)/operation/cPGreyList-disable_all_domains" data-section-id="tag/Spam-Filtering-(Greylisting)/operation/cPGreyList-disable_all_domains" class="sc-dntaoT ceciOs"><div data-section-id="operation/cPGreyList-disable_all_domains" id="operation/cPGreyList-disable_all_domains" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Filtering-(Greylisting)/operation/cPGreyList-disable_all_domains" aria-label="tag/Spam-Filtering-(Greylisting)/operation/cPGreyList-disable_all_domains"></a>Disable Greylisting for all domains </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function disables Greylisting on a cPanel account&amp;#39;s domains.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables Greylisting on a cPanel account&#39;s domains.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/cPGreyList/disable_all_domains</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/cPGreyList/disable_all_domains</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99el6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99el6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99el6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99el6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99el6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99el6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99el6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99el6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99el6a:0" aria-labelledby="tab:R99el6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  cPGreyList <span class="token punctuation">\</span>
  disable_all_domains
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99el6a:1" aria-labelledby="tab:R99el6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99el6a:2" aria-labelledby="tab:R99el6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99el6a:3" aria-labelledby="tab:R99el6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pel6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pel6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pel6a:0" aria-labelledby="tab:R9pel6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;disable_all_domains&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;cPGreyList&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dependencies"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;this.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;that.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;theother.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchhint"</span>: <span class="token string">&quot;this, that, the other&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;main&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Filtering-(Greylisting)/operation/cPGreyList-disable_domains" data-section-id="tag/Spam-Filtering-(Greylisting)/operation/cPGreyList-disable_domains" class="sc-dntaoT ceciOs"><div data-section-id="operation/cPGreyList-disable_domains" id="operation/cPGreyList-disable_domains" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Filtering-(Greylisting)/operation/cPGreyList-disable_domains" aria-label="tag/Spam-Filtering-(Greylisting)/operation/cPGreyList-disable_domains"></a>Disable Greylisting for specified domains </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function disables Greylisting on a cPanel account&amp;#39;s selected domains.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables Greylisting on a cPanel account&#39;s selected domains.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domains" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domains</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domains=domain=example.com domain=example1.com domain=example2.com</span> - Multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domains=example.com</span> - A single domain.</li></ul><div><div html="&lt;p&gt;The domain on which to disable Greylisting.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To disable Greylisting on multiple domains, use the &lt;code&gt;domains&lt;/code&gt; parameter multiple times.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain on which to disable Greylisting.</p>
<p><strong>Note:</strong></p>
<p>To disable Greylisting on multiple domains, use the <code>domains</code> parameter multiple times.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/cPGreyList/disable_domains</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/cPGreyList/disable_domains</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99il6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99il6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99il6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99il6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99il6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99il6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99il6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99il6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99il6a:0" aria-labelledby="tab:R99il6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  cPGreyList <span class="token punctuation">\</span>
  disable_domains <span class="token punctuation">\</span>
  <span class="token assign-left variable">domains</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99il6a:1" aria-labelledby="tab:R99il6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99il6a:2" aria-labelledby="tab:R99il6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99il6a:3" aria-labelledby="tab:R99il6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pil6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pil6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pil6a:0" aria-labelledby="tab:R9pil6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;disable_domains&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;cPGreyList&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dependencies"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;this.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;that.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;theother.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchhint"</span>: <span class="token string">&quot;this, that, the other&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;main&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Filtering-(Greylisting)/operation/cPGreyList::list_domains" data-section-id="tag/Spam-Filtering-(Greylisting)/operation/cPGreyList::list_domains" class="sc-dntaoT ceciOs"><div data-section-id="operation/cPGreyList::list_domains" id="operation/cPGreyList::list_domains" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Filtering-(Greylisting)/operation/cPGreyList::list_domains" aria-label="tag/Spam-Filtering-(Greylisting)/operation/cPGreyList::list_domains"></a>Return Greylisting status for domains </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns Greylisting&amp;#39;s status for a cPanel account&amp;#39;s domains.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns Greylisting&#39;s status for a cPanel account&#39;s domains.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/cPGreyList/list_domains</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/cPGreyList/list_domains</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99ml6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99ml6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99ml6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99ml6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99ml6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99ml6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99ml6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99ml6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99ml6a:0" aria-labelledby="tab:R99ml6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  cPGreyList <span class="token punctuation">\</span>
  list_domains
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99ml6a:1" aria-labelledby="tab:R99ml6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99ml6a:2" aria-labelledby="tab:R99ml6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99ml6a:3" aria-labelledby="tab:R99ml6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pml6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pml6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pml6a:0" aria-labelledby="tab:R9pml6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_domains&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;cPGreyList&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"cPGreyList"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"total_disabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total_enabled"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dependencies"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;this.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;that.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;theother.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchhint"</span>: <span class="token string">&quot;this, that, and the other.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;main&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Filtering-(Greylisting)/operation/cPGreyList-enable_domains" data-section-id="tag/Spam-Filtering-(Greylisting)/operation/cPGreyList-enable_domains" class="sc-dntaoT ceciOs"><div data-section-id="operation/cPGreyList-enable_domains" id="operation/cPGreyList-enable_domains" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Filtering-(Greylisting)/operation/cPGreyList-enable_domains" aria-label="tag/Spam-Filtering-(Greylisting)/operation/cPGreyList-enable_domains"></a>Enable Greylisting for specified domains </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function enables Greylisting on a cPanel account&amp;#39;s selected domains.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables Greylisting on a cPanel account&#39;s selected domains.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domains" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domains</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domains=domain=example.com&amp;domain=example1.com&amp;domain=example2.com</span> - Multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domains=example.com</span> - A single domain.</li></ul><div><div html="&lt;p&gt;The domain on which to enable Greylisting.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; To enable Greylisting on multiple domains, use the &lt;code&gt;domains&lt;/code&gt; parameter multiple times.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain on which to enable Greylisting.</p>
<p><strong>Note:</strong></p>
<p> To enable Greylisting on multiple domains, use the <code>domains</code> parameter multiple times.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/cPGreyList/enable_domains</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/cPGreyList/enable_domains</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99ql6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99ql6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99ql6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99ql6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99ql6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99ql6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99ql6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99ql6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99ql6a:0" aria-labelledby="tab:R99ql6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  cPGreyList <span class="token punctuation">\</span>
  enable_domains <span class="token punctuation">\</span>
  <span class="token assign-left variable">domains</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99ql6a:1" aria-labelledby="tab:R99ql6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99ql6a:2" aria-labelledby="tab:R99ql6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99ql6a:3" aria-labelledby="tab:R99ql6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pql6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pql6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pql6a:0" aria-labelledby="tab:R9pql6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;enable_domains&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;cPGreyList&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dependencies"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;example1.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;example2.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchhint"</span>: <span class="token string">&quot;example, example1, example2&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;main&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Management" data-section-id="tag/Spam-Management" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Management" aria-label="tag/Spam-Management"></a>Spam Management</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Email / Spam Management&lt;/p&gt;
"><p>Email / Spam Management</p>
</div></div></div><div id="tag/Spam-Management/operation/disable_spam_assassin" data-section-id="tag/Spam-Management/operation/disable_spam_assassin" class="sc-dntaoT ceciOs"><div data-section-id="operation/disable_spam_assassin" id="operation/disable_spam_assassin" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Management/operation/disable_spam_assassin" aria-label="tag/Spam-Management/operation/disable_spam_assassin"></a>Disable Apache SpamAssassin for cPanel account </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function disables Apache SpamAssassin™ for a cPanel account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Spam Filter&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables Apache SpamAssassin™ for a cPanel account.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>Spam Filter</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/disable_spam_assassin</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/disable_spam_assassin</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rii6n6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rii6n6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rii6n6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii6n6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rii6n6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii6n6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rii6n6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii6n6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rii6n6a:0" aria-labelledby="tab:Rii6n6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  disable_spam_assassin
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii6n6a:1" aria-labelledby="tab:Rii6n6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii6n6a:2" aria-labelledby="tab:Rii6n6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii6n6a:3" aria-labelledby="tab:Rii6n6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rji6n6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rji6n6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rji6n6a:0" aria-labelledby="tab:Rji6n6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;disable_spam_assassin&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;Apache SpamAssassin™ has been disabled.&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Management/operation/disable_spam_autodelete" data-section-id="tag/Spam-Management/operation/disable_spam_autodelete" class="sc-dntaoT ceciOs"><div data-section-id="operation/disable_spam_autodelete" id="operation/disable_spam_autodelete" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Management/operation/disable_spam_autodelete" aria-label="tag/Spam-Management/operation/disable_spam_autodelete"></a>Disable spam box filtering auto-delete </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function disables the Apache SpamAssassin™ auto-delete spam feature.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables the Apache SpamAssassin™ auto-delete spam feature.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/disable_spam_autodelete</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/disable_spam_autodelete</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riian6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riian6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riian6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riian6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riian6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riian6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riian6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riian6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riian6a:0" aria-labelledby="tab:Riian6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  disable_spam_autodelete
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riian6a:1" aria-labelledby="tab:Riian6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riian6a:2" aria-labelledby="tab:Riian6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riian6a:3" aria-labelledby="tab:Riian6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjian6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjian6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjian6a:0" aria-labelledby="tab:Rjian6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;disable_spam_autodelete&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"spam_auto_delete"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Management/operation/disable_spam_box" data-section-id="tag/Spam-Management/operation/disable_spam_box" class="sc-dntaoT ceciOs"><div data-section-id="operation/disable_spam_box" id="operation/disable_spam_box" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Management/operation/disable_spam_box" aria-label="tag/Spam-Management/operation/disable_spam_box"></a>Disable spam box filtering for cPanel account </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function disables spam box filtering for a cPanel account. When you disable spam box filtering, the system sends all messages to the account&amp;#39;s inbox.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Notes:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;This function &lt;strong&gt;requires&lt;/strong&gt; that your hosting provider enables Apache SpamAssassin™ on the server.&lt;/li&gt;
&lt;li&gt;To &lt;strong&gt;enable&lt;/strong&gt; spam box filtering, use the UAPI &lt;code&gt;Email::enable_spam_box&lt;/code&gt; function.&lt;/li&gt;
&lt;li&gt;For more information, read our &lt;a href=&quot;https://go.cpanel.net/cpaneldocsSpamFilters&quot;&gt;Spam Filters&lt;/a&gt; documentation.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Spam Filter&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables spam box filtering for a cPanel account. When you disable spam box filtering, the system sends all messages to the account&#39;s inbox.</p>
<p><strong>Notes:</strong></p>
<ul>
<li>This function <strong>requires</strong> that your hosting provider enables Apache SpamAssassin™ on the server.</li>
<li>To <strong>enable</strong> spam box filtering, use the UAPI <code>Email::enable_spam_box</code> function.</li>
<li>For more information, read our <a href="https://go.cpanel.net/cpaneldocsSpamFilters">Spam Filters</a> documentation.</li>
</ul>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>Spam Filter</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/disable_spam_box</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/disable_spam_box</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riien6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riien6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riien6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riien6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riien6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riien6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riien6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riien6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riien6a:0" aria-labelledby="tab:Riien6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  disable_spam_box
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riien6a:1" aria-labelledby="tab:Riien6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riien6a:2" aria-labelledby="tab:Riien6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riien6a:3" aria-labelledby="tab:Riien6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjien6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjien6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjien6a:0" aria-labelledby="tab:Rjien6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;disable_spam_box&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Management/operation/enable_spam_box" data-section-id="tag/Spam-Management/operation/enable_spam_box" class="sc-dntaoT ceciOs"><div data-section-id="operation/enable_spam_box" id="operation/enable_spam_box" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Management/operation/enable_spam_box" aria-label="tag/Spam-Management/operation/enable_spam_box"></a>Enable spam box filtering for cPanel account </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function enables spam box filtering for a cPanel account. When you enable spam box filtering, the system sends messages marked as spam to a spam folder.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Notes:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;This function &lt;strong&gt;requires&lt;/strong&gt; that your hosting provider enables Apache SpamAssassin on the server.&lt;/li&gt;
&lt;li&gt;To &lt;strong&gt;disable&lt;/strong&gt; spam box filtering, use the UAPI &lt;code&gt;Email::disable_spam_box&lt;/code&gt; function.&lt;/li&gt;
&lt;li&gt;For more information, read our &lt;a href=&quot;https://go.cpanel.net/cpaneldocsSpamFilters&quot;&gt;Spam Filters&lt;/a&gt; documentation.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Spam Filter&lt;/a&gt; role, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables spam box filtering for a cPanel account. When you enable spam box filtering, the system sends messages marked as spam to a spam folder.</p>
<p><strong>Notes:</strong></p>
<ul>
<li>This function <strong>requires</strong> that your hosting provider enables Apache SpamAssassin on the server.</li>
<li>To <strong>disable</strong> spam box filtering, use the UAPI <code>Email::disable_spam_box</code> function.</li>
<li>For more information, read our <a href="https://go.cpanel.net/cpaneldocsSpamFilters">Spam Filters</a> documentation.</li>
</ul>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Spam Filter</a> role, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/enable_spam_box</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/enable_spam_box</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiin6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiin6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiin6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiin6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riiin6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiin6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riiin6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiin6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiin6a:0" aria-labelledby="tab:Riiin6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  enable_spam_box
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiin6a:1" aria-labelledby="tab:Riiin6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiin6a:2" aria-labelledby="tab:Riiin6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiin6a:3" aria-labelledby="tab:Riiin6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjiin6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiin6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiin6a:0" aria-labelledby="tab:Rjiin6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;enable_spam_box&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Management/operation/enable_spam_assassin" data-section-id="tag/Spam-Management/operation/enable_spam_assassin" class="sc-dntaoT ceciOs"><div data-section-id="operation/enable_spam_assassin" id="operation/enable_spam_assassin" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Management/operation/enable_spam_assassin" aria-label="tag/Spam-Management/operation/enable_spam_assassin"></a>Enable Apache SpamAssassin for cPanel account </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function enables Apache SpamAssassin™ for the account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Spam Filter role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables Apache SpamAssassin™ for the account.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Spam Filter role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/enable_spam_assassin</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/enable_spam_assassin</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riimn6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riimn6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riimn6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riimn6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riimn6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riimn6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riimn6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riimn6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riimn6a:0" aria-labelledby="tab:Riimn6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  enable_spam_assassin
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riimn6a:1" aria-labelledby="tab:Riimn6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riimn6a:2" aria-labelledby="tab:Riimn6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riimn6a:3" aria-labelledby="tab:Riimn6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjimn6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjimn6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjimn6a:0" aria-labelledby="tab:Rjimn6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;enable_spam_assassin&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Management/operation/get_spam_settings" data-section-id="tag/Spam-Management/operation/get_spam_settings" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_spam_settings" id="operation/get_spam_settings" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Management/operation/get_spam_settings" aria-label="tag/Spam-Management/operation/get_spam_settings"></a>Return email account Apache SpamAssassin settings </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves the Apache SpamAssassin™ settings for the account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;SpamFilter role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the Apache SpamAssassin™ settings for the account.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">SpamFilter role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="account" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">account</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">account=username@example.com</span></div><div><div html="&lt;p&gt;Retrieve a specific user account&amp;#39;s SpamAssassin settings.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If you do &lt;strong&gt;not&lt;/strong&gt; specify this parameter, the function returns the settings for &lt;a href=&quot;https://go.cpanel.net/DefaultAddress&quot;&gt;the default email account&lt;/a&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Retrieve a specific user account&#39;s SpamAssassin settings.</p>
<p><strong>Note:</strong></p>
<p>If you do <strong>not</strong> specify this parameter, the function returns the settings for <a href="https://go.cpanel.net/DefaultAddress">the default email account</a>.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/get_spam_settings</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/get_spam_settings</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiqn6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiqn6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiqn6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiqn6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riiqn6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiqn6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riiqn6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiqn6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiqn6a:0" aria-labelledby="tab:Riiqn6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  get_spam_settings
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiqn6a:1" aria-labelledby="tab:Riiqn6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiqn6a:2" aria-labelledby="tab:Riiqn6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiqn6a:3" aria-labelledby="tab:Riiqn6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjiqn6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiqn6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiqn6a:0" aria-labelledby="tab:Rjiqn6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_spam_settings&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"cpuser_spam_auto_delete"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cpuser_spam_auto_delete_score"</span>: <span class="token number">8</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rewrites_subjects"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"spam_as_acl"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"spam_auto_delete"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"spam_auto_delete_score"</span>: <span class="token number">8</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"spam_box_enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"spam_enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"spam_status_changeable"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Management/operation/clear_spam_box" data-section-id="tag/Spam-Management/operation/clear_spam_box" class="sc-dntaoT ceciOs"><div data-section-id="operation/clear_spam_box" id="operation/clear_spam_box" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Management/operation/clear_spam_box" aria-label="tag/Spam-Management/operation/clear_spam_box"></a>Delete spam box contents </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function clears the spam box of all its contents for all email accounts.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This function deletes the Spam Box folder contents for every email address on the account, which includes the system user email account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function clears the spam box of all its contents for all email accounts.</p>
<p><strong>Important:</strong></p>
<p>This function deletes the Spam Box folder contents for every email address on the account, which includes the system user email account.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SpamAssassin/clear_spam_box</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SpamAssassin/clear_spam_box</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiun6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiun6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiun6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiun6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riiun6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiun6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riiun6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiun6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiun6a:0" aria-labelledby="tab:Riiun6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SpamAssassin <span class="token punctuation">\</span>
  clear_spam_box
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiun6a:1" aria-labelledby="tab:Riiun6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiun6a:2" aria-labelledby="tab:Riiun6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiun6a:3" aria-labelledby="tab:Riiun6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjiun6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiun6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiun6a:0" aria-labelledby="tab:Rjiun6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;clear_spam_box&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SpamAssassin&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Management/operation/get_symbolic_test_names" data-section-id="tag/Spam-Management/operation/get_symbolic_test_names" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_symbolic_test_names" id="operation/get_symbolic_test_names" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Management/operation/get_symbolic_test_names" aria-label="tag/Spam-Management/operation/get_symbolic_test_names"></a>Return SpamAssassin™ symbolic test scores </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the Apache SpamAssassin™ scores for each symbolic test.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the Apache SpamAssassin™ scores for each symbolic test.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="errors" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">errors</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">any</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="messages" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">messages</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">any</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr><tr class="last "><td kind="field" title="status" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">status</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">any</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SpamAssassin/get_symbolic_test_names</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SpamAssassin/get_symbolic_test_names</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rij2n6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rij2n6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rij2n6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij2n6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rij2n6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij2n6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rij2n6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij2n6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rij2n6a:0" aria-labelledby="tab:Rij2n6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SpamAssassin <span class="token punctuation">\</span>
  get_symbolic_test_names
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij2n6a:1" aria-labelledby="tab:Rij2n6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij2n6a:2" aria-labelledby="tab:Rij2n6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij2n6a:3" aria-labelledby="tab:Rij2n6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjj2n6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj2n6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj2n6a:0" aria-labelledby="tab:Rjj2n6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_symbolic_test_names&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SpamAssassin&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">&quot;ACT_NOW_ALL_CAPS&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rule_type"</span>: <span class="token string">&quot;body_tests&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"score"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Management/operation/update_user_preference" data-section-id="tag/Spam-Management/operation/update_user_preference" class="sc-dntaoT ceciOs"><div data-section-id="operation/update_user_preference" id="operation/update_user_preference" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Management/operation/update_user_preference" aria-label="tag/Spam-Management/operation/update_user_preference"></a>Update SpamAssassin™ settings </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function sets the Apache SpamAssassin™ settings for the account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;Additional customizations may appear in the function&amp;#39;s return. For more information,
read the &lt;a href=&quot;https://spamassassin.apache.org/full/3.1.x/doc/Mail_SpamAssassin_Conf.html#user_preferences&quot;&gt;Apache SpamAssassin configuration file documentation&lt;/a&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets the Apache SpamAssassin™ settings for the account.</p>
<p><strong>Note:</strong></p>
<p>Additional customizations may appear in the function&#39;s return. For more information,
read the <a href="https://spamassassin.apache.org/full/3.1.x/doc/Mail_SpamAssassin_Conf.html#user_preferences">Apache SpamAssassin configuration file documentation</a>.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="preference" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">preference</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">preference=score</span></div><div><div html="&lt;p&gt;The variable that you want to manipulate.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;score&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;required_score&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;whitelist_from&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;blacklist_from&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;A &lt;a href=&quot;https://spamassassin.apache.org/full/3.1.x/doc/Mail_SpamAssassin_Conf.html#user_preferences&quot;&gt;custom SpamAssassin variable&lt;/a&gt;.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;You can &lt;strong&gt;only&lt;/strong&gt; choose one of these possible values per call.&lt;/li&gt;
&lt;li&gt;If you enter a value for the &lt;code&gt;preference&lt;/code&gt; parameter, but you do &lt;strong&gt;not&lt;/strong&gt; define a value for the &lt;code&gt;value&lt;/code&gt; parameter, the function will remove any previous settings.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The variable that you want to manipulate.</p>
<ul>
<li><code>score</code></li>
<li><code>required_score</code></li>
<li><code>whitelist_from</code></li>
<li><code>blacklist_from</code></li>
<li>A <a href="https://spamassassin.apache.org/full/3.1.x/doc/Mail_SpamAssassin_Conf.html#user_preferences">custom SpamAssassin variable</a>.</li>
</ul>
<p><strong>Important:</strong></p>
<ul>
<li>You can <strong>only</strong> choose one of these possible values per call.</li>
<li>If you enter a value for the <code>preference</code> parameter, but you do <strong>not</strong> define a value for the <code>value</code> parameter, the function will remove any previous settings.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="value" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">value</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">value=value-0=ACT_NOW_CAPS 5.0 value-1=INVALID_DATE 3.2</span> - Define multiple variable values.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">value=ACT_NOW_CAPS 5.0</span> - Define a single variable value.</li></ul><div><div html="&lt;p&gt;The value for the preference of the variable that you want to manipulate.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;p&gt;A valid SpamAssassin &amp;quot;&lt;code&gt;TEST_NAME SCORE&lt;/code&gt;&amp;quot; value when the value of the &lt;code&gt;preference&lt;/code&gt; parameter is &lt;code&gt;score&lt;/code&gt;, where:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;TEST_NAME&lt;/code&gt; represents the symbolic name of the test. For list of symbolic test names, run the UAPI &lt;code&gt;SpamAssassin::get_symbolic_test_names&lt;/code&gt; function.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;SCORE&lt;/code&gt; represents the floating-point value that SpamAssassin assigns to the mail when the test result is true. The score value must be greater than &lt;code&gt;0&lt;/code&gt;, and less than &lt;code&gt;1000&lt;/code&gt;.&lt;/li&gt;
&lt;/ul&gt;
&lt;/li&gt;
&lt;li&gt;&lt;p&gt;A valid floating-point number if the value of the &lt;code&gt;preference&lt;/code&gt; parameter is &lt;code&gt;required_score&lt;/code&gt;.&lt;/p&gt;
&lt;/li&gt;
&lt;li&gt;&lt;p&gt;A valid email address if the value of the &lt;code&gt;preference&lt;/code&gt; parameter is &lt;code&gt;whitelist_from&lt;/code&gt; or &lt;code&gt;blacklist_from&lt;/code&gt;.&lt;/p&gt;
&lt;/li&gt;
&lt;li&gt;&lt;p&gt;A &lt;a href=&quot;https://spamassassin.apache.org/full/3.1.x/doc/Mail_SpamAssassin_Conf.html#user_preferences&quot;&gt;custom SpamAssassin variable&lt;/a&gt; value.&lt;/p&gt;
&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To enter multiple values, increment the parameter name. For example, use the &lt;code&gt;value-0&lt;/code&gt; and &lt;code&gt;value-1&lt;/code&gt; parameters.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The value for the preference of the variable that you want to manipulate.</p>
<ul>
<li><p>A valid SpamAssassin &quot;<code>TEST_NAME SCORE</code>&quot; value when the value of the <code>preference</code> parameter is <code>score</code>, where:</p>
<ul>
<li><code>TEST_NAME</code> represents the symbolic name of the test. For list of symbolic test names, run the UAPI <code>SpamAssassin::get_symbolic_test_names</code> function.</li>
<li><code>SCORE</code> represents the floating-point value that SpamAssassin assigns to the mail when the test result is true. The score value must be greater than <code>0</code>, and less than <code>1000</code>.</li>
</ul>
</li>
<li><p>A valid floating-point number if the value of the <code>preference</code> parameter is <code>required_score</code>.</p>
</li>
<li><p>A valid email address if the value of the <code>preference</code> parameter is <code>whitelist_from</code> or <code>blacklist_from</code>.</p>
</li>
<li><p>A <a href="https://spamassassin.apache.org/full/3.1.x/doc/Mail_SpamAssassin_Conf.html#user_preferences">custom SpamAssassin variable</a> value.</p>
</li>
</ul>
<p><strong>Note:</strong></p>
<p>To enter multiple values, increment the parameter name. For example, use the <code>value-0</code> and <code>value-1</code> parameters.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SpamAssassin/update_user_preference</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SpamAssassin/update_user_preference</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rij6n6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rij6n6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rij6n6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij6n6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rij6n6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij6n6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rij6n6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij6n6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rij6n6a:0" aria-labelledby="tab:Rij6n6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SpamAssassin <span class="token punctuation">\</span>
  update_user_preference <span class="token punctuation">\</span>
  <span class="token assign-left variable">preference</span><span class="token operator">=</span><span class="token string">'score'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij6n6a:1" aria-labelledby="tab:Rij6n6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij6n6a:2" aria-labelledby="tab:Rij6n6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij6n6a:3" aria-labelledby="tab:Rij6n6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjj6n6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj6n6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj6n6a:0" aria-labelledby="tab:Rjj6n6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;update_user_preference&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SpamAssassin&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"blacklist_from"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;username2@example.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ok_locales"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;all&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"required_score"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">5</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"score"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;ACT_NOW_CAPS 5&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"whitelist_from"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;username@example.com&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Management/operation/get_user_preferences" data-section-id="tag/Spam-Management/operation/get_user_preferences" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_user_preferences" id="operation/get_user_preferences" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Management/operation/get_user_preferences" aria-label="tag/Spam-Management/operation/get_user_preferences"></a>Return SpamAssassin™ settings </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the Apache SpamAssassin™ settings for the account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;Additional customizations may appear in the returns. Form more information read the &lt;a href=&quot;https://spamassassin.apache.org/full/3.1.x/doc/Mail_SpamAssassin_Conf.html#user_preferences&quot;&gt;Apache SpamAssassin™ configuration file&lt;/a&gt; documentation.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the Apache SpamAssassin™ settings for the account.</p>
<p><strong>Note:</strong></p>
<p>Additional customizations may appear in the returns. Form more information read the <a href="https://spamassassin.apache.org/full/3.1.x/doc/Mail_SpamAssassin_Conf.html#user_preferences">Apache SpamAssassin™ configuration file</a> documentation.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SpamAssassin/get_user_preferences</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SpamAssassin/get_user_preferences</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rijan6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rijan6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rijan6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijan6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rijan6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijan6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rijan6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijan6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rijan6a:0" aria-labelledby="tab:Rijan6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SpamAssassin <span class="token punctuation">\</span>
  get_user_preferences
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijan6a:1" aria-labelledby="tab:Rijan6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijan6a:2" aria-labelledby="tab:Rijan6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijan6a:3" aria-labelledby="tab:Rijan6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjjan6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjjan6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjjan6a:0" aria-labelledby="tab:Rjjan6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_user_preferences&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SpamAssassin&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"blacklist_from"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;username2@example.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"required_score"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token number">5.1</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"score"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;ACT_NOW_CAPS 1&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"whitelist_from"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;username@example.com&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Management/operation/add_spam_filter" data-section-id="tag/Spam-Management/operation/add_spam_filter" class="sc-dntaoT ceciOs"><div data-section-id="operation/add_spam_filter" id="operation/add_spam_filter" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Management/operation/add_spam_filter" aria-label="tag/Spam-Management/operation/add_spam_filter"></a>Update minimum spam score threshold value </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function sets a new minimum Apache SpamAssassin™ spam score threshold value.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Notes:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;To disable spam filtering, use the UAPI &lt;code&gt;Email::disable_spam_autodelete&lt;/code&gt; fuction.&lt;/li&gt;
&lt;li&gt;For more information, read our &lt;a href=&quot;https://go.cpanel.net/cpaneldocsSpamFilters&quot;&gt;Spam Filters&lt;/a&gt; documentation.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles#roles&quot;&gt;&lt;em&gt;Spam Filter&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets a new minimum Apache SpamAssassin™ spam score threshold value.</p>
<p><strong>Notes:</strong></p>
<ul>
<li>To disable spam filtering, use the UAPI <code>Email::disable_spam_autodelete</code> fuction.</li>
<li>For more information, read our <a href="https://go.cpanel.net/cpaneldocsSpamFilters">Spam Filters</a> documentation.</li>
</ul>
<p><strong>Important:</strong></p>
<ul>
<li>When you disable the <a href="https://go.cpanel.net/serverroles#roles"><em>Spam Filter</em> role</a>, the system <strong>disables</strong> this function.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="account" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">account</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">account=username@example.com</span></div><div><div html="&lt;p&gt;The email account to apply a spam score threshold value.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  If you do &lt;strong&gt;not&lt;/strong&gt; specify a value, the function applies the new spam score threshold value to &lt;strong&gt;all&lt;/strong&gt; accounts.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account to apply a spam score threshold value.</p>
<p><strong>Note:</strong></p>
<p>  If you do <strong>not</strong> specify a value, the function applies the new spam score threshold value to <strong>all</strong> accounts.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="required_score" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">required_score</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= 1 </span></span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">5</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">required_score=8</span></div><div><div html="&lt;p&gt;Set a spam score threshold value.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Notes:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;You &lt;strong&gt;must&lt;/strong&gt; specify a value greater than &lt;code&gt;0&lt;/code&gt;, and lower than the domain owner&amp;#39;s spam score threshold value.&lt;/li&gt;
&lt;li&gt;You &lt;strong&gt;cannot&lt;/strong&gt; enter &lt;code&gt;0&lt;/code&gt; as a value for this parameter.&lt;/li&gt;
&lt;li&gt;You can retrieve the domain owner‘s spam score threshold value via the &lt;code&gt;cpuser_spam_auto_delete_score&lt;/code&gt; return from the UAPI &lt;code&gt;Email::get_spam_settings&lt;/code&gt; function.&lt;/li&gt;
&lt;li&gt;The default value, &lt;code&gt;5&lt;/code&gt;, is an aggressive spam score.&lt;/li&gt;
&lt;li&gt;The lower the spam score, the more likely that Apache SpamAssassin will label messages as spam and delete them.&lt;/li&gt;
&lt;li&gt;Some systems may wish to use a more lenient spam score (for example, &lt;code&gt;8&lt;/code&gt; or &lt;code&gt;10&lt;/code&gt;).&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Set a spam score threshold value.</p>
<p><strong>Notes:</strong></p>
<ul>
<li>You <strong>must</strong> specify a value greater than <code>0</code>, and lower than the domain owner&#39;s spam score threshold value.</li>
<li>You <strong>cannot</strong> enter <code>0</code> as a value for this parameter.</li>
<li>You can retrieve the domain owner‘s spam score threshold value via the <code>cpuser_spam_auto_delete_score</code> return from the UAPI <code>Email::get_spam_settings</code> function.</li>
<li>The default value, <code>5</code>, is an aggressive spam score.</li>
<li>The lower the spam score, the more likely that Apache SpamAssassin will label messages as spam and delete them.</li>
<li>Some systems may wish to use a more lenient spam score (for example, <code>8</code> or <code>10</code>).</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Email/add_spam_filter</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Email/add_spam_filter</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rijen6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rijen6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rijen6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijen6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rijen6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijen6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rijen6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijen6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rijen6a:0" aria-labelledby="tab:Rijen6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Email <span class="token punctuation">\</span>
  add_spam_filter
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijen6a:1" aria-labelledby="tab:Rijen6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijen6a:2" aria-labelledby="tab:Rijen6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijen6a:3" aria-labelledby="tab:Rijen6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjjen6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjjen6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjjen6a:0" aria-labelledby="tab:Rjjen6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;add_spam_filter&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Email&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Prevention-(BoxTrapper)" data-section-id="tag/Spam-Prevention-(BoxTrapper)" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Prevention-(BoxTrapper)" aria-label="tag/Spam-Prevention-(BoxTrapper)"></a>Spam Prevention (BoxTrapper)</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Email / Spam Prevention (BoxTrapper)&lt;/p&gt;
"><p>Email / Spam Prevention (BoxTrapper)</p>
</div></div></div><div id="tag/Spam-Prevention-(BoxTrapper)/operation/set_status" data-section-id="tag/Spam-Prevention-(BoxTrapper)/operation/set_status" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_status" id="operation/set_status" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Prevention-(BoxTrapper)/operation/set_status" aria-label="tag/Spam-Prevention-(BoxTrapper)/operation/set_status"></a>Enable or disable BoxTrapper for email account </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function enables or disables BoxTrapper for an email account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail&lt;/a&gt; role, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables or disables BoxTrapper for an email account.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail</a> role, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="email" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand email"><span class="property-name">email</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user@example.com</span></div><div><div html="&lt;p&gt;The account&amp;#39;s name. This can be an email address or the cPanel user’s username.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If you call this function in Webmail, the system ignores this parameter and defaults to the currently-authenticated email address.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account&#39;s name. This can be an email address or the cPanel user’s username.</p>
<p><strong>Warning:</strong></p>
<p>If you call this function in Webmail, the system ignores this parameter and defaults to the currently-authenticated email address.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="enabled" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">enabled</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">enabled=1</span></div><div><div html="&lt;p&gt;Whether to enable or disable BoxTrapper for the email account.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Enable BoxTrapper.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - &lt;strong&gt;Disable&lt;/strong&gt; BoxTrapper.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to enable or disable BoxTrapper for the email account.</p>
<ul>
<li><code>1</code> - Enable BoxTrapper.</li>
<li><code>0</code> - <strong>Disable</strong> BoxTrapper.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/BoxTrapper/set_status</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/BoxTrapper/set_status</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R1546p6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R1546p6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R1546p6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R1546p6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R1546p6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R1546p6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R1546p6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R1546p6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R1546p6a:0" aria-labelledby="tab:R1546p6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  BoxTrapper <span class="token punctuation">\</span>
  set_status <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'user@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">enabled</span><span class="token operator">=</span><span class="token string">'1'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1546p6a:1" aria-labelledby="tab:R1546p6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1546p6a:2" aria-labelledby="tab:R1546p6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1546p6a:3" aria-labelledby="tab:R1546p6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R1746p6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R1746p6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R1746p6a:0" aria-labelledby="tab:R1746p6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_status&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;BoxTrapper&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Prevention-(BoxTrapper)/operation/blacklist_messages" data-section-id="tag/Spam-Prevention-(BoxTrapper)/operation/blacklist_messages" class="sc-dntaoT ceciOs"><div data-section-id="operation/blacklist_messages" id="operation/blacklist_messages" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Prevention-(BoxTrapper)/operation/blacklist_messages" aria-label="tag/Spam-Prevention-(BoxTrapper)/operation/blacklist_messages"></a>Add email address to BoxTrapper blocked senders </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function blacklists email message senders.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail&lt;/a&gt; role, the system disables this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function blacklists email message senders.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail</a> role, the system disables this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user@example.com</span></div><div><div html="&lt;p&gt;The email address for which to blacklist messages.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If you call this function in Webmail, the system ignores this parameter and defaults to the currently-authenticated user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email address for which to blacklist messages.</p>
<p><strong>Warning:</strong></p>
<p>If you call this function in Webmail, the system ignores this parameter and defaults to the currently-authenticated user.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="queuefile" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">queuefile</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">queuefile=queuefile=file1&amp;queuefile=file2</span> - Blacklist multiple filenames.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">queuefile=file1</span> - Blacklist one filename.</li></ul><div><div html="&lt;p&gt;The filename of the email message to blacklist.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The filename of the email message to blacklist.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/BoxTrapper/blacklist_messages</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/BoxTrapper/blacklist_messages</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R154ap6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R154ap6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R154ap6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R154ap6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R154ap6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R154ap6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R154ap6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R154ap6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R154ap6a:0" aria-labelledby="tab:R154ap6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  BoxTrapper <span class="token punctuation">\</span>
  blacklist_messages <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'user@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">queuefile</span><span class="token operator">=</span><span class="token string">'file1'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154ap6a:1" aria-labelledby="tab:R154ap6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154ap6a:2" aria-labelledby="tab:R154ap6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154ap6a:3" aria-labelledby="tab:R154ap6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R174ap6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R174ap6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R174ap6a:0" aria-labelledby="tab:R174ap6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;blacklist_messages&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;BoxTrapper&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"failed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"matches"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example.msg&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"operator"</span>: <span class="token string">&quot;blacklist&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">&quot;This is a failure message.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warning"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Prevention-(BoxTrapper)/operation/deliver_messages" data-section-id="tag/Spam-Prevention-(BoxTrapper)/operation/deliver_messages" class="sc-dntaoT ceciOs"><div data-section-id="operation/deliver_messages" id="operation/deliver_messages" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Prevention-(BoxTrapper)/operation/deliver_messages" aria-label="tag/Spam-Prevention-(BoxTrapper)/operation/deliver_messages"></a>Send messages in the BoxTrapper queue </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function delivers messages in the BoxTrapper queue.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the
&lt;a href=&quot;https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;,
the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function delivers messages in the BoxTrapper queue.</p>
<p><strong>Important:</strong></p>
<p>When you disable the
<a href="https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles"><em>Receive Mail</em> role</a>,
the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="all_like" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">all_like</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">all_like=1</span></div><div><div html="&lt;p&gt;Whether to deliver all messages that resemble the &lt;code&gt;queuefile&lt;/code&gt; parameter&amp;#39;s value.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Deliver all similar messages.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Don&amp;#39;t deliver all similar messages.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to deliver all messages that resemble the <code>queuefile</code> parameter&#39;s value.</p>
<ul>
<li><code>1</code> - Deliver all similar messages.</li>
<li><code>0</code> - Don&#39;t deliver all similar messages.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user@example.com</span></div><div><div html="&lt;p&gt;The sender&amp;#39;s cPanel account email address for which to deliver email messages.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If you call this function in Webmail, the system ignores this parameter
and defaults to the currently-authenticated email address.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The sender&#39;s cPanel account email address for which to deliver email messages.</p>
<p><strong>Warning:</strong></p>
<p>If you call this function in Webmail, the system ignores this parameter
and defaults to the currently-authenticated email address.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="queuefile" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">queuefile</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">queuefile=queuefile=example.msg&amp;queuefile=example1.msg&amp;queuefile=example2.msg</span> - Deliver multiple email messages.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">queuefile=example.msg</span> - Deliver a single email message.</li></ul><div><div html="&lt;p&gt;The filename of the email messages to deliver.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To deliver multiple email messages, pass this parameter multiple times.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The filename of the email messages to deliver.</p>
<p><strong>Note:</strong></p>
<p>To deliver multiple email messages, pass this parameter multiple times.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/BoxTrapper/deliver_messages</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/BoxTrapper/deliver_messages</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R154ep6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R154ep6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R154ep6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R154ep6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R154ep6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R154ep6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R154ep6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R154ep6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R154ep6a:0" aria-labelledby="tab:R154ep6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  BoxTrapper <span class="token punctuation">\</span>
  deliver_messages <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'user@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">queuefile</span><span class="token operator">=</span><span class="token string">'example.msg'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154ep6a:1" aria-labelledby="tab:R154ep6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154ep6a:2" aria-labelledby="tab:R154ep6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154ep6a:3" aria-labelledby="tab:R154ep6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R174ep6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R174ep6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R174ep6a:0" aria-labelledby="tab:R174ep6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;deliver_messages&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;BoxTrapper&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"failed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"matches"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example.msg&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"operator"</span>: <span class="token string">&quot;deliverall&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">&quot;This is a failure message.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warning"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::get_blocklist" data-section-id="tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::get_blocklist" class="sc-dntaoT ceciOs"><div data-section-id="operation/BoxTrapper::get_blocklist" id="operation/BoxTrapper::get_blocklist" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::get_blocklist" aria-label="tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::get_blocklist"></a>Return account BoxTrapper blocklist rules </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves a list of BoxTrapper blocklist configuration rules. BoxTrapper will delete messages that match these rules and send a notification to the sender.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the
&lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;,
the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a list of BoxTrapper blocklist configuration rules. BoxTrapper will delete messages that match these rules and send a notification to the sender.</p>
<p><strong>Important:</strong></p>
<p>When you disable the
<a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>,
the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user@example.com</span></div><div><div html="&lt;p&gt;A valid email address on the cPanel account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If you call this function in Webmail, the system overrides this parameter.
This parameter defaults to the current email address.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A valid email address on the cPanel account.</p>
<p><strong>Warning:</strong></p>
<p>If you call this function in Webmail, the system overrides this parameter.
This parameter defaults to the current email address.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/BoxTrapper/get_blocklist</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/BoxTrapper/get_blocklist</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R154ip6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R154ip6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R154ip6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R154ip6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R154ip6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R154ip6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R154ip6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R154ip6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R154ip6a:0" aria-labelledby="tab:R154ip6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  BoxTrapper <span class="token punctuation">\</span>
  get_blocklist <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'user@example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154ip6a:1" aria-labelledby="tab:R154ip6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154ip6a:2" aria-labelledby="tab:R154ip6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154ip6a:3" aria-labelledby="tab:R154ip6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R174ip6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R174ip6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R174ip6a:0" aria-labelledby="tab:R174ip6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_blocklist&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;BoxTrapper&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;from blocklisted-email\\@domain\\.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::get_ignorelist" data-section-id="tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::get_ignorelist" class="sc-dntaoT ceciOs"><div data-section-id="operation/BoxTrapper::get_ignorelist" id="operation/BoxTrapper::get_ignorelist" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::get_ignorelist" aria-label="tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::get_ignorelist"></a>Return account BoxTrapper ignorelist rules </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves a list of BoxTrapper ignorelist configuration rules. BoxTrapper will delete messages that match these rules without sending a notification to the sender.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the
&lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;,
the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a list of BoxTrapper ignorelist configuration rules. BoxTrapper will delete messages that match these rules without sending a notification to the sender.</p>
<p><strong>Important:</strong></p>
<p>When you disable the
<a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>,
the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user@example.com</span></div><div><div html="&lt;p&gt;A valid email address on the cPanel account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If you call this function in Webmail, the system overrides this parameter.
This parameter defaults to the current email address.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A valid email address on the cPanel account.</p>
<p><strong>Warning:</strong></p>
<p>If you call this function in Webmail, the system overrides this parameter.
This parameter defaults to the current email address.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/BoxTrapper/get_ignorelist</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/BoxTrapper/get_ignorelist</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R154mp6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R154mp6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R154mp6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R154mp6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R154mp6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R154mp6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R154mp6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R154mp6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R154mp6a:0" aria-labelledby="tab:R154mp6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  BoxTrapper <span class="token punctuation">\</span>
  get_ignorelist <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'user@example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154mp6a:1" aria-labelledby="tab:R154mp6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154mp6a:2" aria-labelledby="tab:R154mp6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154mp6a:3" aria-labelledby="tab:R154mp6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R174mp6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R174mp6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R174mp6a:0" aria-labelledby="tab:R174mp6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_ignorelist&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;BoxTrapper&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;from ignored-email\\@domain\\.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Prevention-(BoxTrapper)/operation/get_message" data-section-id="tag/Spam-Prevention-(BoxTrapper)/operation/get_message" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_message" id="operation/get_message" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Prevention-(BoxTrapper)/operation/get_message" aria-label="tag/Spam-Prevention-(BoxTrapper)/operation/get_message"></a>Return message&#x27;s top 200 lines in BoxTrapper queue </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the first 200 lines of an email in the BoxTrapper queue.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail&lt;/a&gt; role, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the first 200 lines of an email in the BoxTrapper queue.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail</a> role, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="email" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand email"><span class="property-name">email</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user@example.com</span></div><div><div html="&lt;p&gt;The account’s name, either an email address or the cPanel user’s username.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; If you call this function in Webmail, the system ignores this parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account’s name, either an email address or the cPanel user’s username.</p>
<p><strong>Important:</strong></p>
<p> If you call this function in Webmail, the system ignores this parameter.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="queuefile" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">queuefile</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">queuefile=example.msg</span></div><div><div html="&lt;p&gt;The message&amp;#39;s filename.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The message&#39;s filename.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/BoxTrapper/get_message</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/BoxTrapper/get_message</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R154qp6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R154qp6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R154qp6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R154qp6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R154qp6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R154qp6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R154qp6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R154qp6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R154qp6a:0" aria-labelledby="tab:R154qp6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  BoxTrapper <span class="token punctuation">\</span>
  get_message <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'user@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">queuefile</span><span class="token operator">=</span><span class="token string">'example.msg'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154qp6a:1" aria-labelledby="tab:R154qp6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154qp6a:2" aria-labelledby="tab:R154qp6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154qp6a:3" aria-labelledby="tab:R154qp6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R174qp6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R174qp6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R174qp6a:0" aria-labelledby="tab:R174qp6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_message&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;BoxTrapper&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"content"</span>: <span class="token string">&quot;From user@example.com Tue May 07 08:30:36 2019\nReceived: from user by example.com with local (Exim 4.92) (envelope-from &lt;root@yourserver.net&gt;)\n    id 1hO0B1-0003Ev-Md for user2@example.com; Tue, 07 May 2019 08:30:36 -0500\nFrom: user3@example.com\nSubject: Message\nMessage-Id: &lt;E1hO0B1-0003Ev-Md@yourserver.net&gt;\nDate: Tue, 07 May 2019 08:30:35 -0500\n\nThis is an email message&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"contents"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"queuefile"</span>: <span class="token string">&quot;example.msg&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Prevention-(BoxTrapper)/operation/get_email_template" data-section-id="tag/Spam-Prevention-(BoxTrapper)/operation/get_email_template" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_email_template" id="operation/get_email_template" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Prevention-(BoxTrapper)/operation/get_email_template" aria-label="tag/Spam-Prevention-(BoxTrapper)/operation/get_email_template"></a>Return specified BoxTrapper email template </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves a BoxTrapper email message template.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the
  &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;,
  the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a BoxTrapper email message template.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the
  <a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>,
  the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user@example.com</span></div><div><div html="&lt;p&gt;A valid email address on the cPanel account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If you call this function in Webmail, the system overrides this parameter.
This parameter defaults to the current email address.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A valid email address on the cPanel account.</p>
<p><strong>Warning:</strong></p>
<p>If you call this function in Webmail, the system overrides this parameter.
This parameter defaults to the current email address.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="template" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">template</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;blacklist&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;returnverify&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;verifyreleased&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;verify&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">template=verify</span></div><div><div html="&lt;p&gt;The message template.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;blacklist&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;returnverify&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;verifyreleased&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;verify&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;For more information on each template, read our
&lt;a href=&quot;https://go.cpanel.net/cpaneldocsBoxTrapper&quot;&gt;BoxTrapper&lt;/a&gt; documentation.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The message template.</p>
<ul>
<li><code>blacklist</code></li>
<li><code>returnverify</code></li>
<li><code>verifyreleased</code></li>
<li><code>verify</code></li>
</ul>
<p><strong>Note:</strong></p>
<p>For more information on each template, read our
<a href="https://go.cpanel.net/cpaneldocsBoxTrapper">BoxTrapper</a> documentation.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/BoxTrapper/get_email_template</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/BoxTrapper/get_email_template</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R154up6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R154up6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R154up6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R154up6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R154up6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R154up6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R154up6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R154up6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R154up6a:0" aria-labelledby="tab:R154up6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  BoxTrapper <span class="token punctuation">\</span>
  get_email_template <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'user@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">template</span><span class="token operator">=</span><span class="token string">'verify'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154up6a:1" aria-labelledby="tab:R154up6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154up6a:2" aria-labelledby="tab:R154up6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R154up6a:3" aria-labelledby="tab:R154up6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R174up6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R174up6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R174up6a:0" aria-labelledby="tab:R174up6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_email_template&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;BoxTrapper&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token string">&quot;To: %email%\\nSubject: Re: %subject%\\n\\nThe user %acct% does not accept mail from your address.\\n\\nThe headers of the message sent from your address are shown below:\\n\\n%headers%\\n\&quot;,&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Prevention-(BoxTrapper)/operation/ignore_messages" data-section-id="tag/Spam-Prevention-(BoxTrapper)/operation/ignore_messages" class="sc-dntaoT ceciOs"><div data-section-id="operation/ignore_messages" id="operation/ignore_messages" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Prevention-(BoxTrapper)/operation/ignore_messages" aria-label="tag/Spam-Prevention-(BoxTrapper)/operation/ignore_messages"></a>Add email account to Exim ignore list </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function marks email message senders for Exim to ignore.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;Receive Mail role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function marks email message senders for Exim to ignore.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles">Receive Mail role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user@example.com</span></div><div><div html="&lt;p&gt;The cPanel email account from which to ignore messages.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt; &lt;/p&gt;
&lt;p&gt;If you call this function in Webmail, the system ignores this parameter and defaults
to the currently-authenticated email address.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel email account from which to ignore messages.</p>
<p><strong>Warning:</strong> </p>
<p>If you call this function in Webmail, the system ignores this parameter and defaults
to the currently-authenticated email address.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="queuefile" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">queuefile</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">queuefile=queuefile-1=example1.msg queuefile-2=example2.msg queuefile-3=example3.msg</span> - Ignore multiple email messages.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">queuefile=example.msg</span> - Ignore a single email message.</li></ul><div><div html="&lt;p&gt;The filename of the email message to ignore.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; To ignore multiple email messages, duplicate this parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The filename of the email message to ignore.</p>
<p><strong>Note:</strong></p>
<p> To ignore multiple email messages, duplicate this parameter.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/BoxTrapper/ignore_messages</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/BoxTrapper/ignore_messages</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R1552p6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R1552p6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R1552p6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R1552p6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R1552p6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R1552p6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R1552p6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R1552p6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R1552p6a:0" aria-labelledby="tab:R1552p6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  BoxTrapper <span class="token punctuation">\</span>
  ignore_messages <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'user@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">queuefile</span><span class="token operator">=</span><span class="token string">'example.msg'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1552p6a:1" aria-labelledby="tab:R1552p6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1552p6a:2" aria-labelledby="tab:R1552p6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1552p6a:3" aria-labelledby="tab:R1552p6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R1752p6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R1752p6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R1752p6a:0" aria-labelledby="tab:R1752p6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;ignore_messages&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;BoxTrapper&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"matches"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example.msg&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"operator"</span>: <span class="token string">&quot;ignore&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Prevention-(BoxTrapper)/operation/reset_email_template" data-section-id="tag/Spam-Prevention-(BoxTrapper)/operation/reset_email_template" class="sc-dntaoT ceciOs"><div data-section-id="operation/reset_email_template" id="operation/reset_email_template" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Prevention-(BoxTrapper)/operation/reset_email_template" aria-label="tag/Spam-Prevention-(BoxTrapper)/operation/reset_email_template"></a>Restore default BoxTrapper email message template </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function restores the BoxTrapper email message templates to the system default setting.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you &lt;strong&gt;disable&lt;/strong&gt; the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail&lt;/a&gt; role, the system disables this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function restores the BoxTrapper email message templates to the system default setting.</p>
<p><strong>Important:</strong></p>
<p>When you <strong>disable</strong> the <a href="https://go.cpanel.net/serverroles">Receive Mail</a> role, the system disables this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user@example.com</span></div><div><div html="&lt;p&gt;The account&amp;#39;s email address.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;The &lt;code&gt;email&lt;/code&gt; parameter is required when this function is called outside of webmail.
If you call this function in Webmail, the &lt;code&gt;email&lt;/code&gt; parameter is not required, and
the system overrides this parameter with the current authenticated user&amp;#39;s email address.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account&#39;s email address.</p>
<p><strong>Warning:</strong></p>
<p>The <code>email</code> parameter is required when this function is called outside of webmail.
If you call this function in Webmail, the <code>email</code> parameter is not required, and
the system overrides this parameter with the current authenticated user&#39;s email address.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="template" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">template</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;blacklist&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;verify&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;verifyreleased&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;returnverify&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">template=verify</span></div><div><div html="&lt;p&gt;The message template. Possible values:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;blacklist&lt;/code&gt; - BoxTrapper responds with this message when a blacklisted address sends an email.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;verify&lt;/code&gt; - BoxTrapper responds with this message when an address that does not exist on the whitelist or blacklist sends an email. This message requests a response to confirm that the sender is legitimate.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;verifyreleased&lt;/code&gt; - BoxTrapper responds with this message when a person responds to the verify message with an email or a click on the verification link.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;returnverify&lt;/code&gt; - BoxTrapper responds with this message when the verification process fails.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The message template. Possible values:</p>
<ul>
<li><code>blacklist</code> - BoxTrapper responds with this message when a blacklisted address sends an email.</li>
<li><code>verify</code> - BoxTrapper responds with this message when an address that does not exist on the whitelist or blacklist sends an email. This message requests a response to confirm that the sender is legitimate.</li>
<li><code>verifyreleased</code> - BoxTrapper responds with this message when a person responds to the verify message with an email or a click on the verification link.</li>
<li><code>returnverify</code> - BoxTrapper responds with this message when the verification process fails.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/BoxTrapper/reset_email_template</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/BoxTrapper/reset_email_template</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R1556p6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R1556p6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R1556p6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R1556p6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R1556p6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R1556p6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R1556p6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R1556p6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R1556p6a:0" aria-labelledby="tab:R1556p6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  BoxTrapper <span class="token punctuation">\</span>
  reset_email_template <span class="token punctuation">\</span>
  <span class="token assign-left variable">template</span><span class="token operator">=</span><span class="token string">'verify'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1556p6a:1" aria-labelledby="tab:R1556p6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1556p6a:2" aria-labelledby="tab:R1556p6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1556p6a:3" aria-labelledby="tab:R1556p6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R1756p6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R1756p6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R1756p6a:0" aria-labelledby="tab:R1756p6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;reset_email_template&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;BoxTrapper&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::set_ignorelist" data-section-id="tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::set_ignorelist" class="sc-dntaoT ceciOs"><div data-section-id="operation/BoxTrapper::set_ignorelist" id="operation/BoxTrapper::set_ignorelist" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::set_ignorelist" aria-label="tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::set_ignorelist"></a>Update account BoxTrapper ignorelist </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function sets the BoxTrapper ignorelist configuration rules. BoxTrapper will delete messages that match these rules without sending a notification to the sender.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the
&lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;,
the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets the BoxTrapper ignorelist configuration rules. BoxTrapper will delete messages that match these rules without sending a notification to the sender.</p>
<p><strong>Important:</strong></p>
<p>When you disable the
<a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>,
the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user@example.com</span></div><div><div html="&lt;p&gt;A valid email address on the cPanel account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If you call this function in Webmail, the system overrides this parameter.
This parameter defaults to the current email address.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A valid email address on the cPanel account.</p>
<p><strong>Warning:</strong></p>
<p>If you call this function in Webmail, the system overrides this parameter.
This parameter defaults to the current email address.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="rules" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">rules</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">strings</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">rules=rules-1=&#x27;ignored-email\@domain\.com&#x27; rules-2=&#x27;from ignored-email2\@domain\.com&#x27; rules-3=&#x27;to domain2\.com&#x27;</span> - Set multiple rules.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">rules=rules=&#x27;ignored-email\@domain\.com&#x27; rules=&#x27;from ignored-email2\@domain\.com&#x27; rules=&#x27;to domain2\.com&#x27;</span> - Set multiple rules.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">rules=ignored-email\@domain\.com</span> - Set a single rule.</li></ul><div><div html="&lt;p&gt;An array of ignorelist rules.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You can set multiple ignore rules, duplicate or increment the parameter name. For example,
&lt;code&gt;rules-1&lt;/code&gt;, &lt;code&gt;rules-2&lt;/code&gt;, and &lt;code&gt;rules-3&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An array of ignorelist rules.</p>
<p><strong>Note:</strong></p>
<p>You can set multiple ignore rules, duplicate or increment the parameter name. For example,
<code>rules-1</code>, <code>rules-2</code>, and <code>rules-3</code>.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/BoxTrapper/set_ignorelist</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/BoxTrapper/set_ignorelist</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R155ap6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R155ap6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R155ap6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R155ap6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R155ap6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R155ap6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R155ap6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R155ap6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R155ap6a:0" aria-labelledby="tab:R155ap6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token parameter variable">--user</span><span class="token operator">=</span>username BoxTrapper set_ignorelist <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'user@example.com'</span> rules-1<span class="token operator">=</span><span class="token string">'ignored-email\@domain\.com'</span> rules-2<span class="token operator">=</span><span class="token string">'from ignored-email2\@domain\.com'</span> rules-3<span class="token operator">=</span><span class="token string">'to domain2\.com'</span></pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155ap6a:1" aria-labelledby="tab:R155ap6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155ap6a:2" aria-labelledby="tab:R155ap6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155ap6a:3" aria-labelledby="tab:R155ap6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R175ap6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R175ap6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R175ap6a:0" aria-labelledby="tab:R175ap6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_ignorelist&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;BoxTrapper&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Prevention-(BoxTrapper)/operation/save_email_template" data-section-id="tag/Spam-Prevention-(BoxTrapper)/operation/save_email_template" class="sc-dntaoT ceciOs"><div data-section-id="operation/save_email_template" id="operation/save_email_template" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Prevention-(BoxTrapper)/operation/save_email_template" aria-label="tag/Spam-Prevention-(BoxTrapper)/operation/save_email_template"></a>Save BoxTrapper message template contents </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function saves the contents of a BoxTrapper message template.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;,
the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function saves the contents of a BoxTrapper message template.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles"><em>Receive Mail</em> role</a>,
the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="contents" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">contents</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">contents=To: %email%
Subject: Re: %subject%

The user %acct% does not accept mail from your address.

The headers of the message sent from your address are shown below:

%headers%</span></div><div><div html="&lt;p&gt;The template file&amp;#39;s contents.&lt;/p&gt;
&lt;p&gt;You can use &lt;a href=&quot;https://go.cpanel.net/cpaneldocsBoxTrapper&quot;&gt;variables&lt;/a&gt; in the template
to include details about the original message.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;You &lt;strong&gt;must&lt;/strong&gt; include &lt;code&gt;To: %email%&lt;/code&gt; in this parameter&amp;#39;s value.&lt;/li&gt;
&lt;li&gt;If you use the &lt;code&gt;verify&lt;/code&gt; template, you &lt;strong&gt;must&lt;/strong&gt; include &lt;code&gt;Subject: verify#%msgid%&lt;/code&gt; in this parameter&amp;#39;s value.&lt;/li&gt;
&lt;li&gt;This value cannot exceed four kilobytes (KB).&lt;/li&gt;
&lt;li&gt;You &lt;strong&gt;must&lt;/strong&gt; URI-encode this parameter&amp;#39;s value when using the CLI.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The template file&#39;s contents.</p>
<p>You can use <a href="https://go.cpanel.net/cpaneldocsBoxTrapper">variables</a> in the template
to include details about the original message.</p>
<p><strong>Important:</strong></p>
<ul>
<li>You <strong>must</strong> include <code>To: %email%</code> in this parameter&#39;s value.</li>
<li>If you use the <code>verify</code> template, you <strong>must</strong> include <code>Subject: verify#%msgid%</code> in this parameter&#39;s value.</li>
<li>This value cannot exceed four kilobytes (KB).</li>
<li>You <strong>must</strong> URI-encode this parameter&#39;s value when using the CLI.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user@example.com</span></div><div><div html="&lt;p&gt;The account&amp;#39;s email address.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If you call this function in Webmail, the system overrides this parameter.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This parameter defaults to the current email address.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account&#39;s email address.</p>
<p><strong>Warning:</strong></p>
<p>If you call this function in Webmail, the system overrides this parameter.</p>
<p><strong>Note:</strong></p>
<p>This parameter defaults to the current email address.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="template" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">template</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;blacklist&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;returnverify&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;verifyreleased&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;verify&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">template=blacklist</span></div><div><div html="&lt;p&gt;The message template.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;blacklist&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;returnverify&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;verifyreleased&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;verify&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If you use the &lt;code&gt;verify&lt;/code&gt; template, you &lt;strong&gt;must&lt;/strong&gt; include &lt;code&gt;Subject: verify#%msgid%&lt;/code&gt; in this parameter&amp;#39;s value.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;For more information about each template, read our &lt;a href=&quot;https://go.cpanel.net/cpaneldocsBoxTrapper&quot;&gt;BoxTrapper documentation&lt;/a&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The message template.</p>
<ul>
<li><code>blacklist</code></li>
<li><code>returnverify</code></li>
<li><code>verifyreleased</code></li>
<li><code>verify</code></li>
</ul>
<p><strong>Important:</strong></p>
<p>If you use the <code>verify</code> template, you <strong>must</strong> include <code>Subject: verify#%msgid%</code> in this parameter&#39;s value.</p>
<p><strong>Note:</strong></p>
<p>For more information about each template, read our <a href="https://go.cpanel.net/cpaneldocsBoxTrapper">BoxTrapper documentation</a>.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/BoxTrapper/save_email_template</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/BoxTrapper/save_email_template</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R155ep6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R155ep6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R155ep6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R155ep6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R155ep6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R155ep6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R155ep6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R155ep6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R155ep6a:0" aria-labelledby="tab:R155ep6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  BoxTrapper <span class="token punctuation">\</span>
  save_email_template <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'user@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">template</span><span class="token operator">=</span><span class="token string">'blacklist'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">contents</span><span class="token operator">=</span><span class="token string">'To: %25email%25
Subject: Re: %25subject%25

The user %25acct%25 does not accept mail from your address.

The headers of the message sent from your address are shown below:

%25headers%25'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155ep6a:1" aria-labelledby="tab:R155ep6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155ep6a:2" aria-labelledby="tab:R155ep6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155ep6a:3" aria-labelledby="tab:R155ep6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R175ep6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R175ep6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R175ep6a:0" aria-labelledby="tab:R175ep6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;save_email_template&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;BoxTrapper&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Prevention-(BoxTrapper)/operation/list_queued_messages" data-section-id="tag/Spam-Prevention-(BoxTrapper)/operation/list_queued_messages" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_queued_messages" id="operation/list_queued_messages" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Prevention-(BoxTrapper)/operation/list_queued_messages" aria-label="tag/Spam-Prevention-(BoxTrapper)/operation/list_queued_messages"></a>Return email account&#x27;s BoxTrapper queued messages </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns a list of messages in the account&amp;#39;s BoxTrapper queue.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt;
  this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns a list of messages in the account&#39;s BoxTrapper queue.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>, the system <strong>disables</strong>
  this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="date" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">date</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;unix_timestamp&gt; </span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;the current time&quot;</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">date=1556812881</span></div><div><div html="&lt;p&gt;The date for which to return queued messages.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The date for which to return queued messages.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user@example.com</span></div><div><div html="&lt;p&gt;The email account for which to retrieve queued messages.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If you call this function in Webmail, the system ignores this parameter and defaults to the currently authenticated email address.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email account for which to retrieve queued messages.</p>
<p><strong>Important:</strong></p>
<p>If you call this function in Webmail, the system ignores this parameter and defaults to the currently authenticated email address.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/BoxTrapper/list_queued_messages</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/BoxTrapper/list_queued_messages</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R155ip6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R155ip6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R155ip6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R155ip6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R155ip6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R155ip6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R155ip6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R155ip6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R155ip6a:0" aria-labelledby="tab:R155ip6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  BoxTrapper <span class="token punctuation">\</span>
  list_queued_messages <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'user@example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155ip6a:1" aria-labelledby="tab:R155ip6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155ip6a:2" aria-labelledby="tab:R155ip6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155ip6a:3" aria-labelledby="tab:R155ip6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R175ip6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R175ip6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R175ip6a:0" aria-labelledby="tab:R175ip6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_queued_messages&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;BoxTrapper&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"from"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"queuefile"</span>: <span class="token string">&quot;example.msg&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject"</span>: <span class="token string">&quot;Email Message Subject&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"time"</span>: <span class="token number">1556812881</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::set_blocklist" data-section-id="tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::set_blocklist" class="sc-dntaoT ceciOs"><div data-section-id="operation/BoxTrapper::set_blocklist" id="operation/BoxTrapper::set_blocklist" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::set_blocklist" aria-label="tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::set_blocklist"></a>Update account BoxTrapper blocklist </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function sets the BoxTrapper blocklist configuration rules. BoxTrapper will delete messages that match these rules and send a notification to the sender.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the
&lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;,
the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets the BoxTrapper blocklist configuration rules. BoxTrapper will delete messages that match these rules and send a notification to the sender.</p>
<p><strong>Important:</strong></p>
<p>When you disable the
<a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>,
the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user@example.com</span></div><div><div html="&lt;p&gt;A valid email address on the cPanel account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If you call this function in Webmail, the system overrides this parameter.
This parameter defaults to the current email address.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A valid email address on the cPanel account.</p>
<p><strong>Warning:</strong></p>
<p>If you call this function in Webmail, the system overrides this parameter.
This parameter defaults to the current email address.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="rules" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">rules</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">strings</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">rules=rules-1=&#x27;blocklisted-email\@domain\.com&#x27; rules-2=&#x27;from blocklisted-email2\@domain\.com&#x27; rules-3=&#x27;to domain2\.com&#x27;</span> - Set multiple rules.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">rules=rules=&#x27;blocklisted-email\@domain\.com&#x27; rules=&#x27;from blocklisted-email2\@domain\.com&#x27; rules=&#x27;to domain2\.com&#x27;</span> - Set multiple rules.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">rules=blocklisted-email\@domain\.com</span> - Set a single rule.</li></ul><div><div html="&lt;p&gt;An array of blocklist rules.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You can set multiple block rules, duplicate or increment the parameter name. For example,
&lt;code&gt;rules-1&lt;/code&gt;, &lt;code&gt;rules-2&lt;/code&gt;, and &lt;code&gt;rules-3&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An array of blocklist rules.</p>
<p><strong>Note:</strong></p>
<p>You can set multiple block rules, duplicate or increment the parameter name. For example,
<code>rules-1</code>, <code>rules-2</code>, and <code>rules-3</code>.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/BoxTrapper/set_blocklist</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/BoxTrapper/set_blocklist</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R155mp6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R155mp6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R155mp6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R155mp6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R155mp6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R155mp6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R155mp6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R155mp6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R155mp6a:0" aria-labelledby="tab:R155mp6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token parameter variable">--user</span><span class="token operator">=</span>username BoxTrapper set_blocklist <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'user@example.com'</span> rules-1<span class="token operator">=</span><span class="token string">'blocklisted-email\@domain\.com'</span> rules-2<span class="token operator">=</span><span class="token string">'from blocklisted-email2\@domain\.com'</span> rules-3<span class="token operator">=</span><span class="token string">'to domain2\.com'</span></pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155mp6a:1" aria-labelledby="tab:R155mp6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155mp6a:2" aria-labelledby="tab:R155mp6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155mp6a:3" aria-labelledby="tab:R155mp6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R175mp6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R175mp6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R175mp6a:0" aria-labelledby="tab:R175mp6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_blocklist&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;BoxTrapper&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Prevention-(BoxTrapper)/operation/whitelist_messages" data-section-id="tag/Spam-Prevention-(BoxTrapper)/operation/whitelist_messages" class="sc-dntaoT ceciOs"><div data-section-id="operation/whitelist_messages" id="operation/whitelist_messages" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Prevention-(BoxTrapper)/operation/whitelist_messages" aria-label="tag/Spam-Prevention-(BoxTrapper)/operation/whitelist_messages"></a>Add email address to BoxTrapper allowed senders </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function whitelists email messages.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail&lt;/a&gt; role, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To retrieve email messages in the BoxTrapper queue from senders that you did not previously whitelist, use the UAPI &lt;code&gt;BoxTrapper::deliver_messages&lt;/code&gt; function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function whitelists email messages.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail</a> role, the system <strong>disables</strong> this function.</p>
<p><strong>Note:</strong></p>
<p>To retrieve email messages in the BoxTrapper queue from senders that you did not previously whitelist, use the UAPI <code>BoxTrapper::deliver_messages</code> function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user@example.com</span></div><div><div html="&lt;p&gt;The cPanel account email address for which to whitelist messages.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If you call this function in Webmail, the system ignores this parameter and defaults to the currently-authenticated email address.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel account email address for which to whitelist messages.</p>
<p><strong>Warning</strong></p>
<p>If you call this function in Webmail, the system ignores this parameter and defaults to the currently-authenticated email address.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="queuefile" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">queuefile</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">queuefile=queuefile=ex1.msg&amp;queuefile=ex2.msg&amp;queuefile=ex3.msg</span> - Whitelist multiple messages.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">queuefile=example.msg</span> - Whitelist a single message.</li></ul><div><div html="&lt;p&gt;The filename of the email message to whitelist.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To get a list of filenames in an account&amp;#39;s BoxTrapper queue, use the UAPI &lt;code&gt;BoxTrapper::list_queued_messages&lt;/code&gt; function.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To whitelist multiple email messages, duplicate this parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The filename of the email message to whitelist.</p>
<p><strong>Note:</strong></p>
<p>To get a list of filenames in an account&#39;s BoxTrapper queue, use the UAPI <code>BoxTrapper::list_queued_messages</code> function.</p>
<p><strong>Note:</strong></p>
<p>To whitelist multiple email messages, duplicate this parameter.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/BoxTrapper/whitelist_messages</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/BoxTrapper/whitelist_messages</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R155qp6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R155qp6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R155qp6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R155qp6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R155qp6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R155qp6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R155qp6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R155qp6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R155qp6a:0" aria-labelledby="tab:R155qp6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  BoxTrapper <span class="token punctuation">\</span>
  whitelist_messages <span class="token punctuation">\</span>
  <span class="token assign-left variable">queuefile</span><span class="token operator">=</span><span class="token string">'example.msg'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155qp6a:1" aria-labelledby="tab:R155qp6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155qp6a:2" aria-labelledby="tab:R155qp6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155qp6a:3" aria-labelledby="tab:R155qp6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R175qp6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R175qp6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R175qp6a:0" aria-labelledby="tab:R175qp6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;whitelist_messages&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;BoxTrapper&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"matches"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example.msg&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"operator"</span>: <span class="token string">&quot;whitelist&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::get_allowlist" data-section-id="tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::get_allowlist" class="sc-dntaoT ceciOs"><div data-section-id="operation/BoxTrapper::get_allowlist" id="operation/BoxTrapper::get_allowlist" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::get_allowlist" aria-label="tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::get_allowlist"></a>Return account BoxTrapper allowlist rules </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves a list of BoxTrapper allowlist configuration rules. BoxTrapper will deliver emails that match these rules.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the
&lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;,
the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a list of BoxTrapper allowlist configuration rules. BoxTrapper will deliver emails that match these rules.</p>
<p><strong>Important:</strong></p>
<p>When you disable the
<a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>,
the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user@example.com</span></div><div><div html="&lt;p&gt;A valid email address on the cPanel account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If you call this function in Webmail, the system overrides this parameter.
This parameter defaults to the current email address.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A valid email address on the cPanel account.</p>
<p><strong>Warning:</strong></p>
<p>If you call this function in Webmail, the system overrides this parameter.
This parameter defaults to the current email address.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/BoxTrapper/get_allowlist</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/BoxTrapper/get_allowlist</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R155up6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R155up6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R155up6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R155up6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R155up6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R155up6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R155up6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R155up6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R155up6a:0" aria-labelledby="tab:R155up6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  BoxTrapper <span class="token punctuation">\</span>
  get_allowlist <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'user@example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155up6a:1" aria-labelledby="tab:R155up6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155up6a:2" aria-labelledby="tab:R155up6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155up6a:3" aria-labelledby="tab:R155up6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R175up6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R175up6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R175up6a:0" aria-labelledby="tab:R175up6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_allowlist&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;BoxTrapper&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;from allowlisted-email\\@domain\\.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Prevention-(BoxTrapper)/operation/get_configuration" data-section-id="tag/Spam-Prevention-(BoxTrapper)/operation/get_configuration" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_configuration" id="operation/get_configuration" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Prevention-(BoxTrapper)/operation/get_configuration" aria-label="tag/Spam-Prevention-(BoxTrapper)/operation/get_configuration"></a>Return email account&#x27;s BoxTrapper configuration </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves an account&amp;#39;s BoxTrapper configuration.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail&lt;/a&gt; role, the system disables this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves an account&#39;s BoxTrapper configuration.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail</a> role, the system disables this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user@example.com</span></div><div><div html="&lt;p&gt;The account&amp;#39;s email address.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If you call this function in Webmail, the system ignores this parameter and defaults to the currently-authenticated email address.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account&#39;s email address.</p>
<p><strong>Warning:</strong></p>
<p>If you call this function in Webmail, the system ignores this parameter and defaults to the currently-authenticated email address.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/BoxTrapper/get_configuration</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/BoxTrapper/get_configuration</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R1562p6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R1562p6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R1562p6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R1562p6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R1562p6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R1562p6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R1562p6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R1562p6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R1562p6a:0" aria-labelledby="tab:R1562p6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  BoxTrapper <span class="token punctuation">\</span>
  get_configuration <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'user@example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1562p6a:1" aria-labelledby="tab:R1562p6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1562p6a:2" aria-labelledby="tab:R1562p6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1562p6a:3" aria-labelledby="tab:R1562p6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R1762p6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R1762p6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R1762p6a:0" aria-labelledby="tab:R1762p6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_configuration&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;BoxTrapper&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enable_auto_whitelist"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"from_addresses"</span>: <span class="token string">&quot;user@example.com,user2@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"from_name"</span>: <span class="token string">&quot;User&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"queue_days"</span>: <span class="token number">14</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"spam_score"</span>: <span class="token number">2.5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"whitelist_by_association"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Prevention-(BoxTrapper)/operation/get_forwarders" data-section-id="tag/Spam-Prevention-(BoxTrapper)/operation/get_forwarders" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_forwarders" id="operation/get_forwarders" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Prevention-(BoxTrapper)/operation/get_forwarders" aria-label="tag/Spam-Prevention-(BoxTrapper)/operation/get_forwarders"></a>Return all BoxTrapper forwarders </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves a list of email addresses to which BoxTrapper forwards email messages.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail&lt;/a&gt; role, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a list of email addresses to which BoxTrapper forwards email messages.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail</a> role, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user@example.com</span></div><div><div html="&lt;p&gt;The account&amp;#39;s email address.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If you call this function in Webmail, the system ignores this parameter and defaults to the currently-authenticated email address.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account&#39;s email address.</p>
<p><strong>Important:</strong></p>
<p>If you call this function in Webmail, the system ignores this parameter and defaults to the currently-authenticated email address.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/BoxTrapper/get_forwarders</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/BoxTrapper/get_forwarders</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R1566p6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R1566p6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R1566p6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R1566p6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R1566p6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R1566p6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R1566p6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R1566p6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R1566p6a:0" aria-labelledby="tab:R1566p6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  BoxTrapper <span class="token punctuation">\</span>
  get_forwarders <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'user@example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1566p6a:1" aria-labelledby="tab:R1566p6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1566p6a:2" aria-labelledby="tab:R1566p6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1566p6a:3" aria-labelledby="tab:R1566p6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R1766p6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R1766p6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R1766p6a:0" aria-labelledby="tab:R1766p6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_forwarders&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;BoxTrapper&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;user1@example.com, user2@example.com, user3@example.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Prevention-(BoxTrapper)/operation/get_log" data-section-id="tag/Spam-Prevention-(BoxTrapper)/operation/get_log" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_log" id="operation/get_log" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Prevention-(BoxTrapper)/operation/get_log" aria-label="tag/Spam-Prevention-(BoxTrapper)/operation/get_log"></a>Return BoxTrapper log file and contents </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the account&amp;#39;s BoxTrapper log file and its contents.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles&quot;&gt;Receive Mail role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the account&#39;s BoxTrapper log file and its contents.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles">Receive Mail role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="date" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">date</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;unix_timestamp&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">date=1556812881</span></div><div><div html="&lt;p&gt;The date for which to return the log file and its contents.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This parameter defaults to the current date.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The date for which to return the log file and its contents.</p>
<p><strong>Note:</strong></p>
<p>This parameter defaults to the current date.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user@example.com</span></div><div><div html="&lt;p&gt;The account&amp;#39;s email address.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If you call this function in Webmail, the system ignores this parameter and defaults to the currently authenticated email address.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account&#39;s email address.</p>
<p><strong>Important:</strong></p>
<p>If you call this function in Webmail, the system ignores this parameter and defaults to the currently authenticated email address.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/BoxTrapper/get_log</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/BoxTrapper/get_log</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R156ap6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R156ap6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R156ap6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R156ap6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R156ap6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R156ap6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R156ap6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R156ap6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R156ap6a:0" aria-labelledby="tab:R156ap6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  BoxTrapper <span class="token punctuation">\</span>
  get_log <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'user@example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R156ap6a:1" aria-labelledby="tab:R156ap6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R156ap6a:2" aria-labelledby="tab:R156ap6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R156ap6a:3" aria-labelledby="tab:R156ap6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R176ap6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R176ap6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R176ap6a:0" aria-labelledby="tab:R176ap6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_log&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;BoxTrapper&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"date"</span>: <span class="token number">1556812881</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lines"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;Processing email with trusted transport method.&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/home/user/etc/example.com/user/boxtrapper/log/05-02-2019.log&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Prevention-(BoxTrapper)/operation/get_status" data-section-id="tag/Spam-Prevention-(BoxTrapper)/operation/get_status" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_status" id="operation/get_status" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Prevention-(BoxTrapper)/operation/get_status" aria-label="tag/Spam-Prevention-(BoxTrapper)/operation/get_status"></a>Return whether email account uses BoxTrapper </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function checks whether BoxTrapper is enabled for an email account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles&quot;&gt;Receive Mail role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether BoxTrapper is enabled for an email account.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles">Receive Mail role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user@example.com</span></div><div><div html="&lt;p&gt;The account&amp;#39;s email address.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If you call this function in Webmail, the system ignores this parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account&#39;s email address.</p>
<p><strong>Important:</strong></p>
<p>If you call this function in Webmail, the system ignores this parameter.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/BoxTrapper/get_status</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/BoxTrapper/get_status</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R156ep6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R156ep6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R156ep6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R156ep6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R156ep6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R156ep6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R156ep6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R156ep6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R156ep6a:0" aria-labelledby="tab:R156ep6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  BoxTrapper <span class="token punctuation">\</span>
  get_status <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'user@example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R156ep6a:1" aria-labelledby="tab:R156ep6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R156ep6a:2" aria-labelledby="tab:R156ep6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R156ep6a:3" aria-labelledby="tab:R156ep6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R176ep6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R176ep6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R176ep6a:0" aria-labelledby="tab:R176ep6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_status&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;BoxTrapper&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Prevention-(BoxTrapper)/operation/delete_messages" data-section-id="tag/Spam-Prevention-(BoxTrapper)/operation/delete_messages" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete_messages" id="operation/delete_messages" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Prevention-(BoxTrapper)/operation/delete_messages" aria-label="tag/Spam-Prevention-(BoxTrapper)/operation/delete_messages"></a>Delete messages in the BoxTrapper queue </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function deletes messages in the BoxTrapper queue.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail&lt;/a&gt; role, the system disables this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes messages in the BoxTrapper queue.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail</a> role, the system disables this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="all_like" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">all_like</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">all_like=1</span></div><div><div html="&lt;p&gt;Whether to delete all messages that resemble the &lt;code&gt;queuefile&lt;/code&gt; parameter&amp;#39;s value.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Delete all messages resembling the &lt;code&gt;queuefile&lt;/code&gt; parameter.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Do &lt;strong&gt;not&lt;/strong&gt; delete all messages resembling the &lt;code&gt;queuefile&lt;/code&gt; parameter.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to delete all messages that resemble the <code>queuefile</code> parameter&#39;s value.</p>
<ul>
<li><code>1</code> - Delete all messages resembling the <code>queuefile</code> parameter.</li>
<li><code>0</code> - Do <strong>not</strong> delete all messages resembling the <code>queuefile</code> parameter.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user@example.com</span></div><div><div html="&lt;p&gt;The account&amp;#39;s email address.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If you call this function in Webmail, the system ignores this parameter and defaults to the currently-authenticated email address.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account&#39;s email address.</p>
<p><strong>Warning:</strong></p>
<p>If you call this function in Webmail, the system ignores this parameter and defaults to the currently-authenticated email address.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="queuefile" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">queuefile</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">queuefile=queuefile=file1.msg&amp;queuefile=file2.msg</span> - Delete multiple filenames.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">queuefile=file1.msg</span> - Delete a single filename.</li></ul><div><div html="&lt;p&gt;The filename of the email message who&amp;#39;s sender to delete.&lt;/p&gt;
&lt;p&gt;  &lt;strong&gt;Warning:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; To delete multiple email message senders, duplicate the parameter name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The filename of the email message who&#39;s sender to delete.</p>
<p>  <strong>Warning:</strong></p>
<p> To delete multiple email message senders, duplicate the parameter name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/BoxTrapper/delete_messages</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/BoxTrapper/delete_messages</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R156ip6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R156ip6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R156ip6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R156ip6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R156ip6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R156ip6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R156ip6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R156ip6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R156ip6a:0" aria-labelledby="tab:R156ip6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  BoxTrapper <span class="token punctuation">\</span>
  delete_messages <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'user@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">queuefile</span><span class="token operator">=</span><span class="token string">'file1.msg'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R156ip6a:1" aria-labelledby="tab:R156ip6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R156ip6a:2" aria-labelledby="tab:R156ip6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R156ip6a:3" aria-labelledby="tab:R156ip6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R176ip6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R176ip6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R176ip6a:0" aria-labelledby="tab:R176ip6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;delete_messages&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;BoxTrapper&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"failed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"matches"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example.msg&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"operator"</span>: <span class="token string">&quot;delete&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">&quot;(XID d9myfd) The system failed to locate the requested message:&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warning"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Prevention-(BoxTrapper)/operation/list_email_templates" data-section-id="tag/Spam-Prevention-(BoxTrapper)/operation/list_email_templates" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_email_templates" id="operation/list_email_templates" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Prevention-(BoxTrapper)/operation/list_email_templates" aria-label="tag/Spam-Prevention-(BoxTrapper)/operation/list_email_templates"></a>Return BoxTrapper email templates </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the BoxTrapper email templates.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you &lt;strong&gt;disable&lt;/strong&gt; the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail&lt;/a&gt; role, the system disables this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the BoxTrapper email templates.</p>
<p><strong>Important:</strong></p>
<p>When you <strong>disable</strong> the <a href="https://go.cpanel.net/serverroles">Receive Mail</a> role, the system disables this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/BoxTrapper/list_email_templates</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/BoxTrapper/list_email_templates</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R156mp6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R156mp6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R156mp6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R156mp6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R156mp6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R156mp6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R156mp6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R156mp6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R156mp6a:0" aria-labelledby="tab:R156mp6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  BoxTrapper <span class="token punctuation">\</span>
  list_email_templates
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R156mp6a:1" aria-labelledby="tab:R156mp6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R156mp6a:2" aria-labelledby="tab:R156mp6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R156mp6a:3" aria-labelledby="tab:R156mp6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R176mp6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R176mp6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R176mp6a:0" aria-labelledby="tab:R176mp6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_email_templates&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;BoxTrapper&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;blacklist&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;returnverify&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;verify&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;verifyreleased&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Prevention-(BoxTrapper)/operation/save_configuration" data-section-id="tag/Spam-Prevention-(BoxTrapper)/operation/save_configuration" class="sc-dntaoT ceciOs"><div data-section-id="operation/save_configuration" id="operation/save_configuration" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Prevention-(BoxTrapper)/operation/save_configuration" aria-label="tag/Spam-Prevention-(BoxTrapper)/operation/save_configuration"></a>Update email account&#x27;s BoxTrapper configuration </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function modifies an account&amp;#39;s BoxTrapper configuration.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail&lt;/a&gt; role, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function modifies an account&#39;s BoxTrapper configuration.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail</a> role, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user@example.com</span></div><div><div html="&lt;p&gt;The account&amp;#39;s email address.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If you call this function in Webmail, the system ignores this parameter and defaults to the currently-authenticated email address.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account&#39;s email address.</p>
<p><strong>Warning:</strong></p>
<p>If you call this function in Webmail, the system ignores this parameter and defaults to the currently-authenticated email address.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="enable_auto_whitelist" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">enable_auto_whitelist</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">enable_auto_whitelist=1</span></div><div><div html="&lt;p&gt;Whether to enable automatic whitelisting for the account.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Enable.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Disable.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to enable automatic whitelisting for the account.</p>
<ul>
<li><code>1</code> - Enable.</li>
<li><code>0</code> - Disable.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="from_addresses" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">from_addresses</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email-csv&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">from_addresses=sender1@test.com,sender2@test.com</span></div><div><div html="&lt;p&gt;A comma-separated list of email addresses that the system uses when it sends messages back to the original message senders.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A comma-separated list of email addresses that the system uses when it sends messages back to the original message senders.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="from_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">from_name</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">from_name=User</span></div><div><div html="&lt;p&gt;The name of the person who owns the email account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the person who owns the email account.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="queue_days" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">queue_days</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= 1 </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">queue_days=14</span></div><div><div html="&lt;p&gt;The number of days to retain log files and queued messages.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The number of days to retain log files and queued messages.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="spam_score" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">spam_score</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">number</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">spam_score=2.5</span></div><div><div html="&lt;p&gt;The account&amp;#39;s Apache SpamAssassin™ threshold score. For more information about Apache SpamAssassin threshold scores, read our &lt;a href=&quot;https://go.cpanel.net/cpaneldocsSpamFilters&quot;&gt;Spam Filters&lt;/a&gt; documentation.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This parameter defaults to the account&amp;#39;s current configuration.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account&#39;s Apache SpamAssassin™ threshold score. For more information about Apache SpamAssassin threshold scores, read our <a href="https://go.cpanel.net/cpaneldocsSpamFilters">Spam Filters</a> documentation.</p>
<p><strong>Note:</strong></p>
<p>This parameter defaults to the account&#39;s current configuration.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="whitelist_by_association" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">whitelist_by_association</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">whitelist_by_association=1</span></div><div><div html="&lt;p&gt;Whether to whitelist the email addresses in a message&amp;#39;s &lt;em&gt;To&lt;/em&gt; and &lt;em&gt;From&lt;/em&gt; sections, including carbon-copied (CC) recipients.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Whitelist.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Do &lt;strong&gt;not&lt;/strong&gt; whitelist.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to whitelist the email addresses in a message&#39;s <em>To</em> and <em>From</em> sections, including carbon-copied (CC) recipients.</p>
<ul>
<li><code>1</code> - Whitelist.</li>
<li><code>0</code> - Do <strong>not</strong> whitelist.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/BoxTrapper/save_configuration</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/BoxTrapper/save_configuration</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R156qp6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R156qp6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R156qp6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R156qp6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R156qp6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R156qp6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R156qp6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R156qp6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R156qp6a:0" aria-labelledby="tab:R156qp6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  BoxTrapper <span class="token punctuation">\</span>
  save_configuration <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'user@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">from_addresses</span><span class="token operator">=</span><span class="token string">'sender1@test.com,sender2@test.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">queue_days</span><span class="token operator">=</span><span class="token string">'14'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">enable_auto_whitelist</span><span class="token operator">=</span><span class="token string">'1'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">whitelist_by_association</span><span class="token operator">=</span><span class="token string">'1'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R156qp6a:1" aria-labelledby="tab:R156qp6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R156qp6a:2" aria-labelledby="tab:R156qp6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R156qp6a:3" aria-labelledby="tab:R156qp6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R176qp6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R176qp6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R176qp6a:0" aria-labelledby="tab:R176qp6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;save_configuration&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;BoxTrapper&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Prevention-(BoxTrapper)/operation/set_forwarders" data-section-id="tag/Spam-Prevention-(BoxTrapper)/operation/set_forwarders" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_forwarders" id="operation/set_forwarders" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Prevention-(BoxTrapper)/operation/set_forwarders" aria-label="tag/Spam-Prevention-(BoxTrapper)/operation/set_forwarders"></a>Add email address to BoxTrapper forwarders </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function adds a list of email addresses to which BoxTrapper forwards email messages.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Receive Mail&lt;/a&gt; role, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function adds a list of email addresses to which BoxTrapper forwards email messages.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">Receive Mail</a> role, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user@example.com</span></div><div><div html="&lt;p&gt;The account&amp;#39;s email address.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If you call this function
in Webmail, the system ignores this parameter and uses the currently-authenticated
email address.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account&#39;s email address.</p>
<p><strong>Warning:</strong></p>
<p>If you call this function
in Webmail, the system ignores this parameter and uses the currently-authenticated
email address.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="forwarder" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">forwarder</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">any</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR gjyOxn kpFoWb">[ items<span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email &gt;</span> ]</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">forwarder=user1@example.com</span></div><div><div html="&lt;p&gt;The email addresses to which to forward email messages.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The email addresses to which to forward email messages.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/BoxTrapper/set_forwarders</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/BoxTrapper/set_forwarders</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R156up6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R156up6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R156up6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R156up6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R156up6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R156up6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R156up6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R156up6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R156up6a:0" aria-labelledby="tab:R156up6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  BoxTrapper <span class="token punctuation">\</span>
  set_forwarders <span class="token punctuation">\</span>
  <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'user@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">forwarder</span><span class="token operator">=</span><span class="token string">'user1@example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R156up6a:1" aria-labelledby="tab:R156up6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R156up6a:2" aria-labelledby="tab:R156up6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R156up6a:3" aria-labelledby="tab:R156up6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R176up6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R176up6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R176up6a:0" aria-labelledby="tab:R176up6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_forwarders&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;BoxTrapper&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::set_allowlist" data-section-id="tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::set_allowlist" class="sc-dntaoT ceciOs"><div data-section-id="operation/BoxTrapper::set_allowlist" id="operation/BoxTrapper::set_allowlist" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::set_allowlist" aria-label="tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::set_allowlist"></a>Update account BoxTrapper allowlist </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function sets the BoxTrapper allowlist configuration rules. BoxTrapper will deliver emails that match these rules.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the
&lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt; role&lt;/a&gt;,
the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets the BoxTrapper allowlist configuration rules. BoxTrapper will deliver emails that match these rules.</p>
<p><strong>Important:</strong></p>
<p>When you disable the
<a href="https://go.cpanel.net/serverroles"><em>Receive Mail</em> role</a>,
the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user@example.com</span></div><div><div html="&lt;p&gt;A valid email address on the cPanel account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If you call this function in Webmail, the system overrides this parameter.
This parameter defaults to the current email address.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A valid email address on the cPanel account.</p>
<p><strong>Warning:</strong></p>
<p>If you call this function in Webmail, the system overrides this parameter.
This parameter defaults to the current email address.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="rules" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">rules</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">strings</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">rules=rules-1=&#x27;allowlisted-email\@domain\.com&#x27; rules-2=&#x27;from allowlisted-email2\@domain\.com&#x27; rules-3=&#x27;to domain2\.com&#x27;</span> - Set multiple rules.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">rules=rules=&#x27;allowlisted-email\@domain\.com&#x27; rules=&#x27;from allowlisted-email2\@domain\.com&#x27; rules=&#x27;to domain2\.com&#x27;</span> - Set multiple rules.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">rules=allowlisted-email\@domain\.com</span> - Set a single rule.</li></ul><div><div html="&lt;p&gt;An array of allowlist rules.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You can set multiple allowlist rules, duplicate or increment the parameter name. For example,
&lt;code&gt;rules-1&lt;/code&gt;, &lt;code&gt;rules-2&lt;/code&gt;, and &lt;code&gt;rules-3&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An array of allowlist rules.</p>
<p><strong>Note:</strong></p>
<p>You can set multiple allowlist rules, duplicate or increment the parameter name. For example,
<code>rules-1</code>, <code>rules-2</code>, and <code>rules-3</code>.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/BoxTrapper/set_allowlist</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/BoxTrapper/set_allowlist</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R1572p6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R1572p6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R1572p6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R1572p6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R1572p6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R1572p6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R1572p6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R1572p6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R1572p6a:0" aria-labelledby="tab:R1572p6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token parameter variable">--user</span><span class="token operator">=</span>username BoxTrapper set_allowlist <span class="token assign-left variable">email</span><span class="token operator">=</span><span class="token string">'user@example.com'</span> rules-1<span class="token operator">=</span><span class="token string">'allowlisted-email\@domain\.com'</span> rules-2<span class="token operator">=</span><span class="token string">'from allowlisted-email2\@domain\.com'</span> rules-3<span class="token operator">=</span><span class="token string">'to domain2\.com'</span></pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1572p6a:1" aria-labelledby="tab:R1572p6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1572p6a:2" aria-labelledby="tab:R1572p6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1572p6a:3" aria-labelledby="tab:R1572p6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R1772p6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R1772p6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R1772p6a:0" aria-labelledby="tab:R1772p6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_allowlist&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;BoxTrapper&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Spam-Prevention-(BoxTrapper)/operation/process_messages" data-section-id="tag/Spam-Prevention-(BoxTrapper)/operation/process_messages" class="sc-dntaoT ceciOs"><div data-section-id="operation/process_messages" id="operation/process_messages" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Spam-Prevention-(BoxTrapper)/operation/process_messages" aria-label="tag/Spam-Prevention-(BoxTrapper)/operation/process_messages"></a>Run a specific BoxTrapper action for a message </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function performs a specified action on messages in the BoxTrapper queue.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles#roles&quot;&gt;&lt;em&gt;Receive Mail&lt;/em&gt;&lt;/a&gt; role, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function performs a specified action on messages in the BoxTrapper queue.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles#roles"><em>Receive Mail</em></a> role, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="action" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">action</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;deliver&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;deliverall&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;delete&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;deleteall&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;blacklist&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;whitelist&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;ignore&quot;</span> </div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">action=action=blacklist action=deleteall</span> - Perform multiple actions.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">action=blacklist</span> - Perform a single action.</li></ul><div><div html="&lt;p&gt;The action to perform on the email message file. To perform multiple actions on the specified email messages, pass this parameter multiple times.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;deliver&lt;/code&gt; — Deliver a specific message.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;deliverall&lt;/code&gt; — Deliver all messages from a sender.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;delete&lt;/code&gt; — Delete a message.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;deleteall&lt;/code&gt; — Delete all messages from a sender.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;blacklist&lt;/code&gt; — Blacklist the sender of an email message.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;whitelist&lt;/code&gt; — Whitelist the sender of an email message.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;ignore&lt;/code&gt; — Ignore email messages from a sender.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;The function performs the actions on the email messages files in the order that you pass each action.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The action to perform on the email message file. To perform multiple actions on the specified email messages, pass this parameter multiple times.</p>
<ul>
<li><code>deliver</code> — Deliver a specific message.</li>
<li><code>deliverall</code> — Deliver all messages from a sender.</li>
<li><code>delete</code> — Delete a message.</li>
<li><code>deleteall</code> — Delete all messages from a sender.</li>
<li><code>blacklist</code> — Blacklist the sender of an email message.</li>
<li><code>whitelist</code> — Whitelist the sender of an email message.</li>
<li><code>ignore</code> — Ignore email messages from a sender.</li>
</ul>
<p><strong>Note:</strong></p>
<p>The function performs the actions on the email messages files in the order that you pass each action.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="email" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">email</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">email=user@example.com</span></div><div><div html="&lt;p&gt;The account&amp;#39;s email address.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;The &lt;code&gt;email&lt;/code&gt; parameter is required when this function is called &lt;strong&gt;outside&lt;/strong&gt; of Webmail.&lt;/li&gt;
&lt;li&gt;If you call this function in Webmail, the &lt;code&gt;email&lt;/code&gt; parameter is &lt;strong&gt;not&lt;/strong&gt; required, and
the system overrides this parameter with the current authenticated user&amp;#39;s email address.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account&#39;s email address.</p>
<p><strong>Warning:</strong></p>
<ul>
<li>The <code>email</code> parameter is required when this function is called <strong>outside</strong> of Webmail.</li>
<li>If you call this function in Webmail, the <code>email</code> parameter is <strong>not</strong> required, and
the system overrides this parameter with the current authenticated user&#39;s email address.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="queuefile" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">queuefile</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">queuefile=email=example.msg email=example1.msg email=example2.msg</span> - Process multiple email messages.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">queuefile=example.msg</span> - Process a single email message.</li></ul><div><div html="&lt;p&gt;The filename of the email message to process. To process multiple email messages, pass this parameter multiple times.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The filename of the email message to process. To process multiple email messages, pass this parameter multiple times.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/BoxTrapper/process_messages</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/BoxTrapper/process_messages</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R1576p6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R1576p6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R1576p6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R1576p6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R1576p6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R1576p6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R1576p6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R1576p6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R1576p6a:0" aria-labelledby="tab:R1576p6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  BoxTrapper <span class="token punctuation">\</span>
  process_messages <span class="token punctuation">\</span>
  <span class="token assign-left variable">queuefile</span><span class="token operator">=</span><span class="token string">'example.msg'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">action</span><span class="token operator">=</span><span class="token string">'blacklist'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1576p6a:1" aria-labelledby="tab:R1576p6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1576p6a:2" aria-labelledby="tab:R1576p6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1576p6a:3" aria-labelledby="tab:R1576p6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R1776p6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R1776p6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R1776p6a:0" aria-labelledby="tab:R1776p6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Example</span><div class="sc-diYFot sc-frniUE jsRqjj esCYIP"><svg class="sc-kZrBCu JXohG" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="The function failed." selected="">The function failed.</option><option value="The function succeeded.">The function succeeded.</option></select><label>The function failed.</label></div></div><div><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;BoxTrapper&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"failed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"matches"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">&quot;(XID 2ymu8k) The system failed to locate the requested message:  example.msg&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;One or more of the operations failed.&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Webmail-Applications" data-section-id="tag/Webmail-Applications" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Webmail-Applications" aria-label="tag/Webmail-Applications"></a>Webmail Applications</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Email / Webmail Applications&lt;/p&gt;
"><p>Email / Webmail Applications</p>
</div></div></div><div id="tag/Webmail-Applications/operation/list_webmail_apps" data-section-id="tag/Webmail-Applications/operation/list_webmail_apps" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_webmail_apps" id="operation/list_webmail_apps" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Webmail-Applications/operation/list_webmail_apps" aria-label="tag/Webmail-Applications/operation/list_webmail_apps"></a>Return available webmail clients </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the account&amp;#39;s available webmail clients.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;Receive Mail role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function. &lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the account&#39;s available webmail clients.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles">Receive Mail role</a>, the system <strong>disables</strong> this function. </p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="theme" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">theme</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;the server&#x27;s default theme&quot;</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">theme=jupiter</span></div><div><div html="&lt;p&gt;The webmail theme.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The webmail theme.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/WebmailApps/list_webmail_apps</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/WebmailApps/list_webmail_apps</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aer6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aer6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aer6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aer6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2aer6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aer6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2aer6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aer6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aer6a:0" aria-labelledby="tab:R2aer6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  WebmailApps <span class="token punctuation">\</span>
  list_webmail_apps
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aer6a:1" aria-labelledby="tab:R2aer6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aer6a:2" aria-labelledby="tab:R2aer6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aer6a:3" aria-labelledby="tab:R2aer6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eer6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eer6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eer6a:0" aria-labelledby="tab:R2eer6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_webmail_apps&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;WebmailApps&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"displayname"</span>: <span class="token string">&quot;Roundcube&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"icon"</span>: <span class="token string">&quot;/webmail/jupiter/images/roundcube_logo.png&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;roundcube&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">&quot;/cpsess##########/3rdparty/roundcube/index.php&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Webmail-Sessions" data-section-id="tag/Webmail-Sessions" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Webmail-Sessions" aria-label="tag/Webmail-Sessions"></a>Webmail Sessions</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Email / Webmail Sessions&lt;/p&gt;
"><p>Email / Webmail Sessions</p>
</div></div></div><div id="tag/Webmail-Sessions/operation/create_webmail_session_for_mail_user_check_password" data-section-id="tag/Webmail-Sessions/operation/create_webmail_session_for_mail_user_check_password" class="sc-dntaoT ceciOs"><div data-section-id="operation/create_webmail_session_for_mail_user_check_password" id="operation/create_webmail_session_for_mail_user_check_password" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Webmail-Sessions/operation/create_webmail_session_for_mail_user_check_password" aria-label="tag/Webmail-Sessions/operation/create_webmail_session_for_mail_user_check_password"></a>Create Webmail session with credentials </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function creates a temporary session with a password for the calling cPanel user to connect to Webmail.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;The cPanel user must own the Webmail account.&lt;/li&gt;
&lt;li&gt;This function works like the UAPI Session::create_webmail_session_for_mail_user function with one exception. This function requires a correct password to create the Webmail session. If you use an incorrect password or attempt to connect to a suspended account, the login will fail.&lt;/li&gt;
&lt;/ul&gt;
&lt;h3 id=&quot;how-to-use-this-api&quot;&gt;How to use this API&lt;/h3&gt;
&lt;p&gt;After you successfully call this API, you will need to log in to &lt;a href=&quot;https://go.cpanel.net/webmailinterface&quot;&gt;Webmail&lt;/a&gt;.
To do this, send an HTTP POST to &lt;code&gt;https://$URL_AUTHTY:2096$token/login&lt;/code&gt; with a message body of &lt;code&gt;session=$session&lt;/code&gt; where:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;$URL_AUTHTY&lt;/code&gt; represents the value from the &lt;code&gt;hostname&lt;/code&gt; return.&lt;ul&gt;
&lt;li&gt;If the &lt;code&gt;hostname&lt;/code&gt; return value is &lt;code&gt;null&lt;/code&gt;, enter the hostname of the server that answered the API function.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;$token&lt;/code&gt; represents the value from the token return.&lt;/li&gt;
&lt;/ul&gt;
&lt;/li&gt;
&lt;li&gt;&lt;code&gt;$session&lt;/code&gt; represents the value of the session return.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;For example, an HTTP POST may resemble the following:&lt;/p&gt;
&lt;p&gt;&lt;code&gt;https://hostname.example.com:2096/cpsess2462418786/login&lt;/code&gt;&lt;/p&gt;
&lt;p&gt;With a message body of:&lt;/p&gt;
&lt;p&gt;&lt;code&gt;session=username:D7NiAZv1nf4bXeg9:CREATE_WEBMAIL_SESSION_FOR_MAIL_USER,728fb86a7df1cf20690c65f349ac3137&lt;/code&gt;&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a temporary session with a password for the calling cPanel user to connect to Webmail.</p>
<p><strong>Note:</strong></p>
<ul>
<li>The cPanel user must own the Webmail account.</li>
<li>This function works like the UAPI Session::create_webmail_session_for_mail_user function with one exception. This function requires a correct password to create the Webmail session. If you use an incorrect password or attempt to connect to a suspended account, the login will fail.</li>
</ul>
<h3 id="how-to-use-this-api">How to use this API</h3>
<p>After you successfully call this API, you will need to log in to <a href="https://go.cpanel.net/webmailinterface">Webmail</a>.
To do this, send an HTTP POST to <code>https://$URL_AUTHTY:2096$token/login</code> with a message body of <code>session=$session</code> where:</p>
<ul>
<li><code>$URL_AUTHTY</code> represents the value from the <code>hostname</code> return.<ul>
<li>If the <code>hostname</code> return value is <code>null</code>, enter the hostname of the server that answered the API function.</li>
<li><code>$token</code> represents the value from the token return.</li>
</ul>
</li>
<li><code>$session</code> represents the value of the session return.</li>
</ul>
<p>For example, an HTTP POST may resemble the following:</p>
<p><code>https://hostname.example.com:2096/cpsess2462418786/login</code></p>
<p>With a message body of:</p>
<p><code>session=username:D7NiAZv1nf4bXeg9:CREATE_WEBMAIL_SESSION_FOR_MAIL_USER,728fb86a7df1cf20690c65f349ac3137</code></p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The domain for the Webmail account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain for the Webmail account.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="locale" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">locale</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">locale=en</span></div><div><div html="&lt;p&gt;The &lt;a href=&quot;https://go.cpanel.net/localedocs&quot;&gt;locale&lt;/a&gt; that the new session will use.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;You must &lt;strong&gt;only&lt;/strong&gt; enter lowercase characters.&lt;/li&gt;
&lt;li&gt;This parameter defaults to the cPanel user&amp;#39;s locale.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The <a href="https://go.cpanel.net/localedocs">locale</a> that the new session will use.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You must <strong>only</strong> enter lowercase characters.</li>
<li>This parameter defaults to the cPanel user&#39;s locale.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="login" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">login</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">login=username</span></div><div><div html="&lt;p&gt;The Webmail account&amp;#39;s username.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Webmail account&#39;s username.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="password" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">password</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">password=luggage12345</span></div><div><div html="&lt;p&gt;The password for the Webmail account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The password for the Webmail account.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="remote_address" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">remote_address</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;ipv4&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">remote_address=192.168.0.1</span></div><div><div html="&lt;p&gt;The session&amp;#39;s account&amp;#39;s client IP address.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;If you run this function from the command line, this parameter is &lt;strong&gt;required&lt;/strong&gt;.&lt;/li&gt;
&lt;li&gt;This parameter defaults to the API caller&amp;#39;s IP address.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The session&#39;s account&#39;s client IP address.</p>
<p><strong>Note:</strong></p>
<ul>
<li>If you run this function from the command line, this parameter is <strong>required</strong>.</li>
<li>This parameter defaults to the API caller&#39;s IP address.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Session/create_webmail_session_for_mail_user_check_password</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Session/create_webmail_session_for_mail_user_check_password</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R996t6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R996t6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R996t6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R996t6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R996t6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R996t6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R996t6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R996t6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R996t6a:0" aria-labelledby="tab:R996t6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Session <span class="token punctuation">\</span>
  create_webmail_session_for_mail_user_check_password <span class="token punctuation">\</span>
  <span class="token assign-left variable">login</span><span class="token operator">=</span><span class="token string">'username'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">password</span><span class="token operator">=</span><span class="token string">'luggage12345'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R996t6a:1" aria-labelledby="tab:R996t6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R996t6a:2" aria-labelledby="tab:R996t6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R996t6a:3" aria-labelledby="tab:R996t6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p6t6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p6t6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p6t6a:0" aria-labelledby="tab:R9p6t6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;create_webmail_session_for_mail_user_check_password&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Session&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"hostname"</span>: <span class="token string">&quot;hostname.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"session"</span>: <span class="token string">&quot;username:D7NiAZv1nf4bXeg9:CREATE_WEBMAIL_SESSION_FOR_MAIL_USER,728fb86a7df1cf20690c65f349ac3137&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"token"</span>: <span class="token string">&quot;/cpsess2462418786&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Webmail-Sessions/operation/create_webmail_session_for_self" data-section-id="tag/Webmail-Sessions/operation/create_webmail_session_for_self" class="sc-dntaoT ceciOs"><div data-section-id="operation/create_webmail_session_for_self" id="operation/create_webmail_session_for_self" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Webmail-Sessions/operation/create_webmail_session_for_self" aria-label="tag/Webmail-Sessions/operation/create_webmail_session_for_self"></a>Create Webmail session for current user </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;Create a temporary session to connect to Webmail for the authenticated cPanel user.&lt;/p&gt;
&lt;h3 id=&quot;how-to-use-this-api&quot;&gt;How to use this API&lt;/h3&gt;
&lt;p&gt;After you successfully call this API, you will need to log in to &lt;a href=&quot;https://go.cpanel.net/webmailinterface&quot;&gt;Webmail&lt;/a&gt;.
To do this, send an HTTP POST to &lt;code&gt;https://$URL_AUTHTY:2096$token/login&lt;/code&gt; with a message body of &lt;code&gt;session=$session&lt;/code&gt; where:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;$URL_AUTHTY&lt;/code&gt; represents the value from the &lt;code&gt;hostname&lt;/code&gt; return.&lt;ul&gt;
&lt;li&gt;If the &lt;code&gt;hostname&lt;/code&gt; return value is &lt;code&gt;null&lt;/code&gt;, enter the hostname of the server that answered the API function.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;$token&lt;/code&gt; represents the value from the token return.&lt;/li&gt;
&lt;/ul&gt;
&lt;/li&gt;
&lt;li&gt;&lt;code&gt;$session&lt;/code&gt; represents the value of the session return.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;For example, an HTTP POST may resemble the following:&lt;/p&gt;
&lt;p&gt;&lt;code&gt;https://hostname.example.com:2096/cpsess2462418786/login&lt;/code&gt;&lt;/p&gt;
&lt;p&gt;With a message body of:&lt;/p&gt;
&lt;p&gt;&lt;code&gt;session=username:D7NiAZv1nf4bXeg9:CREATE_WEBMAIL_SESSION_FOR_MAIL_USER,728fb86a7df1cf20690c65f349ac3137&lt;/code&gt;&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>Create a temporary session to connect to Webmail for the authenticated cPanel user.</p>
<h3 id="how-to-use-this-api">How to use this API</h3>
<p>After you successfully call this API, you will need to log in to <a href="https://go.cpanel.net/webmailinterface">Webmail</a>.
To do this, send an HTTP POST to <code>https://$URL_AUTHTY:2096$token/login</code> with a message body of <code>session=$session</code> where:</p>
<ul>
<li><code>$URL_AUTHTY</code> represents the value from the <code>hostname</code> return.<ul>
<li>If the <code>hostname</code> return value is <code>null</code>, enter the hostname of the server that answered the API function.</li>
<li><code>$token</code> represents the value from the token return.</li>
</ul>
</li>
<li><code>$session</code> represents the value of the session return.</li>
</ul>
<p>For example, an HTTP POST may resemble the following:</p>
<p><code>https://hostname.example.com:2096/cpsess2462418786/login</code></p>
<p>With a message body of:</p>
<p><code>session=username:D7NiAZv1nf4bXeg9:CREATE_WEBMAIL_SESSION_FOR_MAIL_USER,728fb86a7df1cf20690c65f349ac3137</code></p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="locale" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">locale</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">locale=en</span></div><div><div html="&lt;p&gt;The &lt;a href=&quot;https://go.cpanel.net/localedocs&quot;&gt;locale&lt;/a&gt; that the new session will use.&lt;/p&gt;
&lt;p&gt;Use UAPI &lt;code&gt;Locale::list_locales&lt;/code&gt; to see a list of valid locales.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;You must &lt;strong&gt;only&lt;/strong&gt; enter lowercase characters.&lt;/li&gt;
&lt;li&gt;This parameter defaults to the cPanel user&amp;#39;s locale.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The <a href="https://go.cpanel.net/localedocs">locale</a> that the new session will use.</p>
<p>Use UAPI <code>Locale::list_locales</code> to see a list of valid locales.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You must <strong>only</strong> enter lowercase characters.</li>
<li>This parameter defaults to the cPanel user&#39;s locale.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="remote_address" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">remote_address</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;ipv4&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">remote_address=192.168.0.1</span></div><div><div html="&lt;p&gt;The session&amp;#39;s client IP address.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;If you run this function from the command line, this parameter is &lt;strong&gt;required&lt;/strong&gt;.&lt;/li&gt;
&lt;li&gt;This parameter defaults to the API caller&amp;#39;s IP address.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The session&#39;s client IP address.</p>
<p><strong>Note:</strong></p>
<ul>
<li>If you run this function from the command line, this parameter is <strong>required</strong>.</li>
<li>This parameter defaults to the API caller&#39;s IP address.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Session/create_webmail_session_for_self</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Session/create_webmail_session_for_self</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99at6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99at6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99at6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99at6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99at6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99at6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99at6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99at6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99at6a:0" aria-labelledby="tab:R99at6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Session <span class="token punctuation">\</span>
  create_webmail_session_for_self
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99at6a:1" aria-labelledby="tab:R99at6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99at6a:2" aria-labelledby="tab:R99at6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99at6a:3" aria-labelledby="tab:R99at6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pat6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pat6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pat6a:0" aria-labelledby="tab:R9pat6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;create_webmail_session_for_self&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Session&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"hostname"</span>: <span class="token string">&quot;hostname.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"session"</span>: <span class="token string">&quot;username:D7NiAZv1nf4bXeg9:CREATE_WEBMAIL_SESSION_FOR_SELF,728fb86a7df1cf20690c65f349ac3137&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"token"</span>: <span class="token string">&quot;/cpsess2462418786&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Webmail-Sessions/operation/create_webmail_session_for_mail_user" data-section-id="tag/Webmail-Sessions/operation/create_webmail_session_for_mail_user" class="sc-dntaoT ceciOs"><div data-section-id="operation/create_webmail_session_for_mail_user" id="operation/create_webmail_session_for_mail_user" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Webmail-Sessions/operation/create_webmail_session_for_mail_user" aria-label="tag/Webmail-Sessions/operation/create_webmail_session_for_mail_user"></a>Create Webmail session </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;Create a temporary session for a cPanel user to connect to Webmail.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;The cPanel user must own the Webmail account.&lt;/p&gt;
&lt;h3 id=&quot;how-to-use-this-api&quot;&gt;How to use this API&lt;/h3&gt;
&lt;p&gt;After you successfully call this API, you will need to log in to &lt;a href=&quot;https://go.cpanel.net/webmailinterface&quot;&gt;Webmail&lt;/a&gt;.
To do this, send an HTTP POST to &lt;code&gt;https://$URL_AUTHTY:2096$token/login&lt;/code&gt; with a message body of &lt;code&gt;session=$session&lt;/code&gt; where:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;$URL_AUTHTY&lt;/code&gt; represents the value from the &lt;code&gt;hostname&lt;/code&gt; return.&lt;ul&gt;
&lt;li&gt;If the &lt;code&gt;hostname&lt;/code&gt; return value is &lt;code&gt;null&lt;/code&gt;, enter the hostname of the server that answered the API function.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;$token&lt;/code&gt; represents the value from the token return.&lt;/li&gt;
&lt;/ul&gt;
&lt;/li&gt;
&lt;li&gt;&lt;code&gt;$session&lt;/code&gt; represents the value of the session return.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;For example, an HTTP POST may resemble the following:&lt;/p&gt;
&lt;p&gt;&lt;code&gt;https://hostname.example.com:2096/cpsess2462418786/login&lt;/code&gt;&lt;/p&gt;
&lt;p&gt;With a message body of:&lt;/p&gt;
&lt;p&gt;&lt;code&gt;session=username:D7NiAZv1nf4bXeg9:CREATE_WEBMAIL_SESSION_FOR_MAIL_USER,728fb86a7df1cf20690c65f349ac3137&lt;/code&gt;&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>Create a temporary session for a cPanel user to connect to Webmail.</p>
<p><strong>Note:</strong></p>
<p>The cPanel user must own the Webmail account.</p>
<h3 id="how-to-use-this-api">How to use this API</h3>
<p>After you successfully call this API, you will need to log in to <a href="https://go.cpanel.net/webmailinterface">Webmail</a>.
To do this, send an HTTP POST to <code>https://$URL_AUTHTY:2096$token/login</code> with a message body of <code>session=$session</code> where:</p>
<ul>
<li><code>$URL_AUTHTY</code> represents the value from the <code>hostname</code> return.<ul>
<li>If the <code>hostname</code> return value is <code>null</code>, enter the hostname of the server that answered the API function.</li>
<li><code>$token</code> represents the value from the token return.</li>
</ul>
</li>
<li><code>$session</code> represents the value of the session return.</li>
</ul>
<p>For example, an HTTP POST may resemble the following:</p>
<p><code>https://hostname.example.com:2096/cpsess2462418786/login</code></p>
<p>With a message body of:</p>
<p><code>session=username:D7NiAZv1nf4bXeg9:CREATE_WEBMAIL_SESSION_FOR_MAIL_USER,728fb86a7df1cf20690c65f349ac3137</code></p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The domain for the Webmail account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain for the Webmail account.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="locale" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">locale</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">locale=en</span></div><div><div html="&lt;p&gt;The &lt;a href=&quot;https://go.cpanel.net/localedocs&quot;&gt;locale&lt;/a&gt; that the new session will use.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;You must &lt;strong&gt;only&lt;/strong&gt; enter lowercase characters.&lt;/li&gt;
&lt;li&gt;This parameter defaults to the cPanel user&amp;#39;s locale.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The <a href="https://go.cpanel.net/localedocs">locale</a> that the new session will use.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You must <strong>only</strong> enter lowercase characters.</li>
<li>This parameter defaults to the cPanel user&#39;s locale.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="login" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">login</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">login=username</span></div><div><div html="&lt;p&gt;The Webmail account&amp;#39;s username.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Webmail account&#39;s username.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="remote_address" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">remote_address</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;ipv4&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">remote_address=192.168.0.1</span></div><div><div html="&lt;p&gt;The session&amp;#39;s client IP address.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;If you run this function from the command line, this parameter is &lt;strong&gt;required&lt;/strong&gt;.&lt;/li&gt;
&lt;li&gt;This parameter defaults to the API caller&amp;#39;s IP address.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The session&#39;s client IP address.</p>
<p><strong>Note:</strong></p>
<ul>
<li>If you run this function from the command line, this parameter is <strong>required</strong>.</li>
<li>This parameter defaults to the API caller&#39;s IP address.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Session/create_webmail_session_for_mail_user</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Session/create_webmail_session_for_mail_user</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99et6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99et6a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99et6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99et6a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99et6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99et6a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99et6a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99et6a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99et6a:0" aria-labelledby="tab:R99et6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Session <span class="token punctuation">\</span>
  create_webmail_session_for_mail_user <span class="token punctuation">\</span>
  <span class="token assign-left variable">login</span><span class="token operator">=</span><span class="token string">'username'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99et6a:1" aria-labelledby="tab:R99et6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99et6a:2" aria-labelledby="tab:R99et6a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99et6a:3" aria-labelledby="tab:R99et6a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pet6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pet6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pet6a:0" aria-labelledby="tab:R9pet6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;create_webmail_session_for_mail_user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Session&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"hostname"</span>: <span class="token string">&quot;hostname.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"session"</span>: <span class="token string">&quot;username:D7NiAZv1nf4bXeg9:CREATE_WEBMAIL_SESSION_FOR_MAIL_USER,728fb86a7df1cf20690c65f349ac3137&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"token"</span>: <span class="token string">&quot;/cpsess2462418786&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Webmail-Sessions/operation/create_temp_user" data-section-id="tag/Webmail-Sessions/operation/create_temp_user" class="sc-dntaoT ceciOs"><div data-section-id="operation/create_temp_user" id="operation/create_temp_user" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Webmail-Sessions/operation/create_temp_user" aria-label="tag/Webmail-Sessions/operation/create_temp_user"></a>Create user session with existing session </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function creates a temporary user session.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;Because this function requires a valid cPanel session ID, you &lt;strong&gt;must&lt;/strong&gt; call it via a cPanel or Webmail session URL. If you call this function via the command line or Template Toolkit, it will &lt;strong&gt;not&lt;/strong&gt; create a temporary user session. You &lt;strong&gt;must&lt;/strong&gt; use the WHM API 1 &lt;code&gt;create_user_session&lt;/code&gt; function to create a temporary user session.&lt;/li&gt;
&lt;li&gt;Third-party plugins that require access to temporary MySQL users &lt;strong&gt;must&lt;/strong&gt; call this function via the URL. It will create the temporary users before they are available. You can find these users in the &lt;code&gt;$ENV{&amp;#39;REMOTE_DBOWNER&amp;#39;}&lt;/code&gt; environment variable.&lt;/li&gt;
&lt;li&gt;If you &lt;strong&gt;cannot&lt;/strong&gt; update your system, update your scripts to call the &lt;code&gt;Cgi::phpmyadminlink&lt;/code&gt; function. This will create a temporary user session for you.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a temporary user session.</p>
<p><strong>Important:</strong></p>
<ul>
<li>Because this function requires a valid cPanel session ID, you <strong>must</strong> call it via a cPanel or Webmail session URL. If you call this function via the command line or Template Toolkit, it will <strong>not</strong> create a temporary user session. You <strong>must</strong> use the WHM API 1 <code>create_user_session</code> function to create a temporary user session.</li>
<li>Third-party plugins that require access to temporary MySQL users <strong>must</strong> call this function via the URL. It will create the temporary users before they are available. You can find these users in the <code>$ENV{&#39;REMOTE_DBOWNER&#39;}</code> environment variable.</li>
<li>If you <strong>cannot</strong> update your system, update your scripts to call the <code>Cgi::phpmyadminlink</code> function. This will create a temporary user session for you.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Session/create_temp_user</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Session/create_temp_user</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99it6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99it6a:0" tabindex="0" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99it6a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99it6a:1" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99it6a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99it6a:2" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99it6a:0" aria-labelledby="tab:R99it6a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs"><span class="token header"><span class="token header-name keyword">https</span><span class="token punctuation">:</span><span class="token header-value">//hostname.example.com:2083/cpsess##########/execute/Session/create_temp_user</span></span></pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99it6a:1" aria-labelledby="tab:R99it6a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99it6a:2" aria-labelledby="tab:R99it6a:2"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pit6a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pit6a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pit6a:0" aria-labelledby="tab:R9pit6a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;create_temp_user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Session&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"session_temp_user"</span>: <span class="token string">&quot;cpses_reviY3ZSQK&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/FTP-Accounts" data-section-id="tag/FTP-Accounts" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/FTP-Accounts" aria-label="tag/FTP-Accounts"></a>FTP Accounts</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Files / FTP Accounts&lt;/p&gt;
"><p>Files / FTP Accounts</p>
</div></div></div><div id="tag/FTP-Accounts/operation/add_ftp" data-section-id="tag/FTP-Accounts/operation/add_ftp" class="sc-dntaoT ceciOs"><div data-section-id="operation/add_ftp" id="operation/add_ftp" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/FTP-Accounts/operation/add_ftp" aria-label="tag/FTP-Accounts/operation/add_ftp"></a>Create FTP account </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function creates an FTP account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;FTP role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates an FTP account.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">FTP role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="disallowdot" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">disallowdot</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">disallowdot=1</span></div><div><div html="&lt;p&gt;Whether to strip dots (&lt;code&gt;.&lt;/code&gt;) from the username.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Strip dots.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Do &lt;strong&gt;not&lt;/strong&gt; strip dots.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to strip dots (<code>.</code>) from the username.</p>
<ul>
<li><code>1</code> — Strip dots.</li>
<li><code>0</code> — Do <strong>not</strong> strip dots.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The FTP user&amp;#39;s associated domain. This must be a domain that the cPanel account owns.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This parameter defaults to the cPanel account&amp;#39;s primary domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The FTP user&#39;s associated domain. This must be a domain that the cPanel account owns.</p>
<p><strong>Note:</strong></p>
<p>This parameter defaults to the cPanel account&#39;s primary domain.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="homedir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">homedir</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">homedir=exampleftp</span></div><div><div html="&lt;p&gt;The path to the FTP account&amp;#39;s root directory, relative to the cPanel account&amp;#39;s home directory. If you don&amp;#39;t set this, it defaults to a directory with the same name as the FTP account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The path to the FTP account&#39;s root directory, relative to the cPanel account&#39;s home directory. If you don&#39;t set this, it defaults to a directory with the same name as the FTP account.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="pass" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">pass</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">pass=123456luggage</span></div><div><div html="&lt;p&gt;The new FTP account password.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You can use the &lt;code&gt;pass_hash&lt;/code&gt; parameter in place of this parameter. However, you &lt;strong&gt;cannot&lt;/strong&gt; use both the &lt;code&gt;pass&lt;/code&gt; and &lt;code&gt;pass_hash&lt;/code&gt; parameters in the same request.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new FTP account password.</p>
<p><strong>Note:</strong></p>
<p>You can use the <code>pass_hash</code> parameter in place of this parameter. However, you <strong>cannot</strong> use both the <code>pass</code> and <code>pass_hash</code> parameters in the same request.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="pass_hash" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">pass_hash</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;&quot;</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">pass_hash=$6$1sOyHP5ZDYp3pGUz$R0TSgfPRHfDjT5PP5RJGv39FhiGTNNPvM7IFpCBjXijMmlMZk9yI8T3LqGuntc9fdKb5eX.lGL7wBS9e4DAWn/</span></div><div><div html="&lt;p&gt;The account&amp;#39;s password hash.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;You can use this parameter in place of the &lt;code&gt;pass&lt;/code&gt; parameter. However, you &lt;strong&gt;cannot&lt;/strong&gt; use both the &lt;code&gt;pass&lt;/code&gt; and &lt;code&gt;pass_hash&lt;/code&gt; parameters in the same request.&lt;/li&gt;
&lt;li&gt;You can find your server&amp;#39;s password hash type in the &lt;code&gt;/etc/sysconfig/authconfig&lt;/code&gt; file.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account&#39;s password hash.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You can use this parameter in place of the <code>pass</code> parameter. However, you <strong>cannot</strong> use both the <code>pass</code> and <code>pass_hash</code> parameters in the same request.</li>
<li>You can find your server&#39;s password hash type in the <code>/etc/sysconfig/authconfig</code> file.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="quota" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">quota</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= 0 </span></span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">quota=42</span></div><div><div html="&lt;p&gt;The FTP account&amp;#39;s maximum disk usage quota, in megabytes (MB).&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;A value of &lt;code&gt;0&lt;/code&gt; grants the FTP account unlimited disk space.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The FTP account&#39;s maximum disk usage quota, in megabytes (MB).</p>
<p><strong>Note:</strong></p>
<p>A value of <code>0</code> grants the FTP account unlimited disk space.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=username</span></div><div><div html="&lt;p&gt;The new FTP account username.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new FTP account username.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Ftp/add_ftp</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Ftp/add_ftp</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99336q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99336q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99336q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99336q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99336q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99336q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99336q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99336q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99336q:0" aria-labelledby="tab:R99336q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Ftp <span class="token punctuation">\</span>
  add_ftp <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'username2'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">pass</span><span class="token operator">=</span><span class="token string">'123456luggage'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99336q:1" aria-labelledby="tab:R99336q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99336q:2" aria-labelledby="tab:R99336q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99336q:3" aria-labelledby="tab:R99336q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p336q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p336q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p336q:0" aria-labelledby="tab:R9p336q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;add_ftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Ftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/FTP-Accounts/operation/delete_ftp" data-section-id="tag/FTP-Accounts/operation/delete_ftp" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete_ftp" id="operation/delete_ftp" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/FTP-Accounts/operation/delete_ftp" aria-label="tag/FTP-Accounts/operation/delete_ftp"></a>Delete FTP account </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function deletes an FTP account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;FTP&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes an FTP account.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles"><em>FTP</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="destroy" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">destroy</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">destroy=1</span></div><div><div html="&lt;p&gt;Whether to delete the FTP account&amp;#39;s home directory.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Delete the home directory.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Do &lt;strong&gt;not&lt;/strong&gt; delete the home directory.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to delete the FTP account&#39;s home directory.</p>
<ul>
<li><code>1</code> — Delete the home directory.</li>
<li><code>0</code> — Do <strong>not</strong> delete the home directory.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The user&amp;#39;s associated domain.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This parameter defaults to the cPanel account&amp;#39;s primary domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user&#39;s associated domain.</p>
<p><strong>Note:</strong></p>
<p>This parameter defaults to the cPanel account&#39;s primary domain.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=username</span></div><div><div html="&lt;p&gt;The FTP account&amp;#39;s username.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The FTP account&#39;s username.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Ftp/delete_ftp</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Ftp/delete_ftp</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99536q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99536q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99536q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99536q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99536q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99536q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99536q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99536q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99536q:0" aria-labelledby="tab:R99536q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Ftp <span class="token punctuation">\</span>
  delete_ftp <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'username2'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99536q:1" aria-labelledby="tab:R99536q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99536q:2" aria-labelledby="tab:R99536q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99536q:3" aria-labelledby="tab:R99536q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p536q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p536q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p536q:0" aria-labelledby="tab:R9p536q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;delete_ftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Ftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/FTP-Accounts/operation/ftp_exists" data-section-id="tag/FTP-Accounts/operation/ftp_exists" class="sc-dntaoT ceciOs"><div data-section-id="operation/ftp_exists" id="operation/ftp_exists" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/FTP-Accounts/operation/ftp_exists" aria-label="tag/FTP-Accounts/operation/ftp_exists"></a>Return whether an FTP account exists </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function checks whether an FTP account exists.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This function returns only metadata if the FTP account exists, or an error if the FTP account does &lt;strong&gt;not&lt;/strong&gt; exist.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether an FTP account exists.</p>
<p><strong>Note:</strong></p>
<p>This function returns only metadata if the FTP account exists, or an error if the FTP account does <strong>not</strong> exist.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The user&amp;#39;s associated domain.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This parameter defaults to the cPanel account&amp;#39;s primary domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user&#39;s associated domain.</p>
<p><strong>Note:</strong></p>
<p>This parameter defaults to the cPanel account&#39;s primary domain.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=us_chickens</span></div><div><div html="&lt;p&gt;The FTP account&amp;#39;s username.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The FTP account&#39;s username.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Ftp/ftp_exists</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Ftp/ftp_exists</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99736q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99736q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99736q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99736q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99736q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99736q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99736q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99736q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99736q:0" aria-labelledby="tab:R99736q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Ftp <span class="token punctuation">\</span>
  ftp_exists <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'us_chickens'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99736q:1" aria-labelledby="tab:R99736q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99736q:2" aria-labelledby="tab:R99736q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99736q:3" aria-labelledby="tab:R99736q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p736q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p736q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p736q:0" aria-labelledby="tab:R9p736q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;ftp_exists&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Ftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/FTP-Accounts/operation/get_quota" data-section-id="tag/FTP-Accounts/operation/get_quota" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_quota" id="operation/get_quota" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/FTP-Accounts/operation/get_quota" aria-label="tag/FTP-Accounts/operation/get_quota"></a>Return FTP account&#x27;s quota </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function checks an FTP account&amp;#39;s quota.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;FTP role&lt;/em&gt;&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks an FTP account&#39;s quota.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>FTP role</em></a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="account" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">account</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">account=user1</span></div><div><div html="&lt;p&gt;The FTP account&amp;#39;s username.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The FTP account&#39;s username.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The user&amp;#39;s associated domain.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This parameter defaults to the cPanel account&amp;#39;s primary domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user&#39;s associated domain.</p>
<p><strong>Note:</strong></p>
<p>This parameter defaults to the cPanel account&#39;s primary domain.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Ftp/get_quota</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Ftp/get_quota</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99936q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99936q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99936q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99936q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99936q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99936q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99936q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99936q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99936q:0" aria-labelledby="tab:R99936q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Ftp <span class="token punctuation">\</span>
  get_quota <span class="token punctuation">\</span>
  <span class="token assign-left variable">account</span><span class="token operator">=</span><span class="token string">'user1'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99936q:1" aria-labelledby="tab:R99936q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99936q:2" aria-labelledby="tab:R99936q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99936q:3" aria-labelledby="tab:R99936q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p936q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p936q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p936q:0" aria-labelledby="tab:R9p936q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_quota&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Ftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token string">&quot;unlimited&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/FTP-Accounts/operation/get_welcome_message" data-section-id="tag/FTP-Accounts/operation/get_welcome_message" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_welcome_message" id="operation/get_welcome_message" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/FTP-Accounts/operation/get_welcome_message" aria-label="tag/FTP-Accounts/operation/get_welcome_message"></a>Return FTP account&#x27;s welcome message </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves the cPanel account&amp;#39;s FTP welcome message.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;FTP&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the cPanel account&#39;s FTP welcome message.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>FTP</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Ftp/get_welcome_message</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Ftp/get_welcome_message</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99b36q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99b36q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99b36q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b36q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99b36q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b36q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99b36q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b36q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99b36q:0" aria-labelledby="tab:R99b36q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Ftp <span class="token punctuation">\</span>
  get_welcome_message
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b36q:1" aria-labelledby="tab:R99b36q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b36q:2" aria-labelledby="tab:R99b36q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b36q:3" aria-labelledby="tab:R99b36q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pb36q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pb36q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pb36q:0" aria-labelledby="tab:R9pb36q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_welcome_message&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Ftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token string">&quot;Greetings, Professor Falken.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/FTP-Accounts/operation/list_ftp_with_disk" data-section-id="tag/FTP-Accounts/operation/list_ftp_with_disk" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_ftp_with_disk" id="operation/list_ftp_with_disk" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/FTP-Accounts/operation/list_ftp_with_disk" aria-label="tag/FTP-Accounts/operation/list_ftp_with_disk"></a>Return FTP accounts and disk usage </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists FTP account and disk usage information.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;FTP role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists FTP account and disk usage information.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">FTP role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="include_acct_types" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">include_acct_types</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">include_acct_types=main|anonymous</span></div><div><div html="&lt;p&gt;A pipe-delimited list of the FTP account types to include in the function&amp;#39;s results.
If you do not specify this parameter, the function returns all FTP account types.&lt;/p&gt;
&lt;p&gt;Valid types for this list are:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;anonymous&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;logaccess&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;main&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;sub&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A pipe-delimited list of the FTP account types to include in the function&#39;s results.
If you do not specify this parameter, the function returns all FTP account types.</p>
<p>Valid types for this list are:</p>
<ul>
<li><code>anonymous</code></li>
<li><code>logaccess</code></li>
<li><code>main</code></li>
<li><code>sub</code></li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="skip_acct_types" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">skip_acct_types</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">skip_acct_types=main|anonymous</span></div><div><div html="&lt;p&gt;A pipe-delimited list of the FTP account types to exclude from the function&amp;#39;s
results. If you do not specify this parameter, the function does &lt;strong&gt;not&lt;/strong&gt; exclude
any account types.&lt;/p&gt;
&lt;p&gt;Valid types for this list are:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;anonymous&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;logaccess&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;main&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;sub&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A pipe-delimited list of the FTP account types to exclude from the function&#39;s
results. If you do not specify this parameter, the function does <strong>not</strong> exclude
any account types.</p>
<p>Valid types for this list are:</p>
<ul>
<li><code>anonymous</code></li>
<li><code>logaccess</code></li>
<li><code>main</code></li>
<li><code>sub</code></li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Ftp/list_ftp_with_disk</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Ftp/list_ftp_with_disk</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99d36q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99d36q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99d36q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d36q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99d36q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d36q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99d36q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d36q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99d36q:0" aria-labelledby="tab:R99d36q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Ftp <span class="token punctuation">\</span>
  list_ftp_with_disk
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99d36q:1" aria-labelledby="tab:R99d36q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99d36q:2" aria-labelledby="tab:R99d36q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99d36q:3" aria-labelledby="tab:R99d36q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pd36q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pd36q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pd36q:0" aria-labelledby="tab:R9pd36q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_ftp_with_disk&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Ftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"_diskquota"</span>: <span class="token string">&quot;476.84&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"_diskused"</span>: <span class="token string">&quot;2.34&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"accttype"</span>: <span class="token string">&quot;sub&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deleteable"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dir"</span>: <span class="token string">&quot;/home/user/public_ftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"diskquota"</span>: <span class="token string">&quot;476.84&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"diskused"</span>: <span class="token string">&quot;2.34&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"diskusedpercent"</span>: <span class="token number">21</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"diskusedpercent20"</span>: <span class="token number">20</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"htmldir"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"humandiskquota"</span>: <span class="token string">&quot;477 MB&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"humandiskused"</span>: <span class="token string">&quot;2 MB&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"login"</span>: <span class="token string">&quot;ftpaccount&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reldir"</span>: <span class="token string">&quot;public_ftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"serverlogin"</span>: <span class="token string">&quot;ftpaccount@example.com&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/FTP-Accounts/operation/passwd" data-section-id="tag/FTP-Accounts/operation/passwd" class="sc-dntaoT ceciOs"><div data-section-id="operation/passwd" id="operation/passwd" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/FTP-Accounts/operation/passwd" aria-label="tag/FTP-Accounts/operation/passwd"></a>Update FTP account&#x27;s password </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function changes an FTP account&amp;#39;s password.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;FTP role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function changes an FTP account&#39;s password.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">FTP role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The user&amp;#39;s associated domain.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This parameter defaults to the cPanel account&amp;#39;s primary domain&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user&#39;s associated domain.</p>
<p><strong>Note:</strong></p>
<p>This parameter defaults to the cPanel account&#39;s primary domain</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="pass" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">pass</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">pass=12345luggage</span></div><div><div html="&lt;p&gt;The FTP account&amp;#39;s new password.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The FTP account&#39;s new password.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=ftpaccount</span></div><div><div html="&lt;p&gt;The FTP account username.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The FTP account username.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Ftp/passwd</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Ftp/passwd</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99f36q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99f36q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99f36q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f36q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99f36q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f36q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99f36q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f36q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99f36q:0" aria-labelledby="tab:R99f36q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Ftp <span class="token punctuation">\</span>
  <span class="token function">passwd</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'ftpaccount'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">pass</span><span class="token operator">=</span><span class="token string">'123456luggage'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99f36q:1" aria-labelledby="tab:R99f36q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99f36q:2" aria-labelledby="tab:R99f36q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99f36q:3" aria-labelledby="tab:R99f36q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pf36q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pf36q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pf36q:0" aria-labelledby="tab:R9pf36q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;passwd&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Ftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/FTP-Accounts/operation/set_homedir" data-section-id="tag/FTP-Accounts/operation/set_homedir" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_homedir" id="operation/set_homedir" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/FTP-Accounts/operation/set_homedir" aria-label="tag/FTP-Accounts/operation/set_homedir"></a>Update FTP account&#x27;s home directory </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function changes the home directory for FTP accounts.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;FTP role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function changes the home directory for FTP accounts.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">FTP role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The user&amp;#39;s associated domain.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;The default value is the cPanel account&amp;#39;s primary domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user&#39;s associated domain.</p>
<p><strong>Note:</strong></p>
<p>The default value is the cPanel account&#39;s primary domain.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="homedir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">homedir</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;user@domain/&quot;</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">homedir=example1/</span></div><div><div html="&lt;p&gt;The FTP account&amp;#39;s home directory&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This parameter defaults to the &lt;code&gt;user@domain&lt;/code&gt; subdirectory in the cPanel account&amp;#39;s home directory with the name, where user and domain represent the &lt;code&gt;user&lt;/code&gt; and &lt;code&gt;domain&lt;/code&gt; parameters.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The FTP account&#39;s home directory</p>
<p><strong>Note:</strong></p>
<p>This parameter defaults to the <code>user@domain</code> subdirectory in the cPanel account&#39;s home directory with the name, where user and domain represent the <code>user</code> and <code>domain</code> parameters.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=example1</span></div><div><div html="&lt;p&gt;The FTP account username.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The FTP account username.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Ftp/set_homedir</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Ftp/set_homedir</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99h36q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99h36q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99h36q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h36q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99h36q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h36q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99h36q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h36q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99h36q:0" aria-labelledby="tab:R99h36q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Ftp <span class="token punctuation">\</span>
  set_homedir <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'example1'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h36q:1" aria-labelledby="tab:R99h36q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h36q:2" aria-labelledby="tab:R99h36q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h36q:3" aria-labelledby="tab:R99h36q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9ph36q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9ph36q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9ph36q:0" aria-labelledby="tab:R9ph36q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_homedir&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Ftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/FTP-Accounts/operation/set_quota" data-section-id="tag/FTP-Accounts/operation/set_quota" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_quota" id="operation/set_quota" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/FTP-Accounts/operation/set_quota" aria-label="tag/FTP-Accounts/operation/set_quota"></a>Update FTP account&#x27;s quota </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function changes an FTP account&amp;#39;s quota.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;FTP role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function changes an FTP account&#39;s quota.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">FTP role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The user&amp;#39;s associated domain.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;The default value is the cPanel account&amp;#39;s primary domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user&#39;s associated domain.</p>
<p><strong>Note:</strong></p>
<p>The default value is the cPanel account&#39;s primary domain.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="kill" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">kill</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">kill=0</span></div><div><div html="&lt;p&gt;Whether to disable quotas for the FTP account.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Disable quotas.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Enable quotas.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; If you disable quotas for an FTP account, you grant that account unlimited disk space.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to disable quotas for the FTP account.</p>
<ul>
<li><code>1</code> - Disable quotas.</li>
<li><code>0</code> - Enable quotas.</li>
</ul>
<p><strong>Note:</strong></p>
<p> If you disable quotas for an FTP account, you grant that account unlimited disk space.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="quota" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">quota</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= 0 </span></span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">quota=500</span></div><div><div html="&lt;p&gt;The new quota, in megabytes.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;Setting this parameter to &lt;code&gt;0&lt;/code&gt; grants the account unlimited disk space.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new quota, in megabytes.</p>
<p><strong>Note:</strong></p>
<p>Setting this parameter to <code>0</code> grants the account unlimited disk space.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=ftpaccount</span></div><div><div html="&lt;p&gt;The FTP account username.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The FTP account username.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Ftp/set_quota</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Ftp/set_quota</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99j36q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99j36q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99j36q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99j36q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99j36q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99j36q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99j36q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99j36q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99j36q:0" aria-labelledby="tab:R99j36q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Ftp <span class="token punctuation">\</span>
  set_quota <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'ftpaccount'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99j36q:1" aria-labelledby="tab:R99j36q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99j36q:2" aria-labelledby="tab:R99j36q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99j36q:3" aria-labelledby="tab:R99j36q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pj36q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pj36q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pj36q:0" aria-labelledby="tab:R9pj36q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_quota&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Ftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/FTP-Accounts/operation/list_ftp" data-section-id="tag/FTP-Accounts/operation/list_ftp" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_ftp" id="operation/list_ftp" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/FTP-Accounts/operation/list_ftp" aria-label="tag/FTP-Accounts/operation/list_ftp"></a>Return FTP accounts </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists FTP account information.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;&lt;em&gt;FTP&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function. For more information, read our How to Use Server Profiles documentation.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists FTP account information.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles"><em>FTP</em> role</a>, the system <strong>disables</strong> this function. For more information, read our How to Use Server Profiles documentation.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="include_acct_types" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">include_acct_types</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">include_acct_types=main|anonymous</span></div><div><div html="&lt;p&gt;A list of the FTP account types to include in the function&amp;#39;s results.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;anonymous&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;logaccess&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;main&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;sub&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;If you do not specify this parameter, this function returns all FTP account
types.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;Separate multiple types with the pipe character (&lt;code&gt;|&lt;/code&gt;).&lt;/li&gt;
&lt;li&gt;In browser-based calls, use &lt;code&gt;%7C&lt;/code&gt;.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A list of the FTP account types to include in the function&#39;s results.</p>
<ul>
<li><code>anonymous</code></li>
<li><code>logaccess</code></li>
<li><code>main</code></li>
<li><code>sub</code></li>
</ul>
<p>If you do not specify this parameter, this function returns all FTP account
types.</p>
<p><strong>Note:</strong></p>
<ul>
<li>Separate multiple types with the pipe character (<code>|</code>).</li>
<li>In browser-based calls, use <code>%7C</code>.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="skip_acct_types" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">skip_acct_types</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">skip_acct_types=main|anonymous</span></div><div><div html="&lt;p&gt;A list of the FTP account types to exclude from the function&amp;#39;s
results.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;anonymous&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;logaccess&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;main&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;sub&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;If you do not specify this parameter, this function does &lt;strong&gt;not&lt;/strong&gt; exclude
any account types.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;Separate multiple types with the pipe character (&lt;code&gt;|&lt;/code&gt;).&lt;/li&gt;
&lt;li&gt;In browser-based calls, use &lt;code&gt;%7C&lt;/code&gt;.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A list of the FTP account types to exclude from the function&#39;s
results.</p>
<ul>
<li><code>anonymous</code></li>
<li><code>logaccess</code></li>
<li><code>main</code></li>
<li><code>sub</code></li>
</ul>
<p>If you do not specify this parameter, this function does <strong>not</strong> exclude
any account types.</p>
<p><strong>Note:</strong></p>
<ul>
<li>Separate multiple types with the pipe character (<code>|</code>).</li>
<li>In browser-based calls, use <code>%7C</code>.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Ftp/list_ftp</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Ftp/list_ftp</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99l36q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99l36q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99l36q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99l36q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99l36q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99l36q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99l36q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99l36q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99l36q:0" aria-labelledby="tab:R99l36q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Ftp <span class="token punctuation">\</span>
  list_ftp
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99l36q:1" aria-labelledby="tab:R99l36q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99l36q:2" aria-labelledby="tab:R99l36q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99l36q:3" aria-labelledby="tab:R99l36q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pl36q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pl36q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pl36q:0" aria-labelledby="tab:R9pl36q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_ftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Ftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/home/user/public_html/ftp/&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;main&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">&quot;ftpaccount&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/FTP-Accounts/operation/set_welcome_message" data-section-id="tag/FTP-Accounts/operation/set_welcome_message" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_welcome_message" id="operation/set_welcome_message" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/FTP-Accounts/operation/set_welcome_message" aria-label="tag/FTP-Accounts/operation/set_welcome_message"></a>Update FTP welcome message </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function sets the FTP welcome message.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;FTP role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets the FTP welcome message.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">FTP role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="message" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">message</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">message=Greetings, Professor Falken.</span></div><div><div html="&lt;p&gt;The cPanel account&amp;#39;s new FTP welcome message.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPanel account&#39;s new FTP welcome message.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Ftp/set_welcome_message</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Ftp/set_welcome_message</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99n36q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99n36q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99n36q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99n36q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99n36q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99n36q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99n36q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99n36q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99n36q:0" aria-labelledby="tab:R99n36q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Ftp <span class="token punctuation">\</span>
  set_welcome_message <span class="token punctuation">\</span>
  <span class="token assign-left variable">message</span><span class="token operator">=</span><span class="token string">'Greetings, Professor Falken.'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99n36q:1" aria-labelledby="tab:R99n36q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99n36q:2" aria-labelledby="tab:R99n36q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99n36q:3" aria-labelledby="tab:R99n36q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pn36q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pn36q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pn36q:0" aria-labelledby="tab:R9pn36q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_welcome_message&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Ftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/FTP-Server-Settings" data-section-id="tag/FTP-Server-Settings" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/FTP-Server-Settings" aria-label="tag/FTP-Server-Settings"></a>FTP Server Settings</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Files / FTP Server Settings&lt;/p&gt;
"><p>Files / FTP Server Settings</p>
</div></div></div><div id="tag/FTP-Server-Settings/operation/allows_anonymous_ftp" data-section-id="tag/FTP-Server-Settings/operation/allows_anonymous_ftp" class="sc-dntaoT ceciOs"><div data-section-id="operation/allows_anonymous_ftp" id="operation/allows_anonymous_ftp" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/FTP-Server-Settings/operation/allows_anonymous_ftp" aria-label="tag/FTP-Server-Settings/operation/allows_anonymous_ftp"></a>Return if anonymous FTP connections allowed </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function checks whether the account allows anonymous FTP connections.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;FTP&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether the account allows anonymous FTP connections.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles"><em>FTP</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Ftp/allows_anonymous_ftp</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Ftp/allows_anonymous_ftp</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99356q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99356q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99356q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99356q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99356q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99356q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99356q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99356q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99356q:0" aria-labelledby="tab:R99356q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Ftp <span class="token punctuation">\</span>
  allows_anonymous_ftp
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99356q:1" aria-labelledby="tab:R99356q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99356q:2" aria-labelledby="tab:R99356q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99356q:3" aria-labelledby="tab:R99356q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p356q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p356q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p356q:0" aria-labelledby="tab:R9p356q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;allows_anonymous_ftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Ftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"allows"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/FTP-Server-Settings/operation/allows_anonymous_ftp_incoming" data-section-id="tag/FTP-Server-Settings/operation/allows_anonymous_ftp_incoming" class="sc-dntaoT ceciOs"><div data-section-id="operation/allows_anonymous_ftp_incoming" id="operation/allows_anonymous_ftp_incoming" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/FTP-Server-Settings/operation/allows_anonymous_ftp_incoming" aria-label="tag/FTP-Server-Settings/operation/allows_anonymous_ftp_incoming"></a>Return if anonymous FTP transfers allowed </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function checks whether the account allows inbound anonymous FTP transfers.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;&lt;em&gt;FTP&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether the account allows inbound anonymous FTP transfers.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles"><em>FTP</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Ftp/allows_anonymous_ftp_incoming</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Ftp/allows_anonymous_ftp_incoming</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99556q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99556q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99556q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99556q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99556q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99556q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99556q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99556q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99556q:0" aria-labelledby="tab:R99556q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Ftp <span class="token punctuation">\</span>
  allows_anonymous_ftp_incoming
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99556q:1" aria-labelledby="tab:R99556q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99556q:2" aria-labelledby="tab:R99556q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99556q:3" aria-labelledby="tab:R99556q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p556q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p556q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p556q:0" aria-labelledby="tab:R9p556q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;allows_anonymous_ftp_incoming&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Ftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"allows"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/FTP-Server-Settings/operation/get_ftp_daemon_info" data-section-id="tag/FTP-Server-Settings/operation/get_ftp_daemon_info" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_ftp_daemon_info" id="operation/get_ftp_daemon_info" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/FTP-Server-Settings/operation/get_ftp_daemon_info" aria-label="tag/FTP-Server-Settings/operation/get_ftp_daemon_info"></a>Return FTP server&#x27;s information </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves the extended information about the server&amp;#39;s FTP daemon.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the extended information about the server&#39;s FTP daemon.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Ftp/get_ftp_daemon_info</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Ftp/get_ftp_daemon_info</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99756q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99756q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99756q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99756q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99756q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99756q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99756q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99756q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99756q:0" aria-labelledby="tab:R99756q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Ftp <span class="token punctuation">\</span>
  get_ftp_daemon_info
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99756q:1" aria-labelledby="tab:R99756q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99756q:2" aria-labelledby="tab:R99756q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99756q:3" aria-labelledby="tab:R99756q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p756q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p756q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p756q:0" aria-labelledby="tab:R9p756q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_ftp_daemon_info&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Ftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;pure-ftpd&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"supports"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"login_without_domain"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"quota"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/FTP-Server-Settings/operation/get_port" data-section-id="tag/FTP-Server-Settings/operation/get_port" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_port" id="operation/get_port" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/FTP-Server-Settings/operation/get_port" aria-label="tag/FTP-Server-Settings/operation/get_port"></a>Return FTP server&#x27;s port </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the FTP port.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;FTP&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the FTP port.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>FTP</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Ftp/get_port</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Ftp/get_port</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99956q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99956q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99956q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99956q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99956q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99956q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99956q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99956q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99956q:0" aria-labelledby="tab:R99956q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Ftp <span class="token punctuation">\</span>
  get_port
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99956q:1" aria-labelledby="tab:R99956q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99956q:2" aria-labelledby="tab:R99956q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99956q:3" aria-labelledby="tab:R99956q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p956q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p956q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p956q:0" aria-labelledby="tab:R9p956q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_port&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Ftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"port"</span>: <span class="token number">21</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/FTP-Server-Settings/operation/kill_session" data-section-id="tag/FTP-Server-Settings/operation/kill_session" class="sc-dntaoT ceciOs"><div data-section-id="operation/kill_session" id="operation/kill_session" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/FTP-Server-Settings/operation/kill_session" aria-label="tag/FTP-Server-Settings/operation/kill_session"></a>Stop FTP session </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function kills FTP sessions.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;FTP&lt;/em&gt; Role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function kills FTP sessions.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>FTP</em> Role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="login" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">login</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;all&quot;</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">login=weeones</span></div><div><div html="&lt;p&gt;The username for the session&amp;#39;s FTP account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  To stop all FTP sessions for the cPanel account, set this parameter to the &lt;code&gt;all&lt;/code&gt; value.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The username for the session&#39;s FTP account.</p>
<p><strong>Note:</strong></p>
<p>  To stop all FTP sessions for the cPanel account, set this parameter to the <code>all</code> value.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Ftp/kill_session</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Ftp/kill_session</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99b56q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99b56q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99b56q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b56q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99b56q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b56q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99b56q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b56q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99b56q:0" aria-labelledby="tab:R99b56q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Ftp <span class="token punctuation">\</span>
  kill_session
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b56q:1" aria-labelledby="tab:R99b56q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b56q:2" aria-labelledby="tab:R99b56q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b56q:3" aria-labelledby="tab:R99b56q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pb56q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pb56q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pb56q:0" aria-labelledby="tab:R9pb56q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;kill_session&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Ftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/FTP-Server-Settings/operation/list_sessions" data-section-id="tag/FTP-Server-Settings/operation/list_sessions" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_sessions" id="operation/list_sessions" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/FTP-Server-Settings/operation/list_sessions" aria-label="tag/FTP-Server-Settings/operation/list_sessions"></a>Return FTP server&#x27;s active sessions </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the FTP server&amp;#39;s active sessions.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;FTP role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the FTP server&#39;s active sessions.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">FTP role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Ftp/list_sessions</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Ftp/list_sessions</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99d56q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99d56q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99d56q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d56q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99d56q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d56q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99d56q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d56q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99d56q:0" aria-labelledby="tab:R99d56q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Ftp <span class="token punctuation">\</span>
  list_sessions
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99d56q:1" aria-labelledby="tab:R99d56q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99d56q:2" aria-labelledby="tab:R99d56q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99d56q:3" aria-labelledby="tab:R99d56q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pd56q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pd56q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pd56q:0" aria-labelledby="tab:R9pd56q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_sessions&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Ftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"cmdline"</span>: <span class="token string">&quot;pure-ftpd (IDLE)&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file"</span>: <span class="token string">&quot;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"host"</span>: <span class="token string">&quot;localhost&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"login"</span>: <span class="token string">&quot;Tue Apr 23 16:23:23 2020&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pid"</span>: <span class="token number">6735</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">&quot;IDLE&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">&quot;ftpaccount&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/FTP-Server-Settings/operation/set_anonymous_ftp" data-section-id="tag/FTP-Server-Settings/operation/set_anonymous_ftp" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_anonymous_ftp" id="operation/set_anonymous_ftp" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/FTP-Server-Settings/operation/set_anonymous_ftp" aria-label="tag/FTP-Server-Settings/operation/set_anonymous_ftp"></a>Enable or disable anonymous FTP logins </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function enables or disables anonymous FTP logins.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;FTP role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables or disables anonymous FTP logins.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">FTP role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="set" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">set</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">set=0</span></div><div><div html="&lt;p&gt;Whether to enable or disable anonymous FTP logins.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Enable.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Disable.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to enable or disable anonymous FTP logins.</p>
<ul>
<li><code>1</code> - Enable.</li>
<li><code>0</code> - Disable.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Ftp/set_anonymous_ftp</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Ftp/set_anonymous_ftp</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99f56q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99f56q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99f56q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f56q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99f56q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f56q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99f56q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f56q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99f56q:0" aria-labelledby="tab:R99f56q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Ftp <span class="token punctuation">\</span>
  set_anonymous_ftp
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99f56q:1" aria-labelledby="tab:R99f56q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99f56q:2" aria-labelledby="tab:R99f56q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99f56q:3" aria-labelledby="tab:R99f56q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pf56q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pf56q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pf56q:0" aria-labelledby="tab:R9pf56q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_anonymous_ftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Ftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/FTP-Server-Settings/operation/server_name" data-section-id="tag/FTP-Server-Settings/operation/server_name" class="sc-dntaoT ceciOs"><div data-section-id="operation/server_name" id="operation/server_name" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/FTP-Server-Settings/operation/server_name" aria-label="tag/FTP-Server-Settings/operation/server_name"></a>Return whether server uses ProFTPD or Pure-FTPd </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function checks whether the server uses ProFTPD or Pure-FTPd.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;FTP role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether the server uses ProFTPD or Pure-FTPd.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">FTP role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Ftp/server_name</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Ftp/server_name</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99h56q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99h56q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99h56q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h56q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99h56q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h56q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99h56q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h56q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99h56q:0" aria-labelledby="tab:R99h56q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Ftp <span class="token punctuation">\</span>
  server_name
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h56q:1" aria-labelledby="tab:R99h56q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h56q:2" aria-labelledby="tab:R99h56q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h56q:3" aria-labelledby="tab:R99h56q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9ph56q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9ph56q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9ph56q:0" aria-labelledby="tab:R9ph56q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;server_name&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Ftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token string">&quot;pure-ftpd&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/FTP-Server-Settings/operation/set_anonymous_ftp_incoming" data-section-id="tag/FTP-Server-Settings/operation/set_anonymous_ftp_incoming" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_anonymous_ftp_incoming" id="operation/set_anonymous_ftp_incoming" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/FTP-Server-Settings/operation/set_anonymous_ftp_incoming" aria-label="tag/FTP-Server-Settings/operation/set_anonymous_ftp_incoming"></a>Enable or disable anonymous incoming FTP transfers </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function enables or disables inbound anonymous FTP transfers.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;FTP role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables or disables inbound anonymous FTP transfers.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">FTP role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="set" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">set</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">set=0</span></div><div><div html="&lt;p&gt;Whether to enable or disable inbound anonymous FTP transfers.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Enable.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Disable.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to enable or disable inbound anonymous FTP transfers.</p>
<ul>
<li><code>1</code> - Enable.</li>
<li><code>0</code> - Disable.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Ftp/set_anonymous_ftp_incoming</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Ftp/set_anonymous_ftp_incoming</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99j56q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99j56q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99j56q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99j56q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99j56q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99j56q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99j56q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99j56q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99j56q:0" aria-labelledby="tab:R99j56q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Ftp <span class="token punctuation">\</span>
  set_anonymous_ftp_incoming
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99j56q:1" aria-labelledby="tab:R99j56q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99j56q:2" aria-labelledby="tab:R99j56q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99j56q:3" aria-labelledby="tab:R99j56q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pj56q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pj56q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pj56q:0" aria-labelledby="tab:R9pj56q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_anonymous_ftp_incoming&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Ftp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Image-Tools" data-section-id="tag/Image-Tools" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Image-Tools" aria-label="tag/Image-Tools"></a>Image Tools</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Files / Image Tools&lt;/p&gt;
"><p>Files / Image Tools</p>
</div></div></div><div id="tag/Image-Tools/operation/convert_file" data-section-id="tag/Image-Tools/operation/convert_file" class="sc-dntaoT ceciOs"><div data-section-id="operation/convert_file" id="operation/convert_file" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Image-Tools/operation/convert_file" aria-label="tag/Image-Tools/operation/convert_file"></a>Create image with new format </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function converts an image to a new file format.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles&quot;&gt;WebServer role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function converts an image to a new file format.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles">WebServer role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="image_file" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">image_file</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">image_file=images/myimage.jpg</span></div><div><div html="&lt;p&gt;The image file to convert, relative to the cPanel account&amp;#39;s &lt;code&gt;/home&lt;/code&gt; directory.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The image file to convert, relative to the cPanel account&#39;s <code>/home</code> directory.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="type" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">type</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">type=png</span></div><div><div html="&lt;p&gt;The format to which to convert the images.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The format to which to convert the images.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/ImageManager/convert_file</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/ImageManager/convert_file</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kj76q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kj76q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kj76q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj76q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kj76q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj76q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kj76q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj76q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kj76q:0" aria-labelledby="tab:R4kj76q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  ImageManager <span class="token punctuation">\</span>
  convert_file <span class="token punctuation">\</span>
  <span class="token assign-left variable">image_file</span><span class="token operator">=</span><span class="token string">'images/myimage.jpg'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">type</span><span class="token operator">=</span><span class="token string">'png'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj76q:1" aria-labelledby="tab:R4kj76q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj76q:2" aria-labelledby="tab:R4kj76q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj76q:3" aria-labelledby="tab:R4kj76q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sj76q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sj76q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sj76q:0" aria-labelledby="tab:R4sj76q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;convert_file&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;ImageManager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"converted_file"</span>: <span class="token string">&quot;/home/cptest1/images/myimage.png&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Image-Tools/operation/create_thumbnails" data-section-id="tag/Image-Tools/operation/create_thumbnails" class="sc-dntaoT ceciOs"><div data-section-id="operation/create_thumbnails" id="operation/create_thumbnails" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Image-Tools/operation/create_thumbnails" aria-label="tag/Image-Tools/operation/create_thumbnails"></a>Create image thumbnails </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function creates thumbnails from images. The function saves the new thumbnail images in a thumbnails subdirectory inside the original directory. The system prepends thumbnail filenames with &lt;code&gt;tn_&lt;/code&gt; (for example, &lt;code&gt;tn_picture.jpg&lt;/code&gt;).&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;WebServer role&lt;/a&gt;, the system disables this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates thumbnails from images. The function saves the new thumbnail images in a thumbnails subdirectory inside the original directory. The system prepends thumbnail filenames with <code>tn_</code> (for example, <code>tn_picture.jpg</code>).</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">WebServer role</a>, the system disables this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="dir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">dir</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">dir=images</span></div><div><div html="&lt;p&gt;The path to the directory where the image resides. When you pass this parameter, the function creates a thumbnail directory directly below the image directory.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;NOTE:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This parameter can use an absolute directory path or a path relative to the user&amp;#39;s home directory.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The path to the directory where the image resides. When you pass this parameter, the function creates a thumbnail directory directly below the image directory.</p>
<p><strong>NOTE:</strong></p>
<p>This parameter can use an absolute directory path or a path relative to the user&#39;s home directory.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="height_percentage" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">height_percentage</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> [ 1 .. 99 ] </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">height_percentage=25</span></div><div><div html="&lt;p&gt;The percentage by which to reduce the thumbnails&amp;#39; height.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The percentage by which to reduce the thumbnails&#39; height.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="width_percentage" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">width_percentage</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> [ 1 .. 99 ] </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">width_percentage=25</span></div><div><div html="&lt;p&gt;The percentage by which to reduce the thumbnails&amp;#39; width.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The percentage by which to reduce the thumbnails&#39; width.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/ImageManager/create_thumbnails</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/ImageManager/create_thumbnails</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kl76q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kl76q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kl76q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl76q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kl76q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl76q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kl76q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl76q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kl76q:0" aria-labelledby="tab:R4kl76q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  ImageManager <span class="token punctuation">\</span>
  create_thumbnails <span class="token punctuation">\</span>
  <span class="token assign-left variable">dir</span><span class="token operator">=</span><span class="token string">'images'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">width_percentage</span><span class="token operator">=</span><span class="token string">'25'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">height_percentage</span><span class="token operator">=</span><span class="token string">'25'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl76q:1" aria-labelledby="tab:R4kl76q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl76q:2" aria-labelledby="tab:R4kl76q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl76q:3" aria-labelledby="tab:R4kl76q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sl76q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sl76q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sl76q:0" aria-labelledby="tab:R4sl76q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;create_thumbnails&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;ImageManager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"failed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file"</span>: <span class="token string">&quot;/home/cptest1/public_html/images/610_290.jpg&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">&quot;too many pixels&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"thumbnail_file"</span>: <span class="token string">&quot;/home/cptest1/public_html/images/thumbnails/tn_610_290.jpg&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Image-Tools/operation/get_dimensions" data-section-id="tag/Image-Tools/operation/get_dimensions" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_dimensions" id="operation/get_dimensions" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Image-Tools/operation/get_dimensions" aria-label="tag/Image-Tools/operation/get_dimensions"></a>Return image dimensions </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the dimensions of the image file that you specify.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles&quot;&gt;WebServer role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the dimensions of the image file that you specify.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles">WebServer role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="image_file" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">image_file</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">image_file=image/myimage.jpg</span></div><div><div html="&lt;p&gt;The path to the file to measure.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;Use the absolute filepath or a path relative to the user&amp;#39;s home directory.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The path to the file to measure.</p>
<p><strong>Note:</strong></p>
<p>Use the absolute filepath or a path relative to the user&#39;s home directory.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/ImageManager/get_dimensions</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/ImageManager/get_dimensions</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kn76q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kn76q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kn76q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn76q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kn76q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn76q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kn76q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn76q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kn76q:0" aria-labelledby="tab:R4kn76q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  ImageManager <span class="token punctuation">\</span>
  get_dimensions <span class="token punctuation">\</span>
  <span class="token assign-left variable">image_file</span><span class="token operator">=</span><span class="token string">'image/myimage.jpg'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn76q:1" aria-labelledby="tab:R4kn76q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn76q:2" aria-labelledby="tab:R4kn76q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn76q:3" aria-labelledby="tab:R4kn76q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sn76q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sn76q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sn76q:0" aria-labelledby="tab:R4sn76q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_dimensions&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;ImageManager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"height"</span>: <span class="token number">300</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"width"</span>: <span class="token number">261</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Image-Tools/operation/resize_image" data-section-id="tag/Image-Tools/operation/resize_image" class="sc-dntaoT ceciOs"><div data-section-id="operation/resize_image" id="operation/resize_image" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Image-Tools/operation/resize_image" aria-label="tag/Image-Tools/operation/resize_image"></a>Save resized image </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function resizes a specified image.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles&quot;&gt;WebServer role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function resizes a specified image.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles">WebServer role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="height" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">height</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= 1 </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">height=300</span></div><div><div html="&lt;p&gt;The height to which to set the image size.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The height to which to set the image size.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="image_file" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">image_file</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">image_file=/images/image.jpg</span></div><div><div html="&lt;p&gt;The name of the file to scale.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;Use the absolute filepath or a filepath relative to the user&amp;#39;s home directory.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the file to scale.</p>
<p><strong>Note:</strong></p>
<p>Use the absolute filepath or a filepath relative to the user&#39;s home directory.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="save_original_as" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">save_original_as</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">save_original_as=images/original.jpg</span></div><div><div html="&lt;p&gt;The path to the directory in which to save a copy the original
image file.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;If you don&amp;#39;t pass this parameter, the function doesn&amp;#39;t save
a copy of the original image.&lt;/li&gt;
&lt;li&gt;Use the absolute filepath or a filepath relative to the user&amp;#39;s home directory.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The path to the directory in which to save a copy the original
image file.</p>
<p><strong>Note:</strong></p>
<ul>
<li>If you don&#39;t pass this parameter, the function doesn&#39;t save
a copy of the original image.</li>
<li>Use the absolute filepath or a filepath relative to the user&#39;s home directory.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="width" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">width</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= 1 </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">width=200</span></div><div><div html="&lt;p&gt;The width to which to set the image size.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The width to which to set the image size.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/ImageManager/resize_image</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/ImageManager/resize_image</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kp76q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kp76q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kp76q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp76q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kp76q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp76q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kp76q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp76q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kp76q:0" aria-labelledby="tab:R4kp76q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  ImageManager <span class="token punctuation">\</span>
  resize_image <span class="token punctuation">\</span>
  <span class="token assign-left variable">image_file</span><span class="token operator">=</span><span class="token string">'images/image.jpg'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">width</span><span class="token operator">=</span><span class="token string">'200'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">height</span><span class="token operator">=</span><span class="token string">'300'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp76q:1" aria-labelledby="tab:R4kp76q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp76q:2" aria-labelledby="tab:R4kp76q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp76q:3" aria-labelledby="tab:R4kp76q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sp76q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sp76q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sp76q:0" aria-labelledby="tab:R4sp76q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;resize_image&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;ImageManager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token string">&quot;/home/cptest1/images/myimage.jpg&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Manage-Files" data-section-id="tag/Manage-Files" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Manage-Files" aria-label="tag/Manage-Files"></a>Manage Files</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Files / Manage Files&lt;/p&gt;
"><p>Files / Manage Files</p>
</div></div></div><div id="tag/Manage-Files/operation/autocompletedir" data-section-id="tag/Manage-Files/operation/autocompletedir" class="sc-dntaoT ceciOs"><div data-section-id="operation/autocompletedir" id="operation/autocompletedir" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Manage-Files/operation/autocompletedir" aria-label="tag/Manage-Files/operation/autocompletedir"></a>Return autocomplete file and directory names </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns any files and directories that begin with a specified string.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;File Storage role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns any files and directories that begin with a specified string.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles">File Storage role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="dirsonly" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">dirsonly</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> </div> <div><div html="&lt;p&gt;Whether to include only directories in the output.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — &lt;strong&gt;Only&lt;/strong&gt; include directories.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Include directories &lt;strong&gt;and&lt;/strong&gt; files.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to include only directories in the output.</p>
<ul>
<li><code>1</code> — <strong>Only</strong> include directories.</li>
<li><code>0</code> — Include directories <strong>and</strong> files.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="html" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">html</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">html=1</span></div><div><div html="&lt;p&gt;Whether to return HTML-encoded results.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Return HTML-encoded output.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Return plaintext output.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to return HTML-encoded results.</p>
<ul>
<li><code>1</code> — Return HTML-encoded output.</li>
<li><code>0</code> — Return plaintext output.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="list_all" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">list_all</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> </div> <div><div html="&lt;p&gt;Whether to return all files and directories inside the specified
directory. If you set this parameter&amp;#39;s value to &lt;code&gt;1&lt;/code&gt;, you &lt;strong&gt;must&lt;/strong&gt; set the &lt;code&gt;path&lt;/code&gt;
parameter&amp;#39;s value to a full directory path.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Return &lt;strong&gt;all&lt;/strong&gt; files and directories inside the specified directory.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Return partial file and directory name matches.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to return all files and directories inside the specified
directory. If you set this parameter&#39;s value to <code>1</code>, you <strong>must</strong> set the <code>path</code>
parameter&#39;s value to a full directory path.</p>
<ul>
<li><code>1</code> — Return <strong>all</strong> files and directories inside the specified directory.</li>
<li><code>0</code> — Return partial file and directory name matches.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="path" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">path</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">path=public</span></div><div><div html="&lt;p&gt;The prefix of the paths to complete.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The prefix of the paths to complete.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Fileman/autocompletedir</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Fileman/autocompletedir</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99396q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99396q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99396q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99396q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99396q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99396q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99396q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99396q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99396q:0" aria-labelledby="tab:R99396q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Fileman <span class="token punctuation">\</span>
  autocompletedir <span class="token punctuation">\</span>
  <span class="token assign-left variable">path</span><span class="token operator">=</span><span class="token string">'public'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99396q:1" aria-labelledby="tab:R99396q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99396q:2" aria-labelledby="tab:R99396q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99396q:3" aria-labelledby="tab:R99396q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p396q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p396q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p396q:0" aria-labelledby="tab:R9p396q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;autocompletedir&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Fileman&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"file"</span>: <span class="token string">&quot;public_ftp&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Manage-Files/operation/empty_trash" data-section-id="tag/Manage-Files/operation/empty_trash" class="sc-dntaoT ceciOs"><div data-section-id="operation/empty_trash" id="operation/empty_trash" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Manage-Files/operation/empty_trash" aria-label="tag/Manage-Files/operation/empty_trash"></a>Delete .trash folder content </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function purges content from the &lt;code&gt;.trash&lt;/code&gt; folder in the user&amp;#39;s home directory.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles&quot;&gt;FileStorage role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function purges content from the <code>.trash</code> folder in the user&#39;s home directory.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles">FileStorage role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="older_than" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">older_than</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= 0 </span></span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">older_than=31</span></div><div><div html="&lt;p&gt;The maximum age in days of content that the function will not purge.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;A value of &lt;code&gt;0&lt;/code&gt; will purge everything from the user&amp;#39;s &lt;code&gt;.trash&lt;/code&gt; folder.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The maximum age in days of content that the function will not purge.</p>
<p><strong>Note:</strong></p>
<p>A value of <code>0</code> will purge everything from the user&#39;s <code>.trash</code> folder.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Fileman/empty_trash</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Fileman/empty_trash</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99596q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99596q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99596q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99596q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99596q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99596q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99596q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99596q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99596q:0" aria-labelledby="tab:R99596q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Fileman <span class="token punctuation">\</span>
  empty_trash
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99596q:1" aria-labelledby="tab:R99596q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99596q:2" aria-labelledby="tab:R99596q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99596q:3" aria-labelledby="tab:R99596q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p596q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p596q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p596q:0" aria-labelledby="tab:R9p596q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;empty_trash&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Fileman&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Manage-Files/operation/get_file_content" data-section-id="tag/Manage-Files/operation/get_file_content" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_file_content" id="operation/get_file_content" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Manage-Files/operation/get_file_content" aria-label="tag/Manage-Files/operation/get_file_content"></a>Return file content </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves a file&amp;#39;s content.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;File Storage&lt;/a&gt; role, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;JSON strings &lt;strong&gt;must&lt;/strong&gt; be valid UTF-8. To retrieve a non-UTF-8 file via
JSON, we recommend that you give &lt;code&gt;ISO-8859-1&lt;/code&gt; as &lt;code&gt;from_charset&lt;/code&gt; and
&lt;code&gt;UTF-8&lt;/code&gt; as &lt;code&gt;to_charset&lt;/code&gt;, then decode the return payload’s &lt;code&gt;content&lt;/code&gt;
as UTF-8.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a file&#39;s content.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">File Storage</a> role, the system <strong>disables</strong> this function.</p>
<p><strong>Note:</strong></p>
<p>JSON strings <strong>must</strong> be valid UTF-8. To retrieve a non-UTF-8 file via
JSON, we recommend that you give <code>ISO-8859-1</code> as <code>from_charset</code> and
<code>UTF-8</code> as <code>to_charset</code>, then decode the return payload’s <code>content</code>
as UTF-8.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="dir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">dir</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">dir=/home/user/public.html</span></div><div><div html="&lt;p&gt;The file path to the directory that contains the selected file.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The file path to the directory that contains the selected file.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="file" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">file</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">file=example.html</span></div><div><div html="&lt;p&gt;The file to retrieve.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The file to retrieve.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="from_charset" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">from_charset</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;_DETECT_&quot;</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">from_charset=_DETECT_</span></div><div><div html="&lt;p&gt;The file’s character encoding. This parameter defaults to &lt;code&gt;_DETECT_&lt;/code&gt;, which indicates a request to detect the file’s character encoding.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The file’s character encoding. This parameter defaults to <code>_DETECT_</code>, which indicates a request to detect the file’s character encoding.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="to_charset" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">to_charset</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;_LOCALE_&quot;</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">to_charset=_LOCALE_</span></div><div><div html="&lt;p&gt;The output character encoding. This parameter defaults to &lt;code&gt;_LOCALE_&lt;/code&gt;, which indicates a request to use the session locale’s character encoding.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;Contexts that serialize the API response as JSON &lt;strong&gt;require&lt;/strong&gt;
this value to be &lt;code&gt;utf-8&lt;/code&gt; or &lt;code&gt;US-ASCII&lt;/code&gt;. Behavior is &lt;strong&gt;undefined&lt;/strong&gt;
if the request indicates any other encoding.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The output character encoding. This parameter defaults to <code>_LOCALE_</code>, which indicates a request to use the session locale’s character encoding.</p>
<p><strong>Important:</strong></p>
<p>Contexts that serialize the API response as JSON <strong>require</strong>
this value to be <code>utf-8</code> or <code>US-ASCII</code>. Behavior is <strong>undefined</strong>
if the request indicates any other encoding.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="update_html_document_encoding" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">update_html_document_encoding</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">update_html_document_encoding=1</span></div><div><div html="&lt;p&gt;Whether to update the file&amp;#39;s HTML document encoding.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Update the file&amp;#39;s HTML document encoding.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Don&amp;#39;t update the file&amp;#39;s HTML encoding.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to update the file&#39;s HTML document encoding.</p>
<ul>
<li><code>1</code> — Update the file&#39;s HTML document encoding.</li>
<li><code>0</code> — Don&#39;t update the file&#39;s HTML encoding.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Fileman/get_file_content</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Fileman/get_file_content</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99796q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99796q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99796q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99796q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99796q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99796q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99796q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99796q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99796q:0" aria-labelledby="tab:R99796q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Fileman <span class="token punctuation">\</span>
  get_file_content <span class="token punctuation">\</span>
  <span class="token assign-left variable">dir</span><span class="token operator">=</span><span class="token string">'/home/user/public_html'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">file</span><span class="token operator">=</span><span class="token string">'example.html'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99796q:1" aria-labelledby="tab:R99796q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99796q:2" aria-labelledby="tab:R99796q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99796q:3" aria-labelledby="tab:R99796q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p796q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p796q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p796q:0" aria-labelledby="tab:R9p796q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_file_content&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Fileman&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"content"</span>: <span class="token string">&quot;`hi`&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dir"</span>: <span class="token string">&quot;/home/user/public_html&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"filename"</span>: <span class="token string">&quot;example.html&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"from_char"</span>: <span class="token string">&quot;UTF-8&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"from_charset"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/home/user/public_html/example.html&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"to_char"</span>: <span class="token string">&quot;UTF-8&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"to_charset"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Manage-Files/operation/get_file_information" data-section-id="tag/Manage-Files/operation/get_file_information" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_file_information" id="operation/get_file_information" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Manage-Files/operation/get_file_information" aria-label="tag/Manage-Files/operation/get_file_information"></a>Return file or directory information </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the information for a specified file or directory.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;File Storage&lt;/a&gt; role, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the information for a specified file or directory.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">File Storage</a> role, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="check_for_leaf_directories" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">check_for_leaf_directories</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">check_for_leaf_directories=1</span></div><div><div html="&lt;p&gt;Whether to flag directories that contain subdirectories.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Flag directories that contain subdirectories.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Do &lt;strong&gt;not&lt;/strong&gt; flag directories that contain subdirectories.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to flag directories that contain subdirectories.</p>
<ul>
<li><code>1</code> - Flag directories that contain subdirectories.</li>
<li><code>0</code> - Do <strong>not</strong> flag directories that contain subdirectories.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="include_mime" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">include_mime</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">include_mime=1</span></div><div><div html="&lt;p&gt;Whether to return the file&amp;#39;s MIME type.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Return the file&amp;#39;s MIME type.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Do &lt;strong&gt;not&lt;/strong&gt; return the file&amp;#39;s MIME type.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to return the file&#39;s MIME type.</p>
<ul>
<li><code>1</code> - Return the file&#39;s MIME type.</li>
<li><code>0</code> - Do <strong>not</strong> return the file&#39;s MIME type.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="include_permissions" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">include_permissions</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">include_permissions=1</span></div><div><div html="&lt;p&gt;Whether to parse the file owner&amp;#39;s read and write permissions.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Parse the file owner&amp;#39;s read and write permissions.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Do &lt;strong&gt;not&lt;/strong&gt; parse the file owner&amp;#39;s read and write permissions.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to parse the file owner&#39;s read and write permissions.</p>
<ul>
<li><code>1</code> - Parse the file owner&#39;s read and write permissions.</li>
<li><code>0</code> - Do <strong>not</strong> parse the file owner&#39;s read and write permissions.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="path" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">path</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">path=public_html</span></div><div><div html="&lt;p&gt;The directory from which to list files.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The directory from which to list files.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="show_hidden" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">show_hidden</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">show_hidden=1</span></div><div><div html="&lt;p&gt;Whether to include hidden files in the output.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Include hidden files.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Do &lt;strong&gt;not&lt;/strong&gt; include hidden files.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to include hidden files in the output.</p>
<ul>
<li><code>1</code> - Include hidden files.</li>
<li><code>0</code> - Do <strong>not</strong> include hidden files.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Fileman/get_file_information</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Fileman/get_file_information</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99996q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99996q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99996q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99996q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99996q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99996q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99996q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99996q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99996q:0" aria-labelledby="tab:R99996q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Fileman <span class="token punctuation">\</span>
  get_file_information <span class="token punctuation">\</span>
  <span class="token assign-left variable">path</span><span class="token operator">=</span><span class="token string">'public_html'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99996q:1" aria-labelledby="tab:R99996q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99996q:2" aria-labelledby="tab:R99996q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99996q:3" aria-labelledby="tab:R99996q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p996q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p996q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p996q:0" aria-labelledby="tab:R9p996q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_file_information&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Fileman&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"absdir"</span>: <span class="token string">&quot;/home/user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ctime"</span>: <span class="token number">1400573272</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"exists"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file"</span>: <span class="token string">&quot;cgi-bin&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"fullpath"</span>: <span class="token string">&quot;/home/user/public_html/cgi-bin&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"gid"</span>: <span class="token number">503</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"humansize"</span>: <span class="token string">&quot;5 KB&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"isleaf"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mimename"</span>: <span class="token string">&quot;publichtml&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mimetype"</span>: <span class="token string">&quot;text/plain&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mode"</span>: <span class="token string">&quot;16872&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mtime"</span>: <span class="token number">1400573272</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nicemode"</span>: <span class="token number">755</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/home/user/public.html&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rawmimename"</span>: <span class="token string">&quot;text/plain&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rawmimetype"</span>: <span class="token string">&quot;text/plain&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"read"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">4096</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;file&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"uid"</span>: <span class="token number">502</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"write"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Manage-Files/operation/transcode" data-section-id="tag/Manage-Files/operation/transcode" class="sc-dntaoT ceciOs"><div data-section-id="operation/transcode" id="operation/transcode" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Manage-Files/operation/transcode" aria-label="tag/Manage-Files/operation/transcode"></a>Update buffer encoding </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function converts a buffer from one encoding language to another.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;File Storage role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function converts a buffer from one encoding language to another.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">File Storage role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="content" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">content</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">content=hi</span></div><div><div html="&lt;p&gt;The file&amp;#39;s contents.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The file&#39;s contents.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="discard_illegal" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">discard_illegal</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">discard_illegal=1</span></div><div><div html="&lt;p&gt;Whether to discard any characters that do not transcode correctly.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Discard invalid characters.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Transcode invalid characters in the default &lt;a href=&quot;https://en.wikipedia.org/wiki/Character_encoding&quot;&gt;character set encoding&lt;/a&gt;.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to discard any characters that do not transcode correctly.</p>
<ul>
<li><code>1</code> - Discard invalid characters.</li>
<li><code>0</code> - Transcode invalid characters in the default <a href="https://en.wikipedia.org/wiki/Character_encoding">character set encoding</a>.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="from_charset" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">from_charset</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">from_charset=UTF-8</span></div><div><div html="&lt;p&gt;The file&amp;#39;s current &lt;a href=&quot;https://en.wikipedia.org/wiki/Character_encoding&quot;&gt;character set encoding&lt;/a&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The file&#39;s current <a href="https://en.wikipedia.org/wiki/Character_encoding">character set encoding</a>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="to_charset" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">to_charset</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">to_charset=ASCII</span></div><div><div html="&lt;p&gt;The &lt;a href=&quot;https://en.wikipedia.org/wiki/Character_encoding&quot;&gt;character set encoding&lt;/a&gt; in which to encode the file.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The <a href="https://en.wikipedia.org/wiki/Character_encoding">character set encoding</a> in which to encode the file.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="transliterate" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">transliterate</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">transliterate=0</span></div><div><div html="&lt;p&gt;Whether to transcode invalid characters to valid characters in the new character set encoding.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Transcode invalid characters in the new &lt;a href=&quot;https://en.wikipedia.org/wiki/Character_encoding&quot;&gt;character set encoding&lt;/a&gt;.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Return an error message.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to transcode invalid characters to valid characters in the new character set encoding.</p>
<ul>
<li><code>1</code> - Transcode invalid characters in the new <a href="https://en.wikipedia.org/wiki/Character_encoding">character set encoding</a>.</li>
<li><code>0</code> - Return an error message.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Fileman/transcode</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Fileman/transcode</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99b96q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99b96q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99b96q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b96q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99b96q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b96q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99b96q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b96q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99b96q:0" aria-labelledby="tab:R99b96q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Fileman <span class="token punctuation">\</span>
  transcode <span class="token punctuation">\</span>
  <span class="token assign-left variable">content</span><span class="token operator">=</span><span class="token string">'hi'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b96q:1" aria-labelledby="tab:R99b96q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b96q:2" aria-labelledby="tab:R99b96q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b96q:3" aria-labelledby="tab:R99b96q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pb96q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pb96q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pb96q:0" aria-labelledby="tab:R9pb96q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;transcode&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Fileman&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"charset"</span>: <span class="token string">&quot;ASCII&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"content"</span>: <span class="token string">&quot;hi&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Manage-Files/operation/list_files" data-section-id="tag/Manage-Files/operation/list_files" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_files" id="operation/list_files" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Manage-Files/operation/list_files" aria-label="tag/Manage-Files/operation/list_files"></a>Return directory content </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns a sorted list of files and directories.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;FileStorage role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function. For more information, read our How to Use Server Profiles documentation.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns a sorted list of files and directories.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles">FileStorage role</a>, the system <strong>disables</strong> this function. For more information, read our How to Use Server Profiles documentation.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="check_for_leaf_directories" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">check_for_leaf_directories</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">check_for_leaf_directories=1</span></div><div><div html="&lt;p&gt;Whether to return directories that contain subdirectories.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Return subdirectories.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Do &lt;strong&gt;not&lt;/strong&gt; retain subdirectories.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to return directories that contain subdirectories.</p>
<ul>
<li><code>1</code> — Return subdirectories.</li>
<li><code>0</code> — Do <strong>not</strong> retain subdirectories.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="dir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">dir</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">dir=public_html</span></div><div><div html="&lt;p&gt;The directory from which to list files.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The directory from which to list files.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="include_mime" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">include_mime</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">include_mime=1</span></div><div><div html="&lt;p&gt;Whether to return the file&amp;#39;s MIME type.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Include MIME type.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Do &lt;strong&gt;not&lt;/strong&gt; include MIME type.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; If you set this value to &lt;code&gt;0&lt;/code&gt; but also include the &lt;code&gt;mime_types&lt;/code&gt; or &lt;code&gt;raw_mime_types&lt;/code&gt; parameters, the function &lt;strong&gt;overrides&lt;/strong&gt; your specified value and sets this parameter to &lt;code&gt;1&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to return the file&#39;s MIME type.</p>
<ul>
<li><code>1</code> — Include MIME type.</li>
<li><code>0</code> — Do <strong>not</strong> include MIME type.</li>
</ul>
<p><strong>Note:</strong></p>
<p> If you set this value to <code>0</code> but also include the <code>mime_types</code> or <code>raw_mime_types</code> parameters, the function <strong>overrides</strong> your specified value and sets this parameter to <code>1</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="include_permissions" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">include_permissions</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">include_permissions=0</span></div><div><div html="&lt;p&gt;Whether to parse the file owner&amp;#39;s read and write permissions.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Parse file permissions.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Do &lt;strong&gt;not&lt;/strong&gt; parse file permissions.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to parse the file owner&#39;s read and write permissions.</p>
<ul>
<li><code>1</code> — Parse file permissions.</li>
<li><code>0</code> — Do <strong>not</strong> parse file permissions.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="limit_to_list" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">limit_to_list</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">limit_to_list=0</span></div><div><div html="&lt;p&gt;Whether to return only entries that begin with the &lt;code&gt;filepath-&lt;/code&gt; prefix.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Return only files that begin with the &lt;code&gt;filepath-&lt;/code&gt; prefix.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Return &lt;strong&gt;all&lt;/strong&gt; files.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;If you do not use this parameter, the function returns all filenames.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to return only entries that begin with the <code>filepath-</code> prefix.</p>
<ul>
<li><code>1</code> — Return only files that begin with the <code>filepath-</code> prefix.</li>
<li><code>0</code> — Return <strong>all</strong> files.</li>
</ul>
<p>If you do not use this parameter, the function returns all filenames.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="mime_types" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">mime_types</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">mime_types=text-plain</span></div><div><div html="&lt;p&gt;The MIME types to return.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;If you use this parameter, the function returns the specified MIME types
and sets the &lt;code&gt;include_mime&lt;/code&gt; parameter&amp;#39;s value to &lt;code&gt;1&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;If you do &lt;strong&gt;not&lt;/strong&gt; use this parameter, the function returns all MIME types.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The MIME types to return.</p>
<ul>
<li>If you use this parameter, the function returns the specified MIME types
and sets the <code>include_mime</code> parameter&#39;s value to <code>1</code>.</li>
<li>If you do <strong>not</strong> use this parameter, the function returns all MIME types.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="only_these_files" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">only_these_files</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">only_these_files=cpbackup-exclude.conf</span></div><div><div html="&lt;p&gt;A comma-separated list of files to return.&lt;/p&gt;
&lt;p&gt;If you do not use this parameter, the function returns all files.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A comma-separated list of files to return.</p>
<p>If you do not use this parameter, the function returns all files.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="raw_mime_types" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">raw_mime_types</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">raw_mime_types=text/plain</span></div><div><div html="&lt;p&gt;The raw MIME types to return.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;If you use this parameter, the function returns the specified MIME types
and sets the &lt;code&gt;include_mime&lt;/code&gt; parameter&amp;#39;s value to &lt;code&gt;1&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;If you do &lt;strong&gt;not&lt;/strong&gt; use this parameter, the function returns all MIME types.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The raw MIME types to return.</p>
<ul>
<li>If you use this parameter, the function returns the specified MIME types
and sets the <code>include_mime</code> parameter&#39;s value to <code>1</code>.</li>
<li>If you do <strong>not</strong> use this parameter, the function returns all MIME types.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="show_hidden" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">show_hidden</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">show_hidden=1</span></div><div><div html="&lt;p&gt;Whether to include hidden files in the output.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Include hidden files.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Do &lt;strong&gt;not&lt;/strong&gt; include hidden files.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to include hidden files in the output.</p>
<ul>
<li><code>1</code> — Include hidden files.</li>
<li><code>0</code> — Do <strong>not</strong> include hidden files.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="types" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">types</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">strings</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">types=file|dir</span></div><div><div html="&lt;p&gt;A pipe-separated list of file types to return.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;file&lt;/code&gt; — A file.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;dir&lt;/code&gt; — A directory.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;char&lt;/code&gt; — A character special device.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;block&lt;/code&gt; — A block special device.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;fifo&lt;/code&gt; — A named pipe (FIFO).&lt;/li&gt;
&lt;li&gt;&lt;code&gt;link&lt;/code&gt; — A symbolic link.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;socket&lt;/code&gt; — A Unix domain socket.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;If you do not use this parameter, the function returns all file types.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A pipe-separated list of file types to return.</p>
<ul>
<li><code>file</code> — A file.</li>
<li><code>dir</code> — A directory.</li>
<li><code>char</code> — A character special device.</li>
<li><code>block</code> — A block special device.</li>
<li><code>fifo</code> — A named pipe (FIFO).</li>
<li><code>link</code> — A symbolic link.</li>
<li><code>socket</code> — A Unix domain socket.</li>
</ul>
<p>If you do not use this parameter, the function returns all file types.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Fileman/list_files</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Fileman/list_files</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99d96q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99d96q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99d96q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d96q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99d96q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d96q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99d96q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d96q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99d96q:0" aria-labelledby="tab:R99d96q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Fileman <span class="token punctuation">\</span>
  list_files <span class="token punctuation">\</span>
  <span class="token assign-left variable">dir</span><span class="token operator">=</span><span class="token string">'public_html'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99d96q:1" aria-labelledby="tab:R99d96q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99d96q:2" aria-labelledby="tab:R99d96q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99d96q:3" aria-labelledby="tab:R99d96q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pd96q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pd96q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pd96q:0" aria-labelledby="tab:R9pd96q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_files&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Fileman&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dirs"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"absdir"</span>: <span class="token string">&quot;/home/user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ctime"</span>: <span class="token number">1400573272</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"exists"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file"</span>: <span class="token string">&quot;cgi-bin&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"fullpath"</span>: <span class="token string">&quot;/home/user/public_html/cgi-bin&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"gid"</span>: <span class="token number">503</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"humansize"</span>: <span class="token string">&quot;5 KB&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"isleaf"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"isparent"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mimename"</span>: <span class="token string">&quot;text-plain&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mimetype"</span>: <span class="token string">&quot;text/plain&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mode"</span>: <span class="token string">&quot;16877&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mtime"</span>: <span class="token number">1400573272</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nicemode"</span>: <span class="token number">755</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/home/user/public.html&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rawmimename"</span>: <span class="token string">&quot;text-plain&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rawmimetype"</span>: <span class="token string">&quot;text/plain&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"read"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">4096</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;file&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"uid"</span>: <span class="token number">502</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"write"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"files"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"absdir"</span>: <span class="token string">&quot;/home/user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ctime"</span>: <span class="token number">1400573272</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"exists"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file"</span>: <span class="token string">&quot;cgi-bin&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"fullpath"</span>: <span class="token string">&quot;/home/user/public_html/cgi-bin&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"gid"</span>: <span class="token number">503</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"humansize"</span>: <span class="token string">&quot;5 KB&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"isleaf"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"isparent"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mimename"</span>: <span class="token string">&quot;text-plain&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mimetype"</span>: <span class="token string">&quot;text/plain&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mode"</span>: <span class="token string">&quot;16877&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mtime"</span>: <span class="token number">1400573272</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nicemode"</span>: <span class="token number">755</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/home/user/public.html&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rawmimename"</span>: <span class="token string">&quot;text-plain&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rawmimetype"</span>: <span class="token string">&quot;text/plain&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"read"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">4096</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;file&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"uid"</span>: <span class="token number">502</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"write"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Manage-Files/operation/save_file_content" data-section-id="tag/Manage-Files/operation/save_file_content" class="sc-dntaoT ceciOs"><div data-section-id="operation/save_file_content" id="operation/save_file_content" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Manage-Files/operation/save_file_content" aria-label="tag/Manage-Files/operation/save_file_content"></a>Save file </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function saves a file in a directory and encodes it in a character set.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;File Storage role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function saves a file in a directory and encodes it in a character set.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles">File Storage role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="content" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">content</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">content=hi</span></div><div><div html="&lt;p&gt;The new file&amp;#39;s contents. If you do &lt;strong&gt;not&lt;/strong&gt; use this parameter, the function creates a blank file.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new file&#39;s contents. If you do <strong>not</strong> use this parameter, the function creates a blank file.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="dir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">dir</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">dir=/home/username/public_html</span></div><div><div html="&lt;p&gt;The directory that contains the selected file.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This parameter defaults to the currently-authenticated user&amp;#39;s &lt;code&gt;/home&lt;/code&gt; directory.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The directory that contains the selected file.</p>
<p><strong>Note:</strong></p>
<p>This parameter defaults to the currently-authenticated user&#39;s <code>/home</code> directory.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="fallback" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">fallback</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">fallback=0</span></div><div><div html="&lt;p&gt;Whether the function will return an error or save in the default
character set if it cannot save in the specified character set.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Save in the default character set.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Return an error.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the function will return an error or save in the default
character set if it cannot save in the specified character set.</p>
<ul>
<li><code>1</code> — Save in the default character set.</li>
<li><code>0</code> — Return an error.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="file" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">file</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">file=example.html</span></div><div><div html="&lt;p&gt;The files to retrieve.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The files to retrieve.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="from_charset" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">from_charset</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;UTF-8&quot;</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">from_charset=UTF-8</span></div><div><div html="&lt;p&gt;The &lt;a href=&quot;https://en.wikipedia.org/wiki/Character_encoding&quot;&gt;character set encoding&lt;/a&gt; of the &lt;code&gt;content&lt;/code&gt; parameter&amp;#39;s value.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The <a href="https://en.wikipedia.org/wiki/Character_encoding">character set encoding</a> of the <code>content</code> parameter&#39;s value.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="to_charset" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">to_charset</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;UTF-8&quot;</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">to_charset=ASCII</span></div><div><div html="&lt;p&gt;The &lt;a href=&quot;https://en.wikipedia.org/wiki/Character_encoding&quot;&gt;character set encoding&lt;/a&gt; in which to encode the file.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The <a href="https://en.wikipedia.org/wiki/Character_encoding">character set encoding</a> in which to encode the file.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Fileman/save_file_content</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Fileman/save_file_content</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99f96q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99f96q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99f96q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f96q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99f96q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f96q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99f96q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f96q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99f96q:0" aria-labelledby="tab:R99f96q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Fileman <span class="token punctuation">\</span>
  save_file_content <span class="token punctuation">\</span>
  <span class="token assign-left variable">file</span><span class="token operator">=</span><span class="token string">'example.html'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99f96q:1" aria-labelledby="tab:R99f96q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99f96q:2" aria-labelledby="tab:R99f96q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99f96q:3" aria-labelledby="tab:R99f96q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pf96q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pf96q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pf96q:0" aria-labelledby="tab:R9pf96q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;save_file_content&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Fileman&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"from_charset"</span>: <span class="token string">&quot;UTF-8&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/home/user/public_html/example.html&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"to_charset"</span>: <span class="token string">&quot;ASCII&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Manage-Files/operation/upload_files" data-section-id="tag/Manage-Files/operation/upload_files" class="sc-dntaoT ceciOs"><div data-section-id="operation/upload_files" id="operation/upload_files" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Manage-Files/operation/upload_files" aria-label="tag/Manage-Files/operation/upload_files"></a>Upload files </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function uploads files.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  For more information about how to use this function in your custom code,
  read our &lt;a href=&quot;https://go.cpanel.net/tutorial-use-uapis-fileman-upload-files-function-in-custom-code&quot;&gt;Use UAPI&amp;#39;s &lt;code&gt;Fileman::upload_files&lt;/code&gt; 
  Function in Custom Code tutorial&lt;/a&gt;. &lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;File Storage&lt;/a&gt; role, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
&lt;p&gt;You cannot call this function through WHM API 1&amp;#39;s &lt;a href=&quot;https://go.cpanel.net/UseWHMAPItoCallcPanelAPIandUAPI&quot;&gt;uapi_cpanel&lt;/a&gt; function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function uploads files.</p>
<p><strong>Note:</strong></p>
<p>  For more information about how to use this function in your custom code,
  read our <a href="https://go.cpanel.net/tutorial-use-uapis-fileman-upload-files-function-in-custom-code">Use UAPI&#39;s <code>Fileman::upload_files</code> 
  Function in Custom Code tutorial</a>. </p>
<p><strong>Important:</strong></p>
<p> When you disable the <a href="https://go.cpanel.net/serverroles">File Storage</a> role, the system <strong>disables</strong> this function.</p>
<p>You cannot call this function through WHM API 1&#39;s <a href="https://go.cpanel.net/UseWHMAPItoCallcPanelAPIandUAPI">uapi_cpanel</a> function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Fileman/upload_files</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Fileman/upload_files</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99h96q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99h96q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99h96q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h96q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99h96q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h96q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99h96q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h96q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99h96q:0" aria-labelledby="tab:R99h96q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">To implement Fileman::upload_files, <span class="token builtin class-name">read</span> our Use UAPI's <span class="token variable"><span class="token variable">`</span>Fileman::upload_files<span class="token variable">`</span></span> Function <span class="token keyword">in</span> Custom Code tutorial.</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h96q:1" aria-labelledby="tab:R99h96q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h96q:2" aria-labelledby="tab:R99h96q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h96q:3" aria-labelledby="tab:R99h96q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9ph96q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9ph96q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9ph96q:0" aria-labelledby="tab:R9ph96q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;upload_files&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Fileman&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"content"</span>: <span class="token string">&quot;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"filename"</span>: <span class="token string">&quot;example.png&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/WebDisk-Settings" data-section-id="tag/WebDisk-Settings" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/WebDisk-Settings" aria-label="tag/WebDisk-Settings"></a>WebDisk Settings</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Files / WebDisk Settings&lt;/p&gt;
"><p>Files / WebDisk Settings</p>
</div></div></div><div id="tag/WebDisk-Settings/operation/WebDisk::delete_user" data-section-id="tag/WebDisk-Settings/operation/WebDisk::delete_user" class="sc-dntaoT ceciOs"><div data-section-id="operation/WebDisk::delete_user" id="operation/WebDisk::delete_user" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/WebDisk-Settings/operation/WebDisk::delete_user" aria-label="tag/WebDisk-Settings/operation/WebDisk::delete_user"></a>Delete Web Disk account </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function deletes a Web Disk account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Web Disk role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes a Web Disk account.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Web Disk role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="destroy" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">destroy</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">destroy=1</span></div><div><div html="&lt;p&gt;Whether to recursively delete the Web Disk account&amp;#39;s folder and all of its contents.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Delete the folder for the Web Disk account&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Do &lt;strong&gt;not&lt;/strong&gt; delete the folder for the Web Disk account.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to recursively delete the Web Disk account&#39;s folder and all of its contents.</p>
<ul>
<li><code>1</code> - Delete the folder for the Web Disk account</li>
<li><code>0</code> - Do <strong>not</strong> delete the folder for the Web Disk account.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=example1@example.com</span></div><div><div html="&lt;p&gt;The Web Disk account username.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Web Disk account username.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/WebDisk/delete_user</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/WebDisk/delete_user</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kjb6q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kjb6q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kjb6q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kjb6q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kjb6q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kjb6q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kjb6q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kjb6q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kjb6q:0" aria-labelledby="tab:R4kjb6q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  WebDisk <span class="token punctuation">\</span>
  delete_user <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'example1@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">destroy</span><span class="token operator">=</span><span class="token string">'1'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kjb6q:1" aria-labelledby="tab:R4kjb6q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kjb6q:2" aria-labelledby="tab:R4kjb6q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kjb6q:3" aria-labelledby="tab:R4kjb6q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sjb6q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sjb6q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sjb6q:0" aria-labelledby="tab:R4sjb6q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;delete_user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;WebDisk&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/WebDisk-Settings/operation/WebDisk::set_password" data-section-id="tag/WebDisk-Settings/operation/WebDisk::set_password" class="sc-dntaoT ceciOs"><div data-section-id="operation/WebDisk::set_password" id="operation/WebDisk::set_password" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/WebDisk-Settings/operation/WebDisk::set_password" aria-label="tag/WebDisk-Settings/operation/WebDisk::set_password"></a>Update Web Disk account password </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function changes the Web Disk account&amp;#39;s password.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Web Disk role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function changes the Web Disk account&#39;s password.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Web Disk role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="enabledigest" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">enabledigest</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">enabledigest=0</span></div><div><div html="&lt;p&gt;Whether to enable Digest Authentication.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Enable Digest Authentication.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Disable Digest Authentication.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to enable Digest Authentication.</p>
<ul>
<li><code>1</code> - Enable Digest Authentication.</li>
<li><code>0</code> - Disable Digest Authentication.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="password" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">password</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">password=123456luggage</span></div><div><div html="&lt;p&gt;The Web Disk account&amp;#39;s password.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Web Disk account&#39;s password.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=example1@example.com</span></div><div><div html="&lt;p&gt;The Web Disk account username.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Web Disk account username.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/WebDisk/set_password</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/WebDisk/set_password</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4klb6q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4klb6q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4klb6q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4klb6q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4klb6q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4klb6q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4klb6q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4klb6q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4klb6q:0" aria-labelledby="tab:R4klb6q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  WebDisk <span class="token punctuation">\</span>
  set_password <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'example1@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">password</span><span class="token operator">=</span><span class="token string">'123456luggage'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4klb6q:1" aria-labelledby="tab:R4klb6q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4klb6q:2" aria-labelledby="tab:R4klb6q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4klb6q:3" aria-labelledby="tab:R4klb6q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4slb6q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4slb6q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4slb6q:0" aria-labelledby="tab:R4slb6q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_password&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;WebDisk&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/WebDisk-Settings/operation/WebDisk::set_homedir" data-section-id="tag/WebDisk-Settings/operation/WebDisk::set_homedir" class="sc-dntaoT ceciOs"><div data-section-id="operation/WebDisk::set_homedir" id="operation/WebDisk::set_homedir" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/WebDisk-Settings/operation/WebDisk::set_homedir" aria-label="tag/WebDisk-Settings/operation/WebDisk::set_homedir"></a>Update Web Disk home directory location </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function changes the home directory for a Web Disk account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serveroles&quot;&gt;Web Disk role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function changes the home directory for a Web Disk account.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serveroles">Web Disk role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="homedir" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">homedir</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">homedir=example1/</span></div><div><div html="&lt;p&gt;The Web Disk account&amp;#39;s home directory.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Web Disk account&#39;s home directory.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="private" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">private</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">private=0</span></div><div><div html="&lt;p&gt;Whether to set the Web Disk directory&amp;#39;s permissions to public or private.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Private (&lt;code&gt;0700&lt;/code&gt;)&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Public (&lt;code&gt;0755&lt;/code&gt;)&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to set the Web Disk directory&#39;s permissions to public or private.</p>
<ul>
<li><code>1</code> - Private (<code>0700</code>)</li>
<li><code>0</code> - Public (<code>0755</code>)</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=example1@example.com</span></div><div><div html="&lt;p&gt;The Web Disk account username.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Web Disk account username.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/WebDisk/set_homedir</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/WebDisk/set_homedir</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4knb6q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4knb6q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4knb6q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4knb6q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4knb6q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4knb6q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4knb6q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4knb6q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4knb6q:0" aria-labelledby="tab:R4knb6q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  WebDisk <span class="token punctuation">\</span>
  set_homedir <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'example1@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">homedir</span><span class="token operator">=</span><span class="token string">'example1/'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4knb6q:1" aria-labelledby="tab:R4knb6q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4knb6q:2" aria-labelledby="tab:R4knb6q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4knb6q:3" aria-labelledby="tab:R4knb6q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4snb6q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4snb6q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4snb6q:0" aria-labelledby="tab:R4snb6q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_homedir&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;WebDisk&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/WebDisk-Settings/operation/set_permissions" data-section-id="tag/WebDisk-Settings/operation/set_permissions" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_permissions" id="operation/set_permissions" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/WebDisk-Settings/operation/set_permissions" aria-label="tag/WebDisk-Settings/operation/set_permissions"></a>Update Web Disk home directory permissions </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function changes the Web Disk home directory&amp;#39;s permissions.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Web Disk role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function changes the Web Disk home directory&#39;s permissions.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Web Disk role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="perms" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">perms</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;ro&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;rw&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">perms=rw</span></div><div><div html="&lt;p&gt;The Web Disk account&amp;#39;s home directory file permissions.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;ro&lt;/code&gt; — Read-only permissions.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;rw&lt;/code&gt; — Read and write permissions.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Web Disk account&#39;s home directory file permissions.</p>
<ul>
<li><code>ro</code> — Read-only permissions.</li>
<li><code>rw</code> — Read and write permissions.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=example1@example.com</span></div><div><div html="&lt;p&gt;The Web Disk account&amp;#39;s username.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Web Disk account&#39;s username.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/WebDisk/set_permissions</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/WebDisk/set_permissions</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kpb6q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kpb6q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kpb6q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kpb6q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kpb6q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kpb6q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kpb6q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kpb6q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kpb6q:0" aria-labelledby="tab:R4kpb6q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  WebDisk <span class="token punctuation">\</span>
  set_permissions <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'example1@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">perms</span><span class="token operator">=</span><span class="token string">'rw'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kpb6q:1" aria-labelledby="tab:R4kpb6q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kpb6q:2" aria-labelledby="tab:R4kpb6q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kpb6q:3" aria-labelledby="tab:R4kpb6q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4spb6q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4spb6q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4spb6q:0" aria-labelledby="tab:R4spb6q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_permissions&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;WebDisk&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Deployment-Settings" data-section-id="tag/Deployment-Settings" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Deployment-Settings" aria-label="tag/Deployment-Settings"></a>Deployment Settings</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;GIT Management / Deployment Settings&lt;/p&gt;
"><p>GIT Management / Deployment Settings</p>
</div></div></div><div id="tag/Deployment-Settings/operation/VersionControlDeployment::create" data-section-id="tag/Deployment-Settings/operation/VersionControlDeployment::create" class="sc-dntaoT ceciOs"><div data-section-id="operation/VersionControlDeployment::create" id="operation/VersionControlDeployment::create" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Deployment-Settings/operation/VersionControlDeployment::create" aria-label="tag/Deployment-Settings/operation/VersionControlDeployment::create"></a>Create Git deployment task </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function deploys the changes from a cPanel-managed repository.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;The system logs messages for this function in the &lt;code&gt;~/.cpanel/logs/vc_TIMESTAMP_git_deploy.log&lt;/code&gt; file, where TIMESTAMP represents the time in Unix epoch time. The system pulls changes with the &lt;code&gt;--ff-only&lt;/code&gt; option and will only succeed if the branch&amp;#39;s HEAD commit is up-to-date or Git can fast forward it. For more information about our suggested deployment configuration and how users can set it up, read our &lt;a href=&quot;https://go.cpanel.net/GitDeployment&quot;&gt;Guide to Git™ - Deployment&lt;/a&gt; documentation. Before deployment, repositories must meet the following requirements:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;A valid checked-in &lt;code&gt;.cpanel.yml&lt;/code&gt; file in the top-level directory.&lt;/li&gt;
&lt;li&gt;One or more local or remote branches.&lt;/li&gt;
&lt;li&gt;A clean working tree.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;If a repository does &lt;strong&gt;not&lt;/strong&gt; meet these requirements, the system will &lt;strong&gt;not&lt;/strong&gt; display deployment information. Also, it will disable deployment functionality. For more information, read our &lt;a href=&quot;https://go.cpanel.net/GitDeployment&quot;&gt;Guide to Git™ - Deployment&lt;/a&gt; documentation.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deploys the changes from a cPanel-managed repository.</p>
<p><strong>Important:</strong></p>
<p>The system logs messages for this function in the <code>~/.cpanel/logs/vc_TIMESTAMP_git_deploy.log</code> file, where TIMESTAMP represents the time in Unix epoch time. The system pulls changes with the <code>--ff-only</code> option and will only succeed if the branch&#39;s HEAD commit is up-to-date or Git can fast forward it. For more information about our suggested deployment configuration and how users can set it up, read our <a href="https://go.cpanel.net/GitDeployment">Guide to Git™ - Deployment</a> documentation. Before deployment, repositories must meet the following requirements:</p>
<ul>
<li>A valid checked-in <code>.cpanel.yml</code> file in the top-level directory.</li>
<li>One or more local or remote branches.</li>
<li>A clean working tree.</li>
</ul>
<p>If a repository does <strong>not</strong> meet these requirements, the system will <strong>not</strong> display deployment information. Also, it will disable deployment functionality. For more information, read our <a href="https://go.cpanel.net/GitDeployment">Guide to Git™ - Deployment</a> documentation.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="repository_root" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">repository_root</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">repository_root=/home/user/public_html/example</span></div><div><div html="&lt;p&gt;The repository&amp;#39;s directory.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The repository&#39;s directory.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/VersionControlDeployment/create</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/VersionControlDeployment/create</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R155j7a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R155j7a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R155j7a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R155j7a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R155j7a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R155j7a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R155j7a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R155j7a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R155j7a:0" aria-labelledby="tab:R155j7a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  VersionControlDeployment <span class="token punctuation">\</span>
  create <span class="token punctuation">\</span>
  <span class="token assign-left variable">repository_root</span><span class="token operator">=</span><span class="token string">'/home/user/public_html/example'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155j7a:1" aria-labelledby="tab:R155j7a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155j7a:2" aria-labelledby="tab:R155j7a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155j7a:3" aria-labelledby="tab:R155j7a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R175j7a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R175j7a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R175j7a:0" aria-labelledby="tab:R175j7a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;create&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;VersionControlDeployment&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"deploy_id"</span>: <span class="token string">&quot;12&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"log_path"</span>: <span class="token string">&quot;/home/user/.cpanel/logs/vc_1525289545.785367_git_deploy.log&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"repository_root"</span>: <span class="token string">&quot;/home/username/example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sse_url"</span>: <span class="token string">&quot;/sse/UserTasks/B3A27B96-51F7-11E8-92E3-CC90C4F823F0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"task_id"</span>: <span class="token string">&quot;00000000/5a9ec8dd4c345d&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"timestamps"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"queued"</span>: <span class="token string">&quot;1525289545.16293&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Deployment-Settings/operation/delete" data-section-id="tag/Deployment-Settings/operation/delete" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete" id="operation/delete" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Deployment-Settings/operation/delete" aria-label="tag/Deployment-Settings/operation/delete"></a>Delete Git deployment task </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function deletes a deployment task. For more information, read our &lt;a href=&quot;https://go.cpanel.net/GitDeployment&quot;&gt;Guide to Git - Deployment&lt;/a&gt; documentation.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes a deployment task. For more information, read our <a href="https://go.cpanel.net/GitDeployment">Guide to Git - Deployment</a> documentation.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="deploy_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">deploy_id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">deploy_id=13</span></div><div><div html="&lt;p&gt;The &lt;a href=&quot;https://go.cpanel.net/whmdocsTaskQueueMonitor&quot;&gt;Task Queue system&amp;#39;s&lt;/a&gt; task ID number.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The <a href="https://go.cpanel.net/whmdocsTaskQueueMonitor">Task Queue system&#39;s</a> task ID number.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/VersionControlDeployment/delete</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/VersionControlDeployment/delete</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R156j7a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R156j7a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R156j7a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R156j7a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R156j7a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R156j7a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R156j7a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R156j7a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R156j7a:0" aria-labelledby="tab:R156j7a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  VersionControlDeployment <span class="token punctuation">\</span>
  delete <span class="token punctuation">\</span>
  <span class="token assign-left variable">deploy_id</span><span class="token operator">=</span><span class="token string">'13'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R156j7a:1" aria-labelledby="tab:R156j7a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R156j7a:2" aria-labelledby="tab:R156j7a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R156j7a:3" aria-labelledby="tab:R156j7a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R176j7a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R176j7a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R176j7a:0" aria-labelledby="tab:R176j7a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;delete&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;VersionControlDeployment&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Deployment-Settings/operation/VersionControlDeployment::retrieve" data-section-id="tag/Deployment-Settings/operation/VersionControlDeployment::retrieve" class="sc-dntaoT ceciOs"><div data-section-id="operation/VersionControlDeployment::retrieve" id="operation/VersionControlDeployment::retrieve" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Deployment-Settings/operation/VersionControlDeployment::retrieve" aria-label="tag/Deployment-Settings/operation/VersionControlDeployment::retrieve"></a>Return Git deployment task status </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves the status of deployment tasks. Before deployment, repositories must meet the following requirements:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;A valid checked-in &lt;code&gt;.cpanel.yml&lt;/code&gt; file in the top-level directory.&lt;/li&gt;
&lt;li&gt;One or more local or remote branches.&lt;/li&gt;
&lt;li&gt;A clean working tree.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;If a repository does &lt;strong&gt;not&lt;/strong&gt; meet these requirements, the system will &lt;strong&gt;not&lt;/strong&gt; display deployment information. Also, it will disable deployment functionality. For more information, read our &lt;a href=&quot;https://go.cpanel.net/GitDeployment&quot;&gt;Guide to Git™ - Deployment&lt;/a&gt; documentation.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;The system logs messages for this function in the &lt;code&gt;~/.cpanel/logs/vc_TIMESTAMP_git_deploy.log&lt;/code&gt; file, where &lt;code&gt;TIMESTAMP&lt;/code&gt; represents the time in Unix epoch time.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the status of deployment tasks. Before deployment, repositories must meet the following requirements:</p>
<ul>
<li>A valid checked-in <code>.cpanel.yml</code> file in the top-level directory.</li>
<li>One or more local or remote branches.</li>
<li>A clean working tree.</li>
</ul>
<p>If a repository does <strong>not</strong> meet these requirements, the system will <strong>not</strong> display deployment information. Also, it will disable deployment functionality. For more information, read our <a href="https://go.cpanel.net/GitDeployment">Guide to Git™ - Deployment</a> documentation.</p>
<p><strong>Important:</strong></p>
<p>The system logs messages for this function in the <code>~/.cpanel/logs/vc_TIMESTAMP_git_deploy.log</code> file, where <code>TIMESTAMP</code> represents the time in Unix epoch time.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/VersionControlDeployment/retrieve</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/VersionControlDeployment/retrieve</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R157j7a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R157j7a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R157j7a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R157j7a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R157j7a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R157j7a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R157j7a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R157j7a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R157j7a:0" aria-labelledby="tab:R157j7a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  VersionControlDeployment <span class="token punctuation">\</span>
  retrieve
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R157j7a:1" aria-labelledby="tab:R157j7a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R157j7a:2" aria-labelledby="tab:R157j7a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R157j7a:3" aria-labelledby="tab:R157j7a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R177j7a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R177j7a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R177j7a:0" aria-labelledby="tab:R177j7a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;retrieve&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;VersionControlDeployment&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"deploy_id"</span>: <span class="token number">13</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"log_path"</span>: <span class="token string">&quot;/home/user/.cpanel/logs/vc_1525289448.759720_git_deploy.log&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"repository_root"</span>: <span class="token string">&quot;/home/username/example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"repository_state"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"author"</span>: <span class="token string">&quot;Jane Doe &lt;jane.doe@example.com&gt;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"branch"</span>: <span class="token string">&quot;master&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"date"</span>: <span class="token number">1410277881</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"identifier"</span>: <span class="token string">&quot;2fd4e1c67a2d28fced849ee1bb76e7391b93eb12&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">&quot;This is a commit.&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sse_url"</span>: <span class="token string">&quot;/sse/UserTasks/B3A27B96-51F7-11E8-92E3-CC90C4F823F0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"task_id"</span>: <span class="token string">&quot;00000000/5aea11e886a5d8&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"timestamps"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"active"</span>: <span class="token string">&quot;1525289448.83553&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"canceled"</span>: <span class="token string">&quot;1525289448.83553&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"failed"</span>: <span class="token string">&quot;1525289448.83553&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"queued"</span>: <span class="token string">&quot;1525289448.83553&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"succeeded"</span>: <span class="token string">&quot;1525289448.83553&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Repository-Management" data-section-id="tag/Repository-Management" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Repository-Management" aria-label="tag/Repository-Management"></a>Repository Management</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;GIT Management / Repository Management&lt;/p&gt;
"><p>GIT Management / Repository Management</p>
</div></div></div><div id="tag/Repository-Management/operation/VersionControl::create" data-section-id="tag/Repository-Management/operation/VersionControl::create" class="sc-dntaoT ceciOs"><div data-section-id="operation/VersionControl::create" id="operation/VersionControl::create" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Repository-Management/operation/VersionControl::create" aria-label="tag/Repository-Management/operation/VersionControl::create"></a>Create Git repository </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function creates a new Git™ repository on a cPanel account.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;For more information about support for version control in cPanel &amp;amp; WHM, read our
&lt;a href=&quot;https://go.cpanel.net/GitVersionControl&quot;&gt;Git Version Control&lt;/a&gt; and
&lt;a href=&quot;https://go.cpanel.net/GitDeployment&quot;&gt;Guide to Git&lt;/a&gt; documentation.&lt;/li&gt;
&lt;li&gt;For a list of configuration changes, repository restrictions, and troubleshooting steps,
read our &lt;a href=&quot;https://go.cpanel.net/GuidetoGitForSystemAdministrators&quot;&gt;Guide to Git - For System Administrators&lt;/a&gt; documentation.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;The system logs errors for this function in the &lt;code&gt;~/.cpanel/logs/vc_TIMESTAMP_git_create.log&lt;/code&gt;
file, where &lt;code&gt;TIMESTAMP&lt;/code&gt; represents the time of the error in Unix epoch time.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a new Git™ repository on a cPanel account.</p>
<ul>
<li>For more information about support for version control in cPanel &amp; WHM, read our
<a href="https://go.cpanel.net/GitVersionControl">Git Version Control</a> and
<a href="https://go.cpanel.net/GitDeployment">Guide to Git</a> documentation.</li>
<li>For a list of configuration changes, repository restrictions, and troubleshooting steps,
read our <a href="https://go.cpanel.net/GuidetoGitForSystemAdministrators">Guide to Git - For System Administrators</a> documentation.</li>
</ul>
<p><strong>Important:</strong></p>
<p>The system logs errors for this function in the <code>~/.cpanel/logs/vc_TIMESTAMP_git_create.log</code>
file, where <code>TIMESTAMP</code> represents the time of the error in Unix epoch time.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">name</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=example</span></div><div><div html="&lt;p&gt;The new repository&amp;#39;s display name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new repository&#39;s display name.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="repository_root" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">repository_root</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">repository_root=/home/user/public_html/example</span></div><div><div html="&lt;p&gt;The absolute path to the directory in which to store the repository, relative to the
user&amp;#39;s &lt;code&gt;home&lt;/code&gt; directory.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;If the directory does &lt;strong&gt;not&lt;/strong&gt; exist, the system will create it.&lt;/li&gt;
&lt;li&gt;If the specified directory already contains a repository, the system will
automatically add it to the list of cPanel-managed repositories.&lt;/li&gt;
&lt;li&gt;This feature enforces several restrictions on repository paths. For more information,
read our &lt;a href=&quot;https://go.cpanel.net/GuidetoGitForSystemAdministrators&quot;&gt;Guide to Git - For System Administrators&lt;/a&gt; documentation.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The absolute path to the directory in which to store the repository, relative to the
user&#39;s <code>home</code> directory.</p>
<p><strong>Note:</strong></p>
<ul>
<li>If the directory does <strong>not</strong> exist, the system will create it.</li>
<li>If the specified directory already contains a repository, the system will
automatically add it to the list of cPanel-managed repositories.</li>
<li>This feature enforces several restrictions on repository paths. For more information,
read our <a href="https://go.cpanel.net/GuidetoGitForSystemAdministrators">Guide to Git - For System Administrators</a> documentation.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="source_repository" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand source_repository"><span class="property-name">source_repository</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">source_repository={&quot;remote_name&quot;:&quot;origin&quot;,&quot;url&quot;:&quot;ssh://clone.domain.com/cloneme&quot;}</span></div><div><div html="&lt;p&gt;A JSON-formatted object containing information about the source repository that the
system will clone.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If you do &lt;strong&gt;not&lt;/strong&gt; include source repository data, the function creates an empty repository.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A JSON-formatted object containing information about the source repository that the
system will clone.</p>
<p><strong>Note:</strong></p>
<p>If you do <strong>not</strong> include source repository data, the function creates an empty repository.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="type" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">type</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Value:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;git&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">type=git</span></div><div><div html="&lt;p&gt;The repository type.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;git&lt;/code&gt; — A &lt;a href=&quot;https://git-scm.com/&quot;&gt;Git&lt;/a&gt; repository.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;&lt;code&gt;git&lt;/code&gt; is the only possible value.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The repository type.</p>
<ul>
<li><code>git</code> — A <a href="https://git-scm.com/">Git</a> repository.</li>
</ul>
<p><strong>Note:</strong></p>
<p><code>git</code> is the only possible value.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/VersionControl/create</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/VersionControl/create</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a9l7a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9l7a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9l7a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9l7a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2a9l7a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9l7a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2a9l7a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9l7a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9l7a:0" aria-labelledby="tab:R2a9l7a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  VersionControl <span class="token punctuation">\</span>
  create <span class="token punctuation">\</span>
  <span class="token assign-left variable">type</span><span class="token operator">=</span><span class="token string">'git'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'example'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">repository_root</span><span class="token operator">=</span><span class="token string">'/home/user/public_html/example'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9l7a:1" aria-labelledby="tab:R2a9l7a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9l7a:2" aria-labelledby="tab:R2a9l7a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9l7a:3" aria-labelledby="tab:R2a9l7a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2e9l7a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9l7a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9l7a:0" aria-labelledby="tab:R2e9l7a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;create&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;VersionControl&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"available_branches"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;master&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;olive&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"branch"</span>: <span class="token string">&quot;master&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"clone_urls"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"read_only"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;</span><a href="https://user@example.com/home/user/example">https://user@example.com/home/user/example</a><span class="token string">&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"read_write"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;ssh://user@example.com/home/user/example&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_update"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"repository_root"</span>: <span class="token string">&quot;/home/user/public_html/example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"source_repository"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"remote_name"</span>: <span class="token string">&quot;remote&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">&quot;</span><a href="http://user@domain.com/home/user/domain">http://user@domain.com/home/user/domain</a><span class="token string">&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tasks"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"action"</span>: <span class="token string">&quot;create&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"args"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"log_file"</span>: <span class="token string">&quot;/home/username/.cpanel/logs/vc_1234567890.123456_git_deploy.log&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"repository_root"</span>: <span class="token string">&quot;/home/user/example&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;00000000/5a9ec8dd4c345d&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sse_url"</span>: <span class="token string">&quot;/sse/UserTasks/B3A27B96-51F7-11E8-92E3-CC90C4F823F0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subsystem"</span>: <span class="token string">&quot;VersionControl&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;git&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Repository-Management/operation/VersionControl::update" data-section-id="tag/Repository-Management/operation/VersionControl::update" class="sc-dntaoT ceciOs"><div data-section-id="operation/VersionControl::update" id="operation/VersionControl::update" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Repository-Management/operation/VersionControl::update" aria-label="tag/Repository-Management/operation/VersionControl::update"></a>Update Git repository settings </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function modifies a Git™ repository&amp;#39;s basic settings. For more information about support
for version control in cPanel &amp;amp; WHM, read our
&lt;a href=&quot;https://go.cpanel.net/GitVersionControl&quot;&gt;Git Version Control&lt;/a&gt;
and &lt;a href=&quot;https://go.cpanel.net/GitDeployment&quot;&gt;Guide to Git&lt;/a&gt; documentation.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;This function &lt;strong&gt;only&lt;/strong&gt; pulls changes from the remote repository if you specify a &lt;code&gt;branch&lt;/code&gt; value.&lt;/li&gt;
&lt;li&gt;You &lt;strong&gt;cannot&lt;/strong&gt; modify the &lt;code&gt;type&lt;/code&gt;, &lt;code&gt;repository_root&lt;/code&gt;, or &lt;code&gt;url&lt;/code&gt; values for existing repositories.&lt;/li&gt;
&lt;li&gt;You &lt;strong&gt;must&lt;/strong&gt; include the &lt;code&gt;repository_root&lt;/code&gt; parameter in order to identify the repository to
update.&lt;/li&gt;
&lt;li&gt;All other input parameters are &lt;strong&gt;optional&lt;/strong&gt;. Use them to assign the &lt;strong&gt;new&lt;/strong&gt; values to the
account. If you do not include a parameter or specify its existing value, no change will occur.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function modifies a Git™ repository&#39;s basic settings. For more information about support
for version control in cPanel &amp; WHM, read our
<a href="https://go.cpanel.net/GitVersionControl">Git Version Control</a>
and <a href="https://go.cpanel.net/GitDeployment">Guide to Git</a> documentation.</p>
<p><strong>Note:</strong></p>
<ul>
<li>This function <strong>only</strong> pulls changes from the remote repository if you specify a <code>branch</code> value.</li>
<li>You <strong>cannot</strong> modify the <code>type</code>, <code>repository_root</code>, or <code>url</code> values for existing repositories.</li>
<li>You <strong>must</strong> include the <code>repository_root</code> parameter in order to identify the repository to
update.</li>
<li>All other input parameters are <strong>optional</strong>. Use them to assign the <strong>new</strong> values to the
account. If you do not include a parameter or specify its existing value, no change will occur.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="branch" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">branch</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">branch=master</span></div><div><div html="&lt;p&gt;The new branch to use.&lt;/p&gt;
&lt;p&gt;If you do not specify a value, the function does &lt;strong&gt;not&lt;/strong&gt; update this parameter.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Remember:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This function &lt;strong&gt;only&lt;/strong&gt; pulls changes from the remote repository if you specify
this value.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new branch to use.</p>
<p>If you do not specify a value, the function does <strong>not</strong> update this parameter.</p>
<p><strong>Remember:</strong></p>
<p>This function <strong>only</strong> pulls changes from the remote repository if you specify
this value.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">name</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=example</span></div><div><div html="&lt;p&gt;The repository&amp;#39;s new display name.&lt;/p&gt;
&lt;p&gt;If you do not specify a value, the function does &lt;strong&gt;not&lt;/strong&gt; update this parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The repository&#39;s new display name.</p>
<p>If you do not specify a value, the function does <strong>not</strong> update this parameter.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="repository_root" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">repository_root</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">repository_root=/home/user/public_html/example</span></div><div><div html="&lt;p&gt;The absolute directory path that contains the repository to update.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The absolute directory path that contains the repository to update.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="source_repository" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand source_repository"><span class="property-name">source_repository</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">source_repository={&quot;remote_name&quot;:&quot;origin&quot;}</span></div><div><div html="&lt;p&gt;A JSON-encoded object containing information about the source repository.&lt;/p&gt;
&lt;p&gt;If you do not specify a value, the function does &lt;strong&gt;not&lt;/strong&gt; update this parameter.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;You &lt;strong&gt;cannot&lt;/strong&gt; modify the source repository&amp;#39;s URL.&lt;/li&gt;
&lt;li&gt;You &lt;strong&gt;must&lt;/strong&gt; JSON-encode the contents of this object.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A JSON-encoded object containing information about the source repository.</p>
<p>If you do not specify a value, the function does <strong>not</strong> update this parameter.</p>
<p><strong>Important:</strong></p>
<ul>
<li>You <strong>cannot</strong> modify the source repository&#39;s URL.</li>
<li>You <strong>must</strong> JSON-encode the contents of this object.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/VersionControl/update</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/VersionControl/update</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aal7a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aal7a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aal7a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aal7a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2aal7a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aal7a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2aal7a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aal7a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aal7a:0" aria-labelledby="tab:R2aal7a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  VersionControl <span class="token punctuation">\</span>
  update <span class="token punctuation">\</span>
  <span class="token assign-left variable">repository_root</span><span class="token operator">=</span><span class="token string">'/home/user/public_html/example'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aal7a:1" aria-labelledby="tab:R2aal7a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aal7a:2" aria-labelledby="tab:R2aal7a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aal7a:3" aria-labelledby="tab:R2aal7a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eal7a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eal7a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eal7a:0" aria-labelledby="tab:R2eal7a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;update&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;VersionControl&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"available_branches"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;master&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"branch"</span>: <span class="token string">&quot;master&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"clone_urls"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"read_only"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;</span><a href="https://user@example.com/home/user/example">https://user@example.com/home/user/example</a><span class="token string">&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"read_write"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;ssh://user@example.com/home/user/example&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deployable"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_deployment"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"deployment_date"</span>: <span class="token number">1569844800</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"repository_state"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"author"</span>: <span class="token string">&quot;User Name &lt;user.name@example.com&gt;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"date"</span>: <span class="token number">1569844800</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"identifier"</span>: <span class="token string">&quot;2fd4e1c67a2d28fced849ee1bb76e7391b93eb121&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">&quot;I'm committing some particularly cromulent code.&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_update"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"author"</span>: <span class="token string">&quot;Jane Doe &lt;jane.doe@example.com&gt;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"date"</span>: <span class="token number">1569844800</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"identifier"</span>: <span class="token string">&quot;2fd4e1c67a2d28fced849ee1bb76e7391b93eb12&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">&quot;I'm committing some particularly cromulent code.&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"repository_root"</span>: <span class="token string">&quot;/home/user/example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tasks"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"action"</span>: <span class="token string">&quot;create&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"args"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"repository_root"</span>: <span class="token string">&quot;/home/user/example&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;00000000/5a9ec8dd4c345d&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subsystem"</span>: <span class="token string">&quot;VersionControl&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;git&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Repository-Management/operation/VersionControl::delete" data-section-id="tag/Repository-Management/operation/VersionControl::delete" class="sc-dntaoT ceciOs"><div data-section-id="operation/VersionControl::delete" id="operation/VersionControl::delete" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Repository-Management/operation/VersionControl::delete" aria-label="tag/Repository-Management/operation/VersionControl::delete"></a>Delete Git repository </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function deletes a cPanel account&amp;#39;s Git™ repository. For more information about
support for version control in cPanel &amp;amp; WHM, read our
&lt;a href=&quot;https://go.cpanel.net/GitVersionControl&quot;&gt;Git Version Control&lt;/a&gt; and
&lt;a href=&quot;https://go.cpanel.net/GitDeployment&quot;&gt;Guide to Git&lt;/a&gt; documentation.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;When you call this function, the system &lt;strong&gt;permanently deletes&lt;/strong&gt; the entire contents
of the specified directory. You &lt;strong&gt;cannot&lt;/strong&gt; recover this data after deletion.&lt;/li&gt;
&lt;li&gt;You &lt;strong&gt;cannot&lt;/strong&gt; use this function to delete any repositories that do not appear in
the cache of repositories (for example, repositories that contain invalid characters or
exist within cPanel-controlled directories).&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes a cPanel account&#39;s Git™ repository. For more information about
support for version control in cPanel &amp; WHM, read our
<a href="https://go.cpanel.net/GitVersionControl">Git Version Control</a> and
<a href="https://go.cpanel.net/GitDeployment">Guide to Git</a> documentation.</p>
<p><strong>Warning:</strong></p>
<ul>
<li>When you call this function, the system <strong>permanently deletes</strong> the entire contents
of the specified directory. You <strong>cannot</strong> recover this data after deletion.</li>
<li>You <strong>cannot</strong> use this function to delete any repositories that do not appear in
the cache of repositories (for example, repositories that contain invalid characters or
exist within cPanel-controlled directories).</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="repository_root" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">repository_root</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">repository_root=/home/user/example</span></div><div><div html="&lt;p&gt;The absolute directory path in the user&amp;#39;s &lt;code&gt;home&lt;/code&gt; directory containing the repository to delete.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The absolute directory path in the user&#39;s <code>home</code> directory containing the repository to delete.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/VersionControl/delete</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/VersionControl/delete</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2abl7a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abl7a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abl7a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abl7a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2abl7a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abl7a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2abl7a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abl7a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abl7a:0" aria-labelledby="tab:R2abl7a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  VersionControl <span class="token punctuation">\</span>
  delete <span class="token punctuation">\</span>
  <span class="token assign-left variable">repository_root</span><span class="token operator">=</span><span class="token string">'/home/user/example'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abl7a:1" aria-labelledby="tab:R2abl7a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abl7a:2" aria-labelledby="tab:R2abl7a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abl7a:3" aria-labelledby="tab:R2abl7a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ebl7a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebl7a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebl7a:0" aria-labelledby="tab:R2ebl7a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;delete&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;VersionControl&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Repository-Management/operation/VersionControl::retrieve" data-section-id="tag/Repository-Management/operation/VersionControl::retrieve" class="sc-dntaoT ceciOs"><div data-section-id="operation/VersionControl::retrieve" id="operation/VersionControl::retrieve" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Repository-Management/operation/VersionControl::retrieve" aria-label="tag/Repository-Management/operation/VersionControl::retrieve"></a>Return Git repositories </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists Git™ repositories on a cPanel account. For more information
about support for version control in cPanel &amp;amp; WHM, read our
&lt;a href=&quot;https://go.cpanel.net/GitVersionControl&quot;&gt;Git Version Control&lt;/a&gt; and
&lt;a href=&quot;https://go.cpanel.net/GitDeployment&quot;&gt;Guide to Git&lt;/a&gt; documentation.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;p&gt;This feature does &lt;strong&gt;not&lt;/strong&gt; allow the following characters in repository paths:
&lt;code&gt;\ * | &amp;quot; &amp;#39; &amp;lt; &amp;gt; &amp;amp; @ ` $ { } [ ] ( ) ; ? : = % #&lt;/code&gt;&lt;/p&gt;
&lt;/li&gt;
&lt;li&gt;&lt;p&gt;This function does &lt;strong&gt;not&lt;/strong&gt; allow repositories that exist in the following
cPanel-controlled directories:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;.cpanel&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;.htpasswds&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;.ssh&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;.trash&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;access-logs&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;cgi-bin&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;etc&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;logs&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;perl5&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;mail&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;spamassassin&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;ssl&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;tmp&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;var&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;Users can create repositories in some of these directories on the command line.
They may appear in the list of repositories in Gitweb, but users may see an error
message if they try to access them.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists Git™ repositories on a cPanel account. For more information
about support for version control in cPanel &amp; WHM, read our
<a href="https://go.cpanel.net/GitVersionControl">Git Version Control</a> and
<a href="https://go.cpanel.net/GitDeployment">Guide to Git</a> documentation.</p>
<p><strong>Important:</strong></p>
<ul>
<li><p>This feature does <strong>not</strong> allow the following characters in repository paths:
<code>\ * | &quot; &#39; &lt; &gt; &amp; @ ` $ { } [ ] ( ) ; ? : = % #</code></p>
</li>
<li><p>This function does <strong>not</strong> allow repositories that exist in the following
cPanel-controlled directories:</p>
<ul>
<li><code>.cpanel</code></li>
<li><code>.htpasswds</code></li>
<li><code>.ssh</code></li>
<li><code>.trash</code></li>
<li><code>access-logs</code></li>
<li><code>cgi-bin</code></li>
<li><code>etc</code></li>
<li><code>logs</code></li>
<li><code>perl5</code></li>
<li><code>mail</code></li>
<li><code>spamassassin</code></li>
<li><code>ssl</code></li>
<li><code>tmp</code></li>
<li><code>var</code></li>
</ul>
</li>
</ul>
<p>Users can create repositories in some of these directories on the command line.
They may appear in the list of repositories in Gitweb, but users may see an error
message if they try to access them.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="fields" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">fields</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;*&quot;</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">fields=name,type,branch,last_update</span></div><div><div html="&lt;p&gt;A comma-separated list of desired return values.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;Use a wildcard (&lt;code&gt;*&lt;/code&gt;) to list all possible return values.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A comma-separated list of desired return values.</p>
<p><strong>Note:</strong></p>
<p>Use a wildcard (<code>*</code>) to list all possible return values.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/VersionControl/retrieve</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/VersionControl/retrieve</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2acl7a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2acl7a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2acl7a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acl7a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2acl7a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acl7a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2acl7a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acl7a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2acl7a:0" aria-labelledby="tab:R2acl7a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  VersionControl <span class="token punctuation">\</span>
  retrieve
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acl7a:1" aria-labelledby="tab:R2acl7a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acl7a:2" aria-labelledby="tab:R2acl7a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acl7a:3" aria-labelledby="tab:R2acl7a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ecl7a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ecl7a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ecl7a:0" aria-labelledby="tab:R2ecl7a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;retrieve&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;VersionControl&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"available_branches"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;master&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"branch"</span>: <span class="token string">&quot;master&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"clone_urls"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"read_only"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;</span><a href="https://user@example.com/home/user/example">https://user@example.com/home/user/example</a><span class="token string">&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"read_write"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;ssh://user@example.com/home/user/example&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deployable"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_deployment"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"deployment_date"</span>: <span class="token number">1598774400</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"repository_state"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"author"</span>: <span class="token string">&quot;User Name &lt;user.name@example.com&gt;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"date"</span>: <span class="token number">1598774400</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"identifier"</span>: <span class="token string">&quot;2fd4e1c67a2d28fced849ee1bb76e7391b93eb12&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">&quot;I'm committing some particularly cromulent code.&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_update"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"author"</span>: <span class="token string">&quot;Jane Doe &lt;jane.doe@example.com&gt;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"date"</span>: <span class="token number">1598774400</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"identifier"</span>: <span class="token string">&quot;2fd4e1c67a2d28fced849ee1bb76e7391b93eb12&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">&quot;I'm committing some particularly cromulent code.&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"repository_root"</span>: <span class="token string">&quot;/home/user/example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tasks"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"action"</span>: <span class="token string">&quot;create&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"args"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"log_file"</span>: <span class="token string">&quot;/home/user/.cpanel/logs/vc_1526305129.123456_git_create.log&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"repository_root"</span>: <span class="token string">&quot;/home/user/example&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;00000000/5a9ec8dd4c345d&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sse_url"</span>: <span class="token string">&quot;/sse/UserTasks/B3A27B96-51F7-11E8-92E3-CC90C4F823F0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subsystem"</span>: <span class="token string">&quot;VersionControl&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;git&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"available_branches"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;master&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"branch"</span>: <span class="token string">&quot;master&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deployable"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_update"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"author"</span>: <span class="token string">&quot;June Due &lt;june.due@example2.com&gt;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"clone_urls"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"read_only"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;</span><a href="https://user@example.com/home/user/example">https://user@example.com/home/user/example</a><span class="token string">&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"read_write"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;ssh://user@example.com/home/user/example&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"date"</span>: <span class="token number">1599730200</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"identifier"</span>: <span class="token string">&quot;4ee0b73ddf78213c41fcc185acfab68ced99046d&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_deployment"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"deployment_date"</span>: <span class="token number">1599730200</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"repository_state"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"author"</span>: <span class="token string">&quot;User Name &lt;user.name@example.com&gt;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"date"</span>: <span class="token number">1599730200</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"identifier"</span>: <span class="token string">&quot;2fd4e1c67a2d28fced849ee1bb76e7391b93eb12&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">&quot;I'm committing some particularly cromulent code.&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">&quot;My code makes more sense, actually.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tasks"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"action"</span>: <span class="token string">&quot;create&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"args"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"log_file"</span>: <span class="token string">&quot;/home/user/.cpanel/logs/vc_1526305129.123456_git_create.log&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"repository_root"</span>: <span class="token string">&quot;/home/user/example&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;00000000/5a9ec8dd4c345d&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sse_url"</span>: <span class="token string">&quot;/sse/UserTasks/B3A27B96-51F7-11E8-92E3-CC90C4F823F0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subsystem"</span>: <span class="token string">&quot;VersionControl&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;example2&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"repository_root"</span>: <span class="token string">&quot;/home/user/example2&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;git&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Database-Information" data-section-id="tag/Database-Information" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Database-Information" aria-label="tag/Database-Information"></a>Database Information</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;MySQL and MariaDB / Database Information&lt;/p&gt;
"><p>MySQL and MariaDB / Database Information</p>
</div></div></div><div id="tag/Database-Information/operation/get_server_information" data-section-id="tag/Database-Information/operation/get_server_information" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_server_information" id="operation/get_server_information" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Database-Information/operation/get_server_information" aria-label="tag/Database-Information/operation/get_server_information"></a>Return MySQL server host information and version </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns information about the account&amp;#39;s MySQL® host.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;MySQL role&lt;/a&gt; &lt;strong&gt;and&lt;/strong&gt; remote MySQL is &lt;strong&gt;not&lt;/strong&gt; already configured, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns information about the account&#39;s MySQL® host.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">MySQL role</a> <strong>and</strong> remote MySQL is <strong>not</strong> already configured, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mysql/get_server_information</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mysql/get_server_information</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ab37q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ab37q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ab37q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab37q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2ab37q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab37q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2ab37q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab37q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ab37q:0" aria-labelledby="tab:R2ab37q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mysql <span class="token punctuation">\</span>
  get_server_information
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab37q:1" aria-labelledby="tab:R2ab37q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab37q:2" aria-labelledby="tab:R2ab37q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab37q:3" aria-labelledby="tab:R2ab37q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eb37q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eb37q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eb37q:0" aria-labelledby="tab:R2eb37q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_server_information&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mysql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"host"</span>: <span class="token string">&quot;192.0.2.1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_remote"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">&quot;5.6.23&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Database-Information/operation/locate_server" data-section-id="tag/Database-Information/operation/locate_server" class="sc-dntaoT ceciOs"><div data-section-id="operation/locate_server" id="operation/locate_server" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Database-Information/operation/locate_server" aria-label="tag/Database-Information/operation/locate_server"></a>Return MySQL server host information </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns information about the account&amp;#39;s MySQL® host.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles#roles&quot;&gt;MySQL/MariaDB role&lt;/a&gt; &lt;strong&gt;and&lt;/strong&gt; remote MySQL is &lt;strong&gt;not&lt;/strong&gt; already configured, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns information about the account&#39;s MySQL® host.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles#roles">MySQL/MariaDB role</a> <strong>and</strong> remote MySQL is <strong>not</strong> already configured, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mysql/locate_server</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mysql/locate_server</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ad37q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ad37q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ad37q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ad37q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2ad37q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ad37q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2ad37q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ad37q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ad37q:0" aria-labelledby="tab:R2ad37q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mysql <span class="token punctuation">\</span>
  locate_server
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ad37q:1" aria-labelledby="tab:R2ad37q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ad37q:2" aria-labelledby="tab:R2ad37q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ad37q:3" aria-labelledby="tab:R2ad37q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ed37q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ed37q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ed37q:0" aria-labelledby="tab:R2ed37q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;locate_server&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mysql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"is_remote"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"remote_host"</span>: <span class="token string">&quot;192.0.2.1&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Database-Management" data-section-id="tag/Database-Management" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Database-Management" aria-label="tag/Database-Management"></a>Database Management</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;MySQL and MariaDB / Database Management&lt;/p&gt;
"><p>MySQL and MariaDB / Database Management</p>
</div></div></div><div id="tag/Database-Management/operation/Mysql-update_privileges" data-section-id="tag/Database-Management/operation/Mysql-update_privileges" class="sc-dntaoT ceciOs"><div data-section-id="operation/Mysql-update_privileges" id="operation/Mysql-update_privileges" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Database-Management/operation/Mysql-update_privileges" aria-label="tag/Database-Management/operation/Mysql-update_privileges"></a>Update MySQL® privileges </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function updates privileges for all MySQL® databases and users on an account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;MySQL/MariaDB role&lt;/a&gt; &lt;strong&gt;and&lt;/strong&gt;
remote MySQL is &lt;strong&gt;not&lt;/strong&gt; configured, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function updates privileges for all MySQL® databases and users on an account.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">MySQL/MariaDB role</a> <strong>and</strong>
remote MySQL is <strong>not</strong> configured, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mysql/update_privileges</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mysql/update_privileges</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99357q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99357q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99357q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99357q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99357q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99357q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99357q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99357q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99357q:0" aria-labelledby="tab:R99357q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mysql <span class="token punctuation">\</span>
  update_privileges
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99357q:1" aria-labelledby="tab:R99357q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99357q:2" aria-labelledby="tab:R99357q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99357q:3" aria-labelledby="tab:R99357q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p357q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p357q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p357q:0" aria-labelledby="tab:R9p357q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;update_privileges&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mysql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Database-Management/operation/Mysql-check_database" data-section-id="tag/Database-Management/operation/Mysql-check_database" class="sc-dntaoT ceciOs"><div data-section-id="operation/Mysql-check_database" id="operation/Mysql-check_database" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Database-Management/operation/Mysql-check_database" aria-label="tag/Database-Management/operation/Mysql-check_database"></a>Validate MySQL database integrity </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function checks for errors in all of the tables in a MySQL® database.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;MySQL role&lt;/a&gt; &lt;strong&gt;and&lt;/strong&gt;
remote MySQL is &lt;strong&gt;not&lt;/strong&gt; already configured, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks for errors in all of the tables in a MySQL® database.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">MySQL role</a> <strong>and</strong>
remote MySQL is <strong>not</strong> already configured, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">name</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=example_test</span></div><div><div html="&lt;p&gt;The database&amp;#39;s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database&#39;s name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mysql/check_database</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mysql/check_database</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99557q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99557q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99557q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99557q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99557q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99557q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99557q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99557q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99557q:0" aria-labelledby="tab:R99557q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mysql <span class="token punctuation">\</span>
  check_database <span class="token punctuation">\</span>
  <span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'example_test'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99557q:1" aria-labelledby="tab:R99557q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99557q:2" aria-labelledby="tab:R99557q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99557q:3" aria-labelledby="tab:R99557q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p557q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p557q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p557q:0" aria-labelledby="tab:R9p557q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;check_database&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mysql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"msg_text"</span>: <span class="token string">&quot;OK&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"msg_type"</span>: <span class="token string">&quot;status&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"table"</span>: <span class="token string">&quot;table1&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Database-Management/operation/create_database" data-section-id="tag/Database-Management/operation/create_database" class="sc-dntaoT ceciOs"><div data-section-id="operation/create_database" id="operation/create_database" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Database-Management/operation/create_database" aria-label="tag/Database-Management/operation/create_database"></a>Create MySQL database </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function creates a MySQL® database.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;MySQL/MariaDB role&lt;/a&gt; &lt;strong&gt;and&lt;/strong&gt; remote MySQL is &lt;strong&gt;not&lt;/strong&gt; already configured, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a MySQL® database.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles">MySQL/MariaDB role</a> <strong>and</strong> remote MySQL is <strong>not</strong> already configured, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">name</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=newdb</span></div><div><div html="&lt;p&gt;The new database&amp;#39;s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new database&#39;s name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="prefix-size" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">prefix-size</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">16</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">8</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">16</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">prefix-size=16</span></div><div><div html="&lt;p&gt;The desired prefix size.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The desired prefix size.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mysql/create_database</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mysql/create_database</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99757q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99757q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99757q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99757q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99757q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99757q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99757q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99757q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99757q:0" aria-labelledby="tab:R99757q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mysql <span class="token punctuation">\</span>
  create_database <span class="token punctuation">\</span>
  <span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'newdb'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99757q:1" aria-labelledby="tab:R99757q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99757q:2" aria-labelledby="tab:R99757q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99757q:3" aria-labelledby="tab:R99757q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p757q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p757q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p757q:0" aria-labelledby="tab:R9p757q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;create_database&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mysql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Database-Management/operation/dump_database_schema" data-section-id="tag/Database-Management/operation/dump_database_schema" class="sc-dntaoT ceciOs"><div data-section-id="operation/dump_database_schema" id="operation/dump_database_schema" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Database-Management/operation/dump_database_schema" aria-label="tag/Database-Management/operation/dump_database_schema"></a>Return MySQL database schema </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns a string that you can give to MySQL® to recreate a particular database’s schema.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;MySQL/MariaDB role&lt;/a&gt; &lt;strong&gt;and&lt;/strong&gt; remote MySQL is &lt;strong&gt;not&lt;/strong&gt; configured, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns a string that you can give to MySQL® to recreate a particular database’s schema.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">MySQL/MariaDB role</a> <strong>and</strong> remote MySQL is <strong>not</strong> configured, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="dbname" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">dbname</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">dbname=username_example_db</span></div><div><div html="&lt;p&gt;The database&amp;#39;s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database&#39;s name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mysql/dump_database_schema</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mysql/dump_database_schema</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99957q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99957q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99957q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99957q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99957q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99957q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99957q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99957q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99957q:0" aria-labelledby="tab:R99957q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mysql <span class="token punctuation">\</span>
  dump_database_schema <span class="token punctuation">\</span>
  <span class="token assign-left variable">dbname</span><span class="token operator">=</span><span class="token string">'username_example_db'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99957q:1" aria-labelledby="tab:R99957q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99957q:2" aria-labelledby="tab:R99957q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99957q:3" aria-labelledby="tab:R99957q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p957q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p957q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p957q:0" aria-labelledby="tab:R9p957q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;dump_database_schema&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mysql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token string">&quot;-- MySQL dump 10.13  Distrib 5.7.26, for Linux (x86_64)\n--\n-- Host: localhost    Database:username_example_db\n-- ------------------------------------------------------\n-- Serverversion\t5.7.26\n\n/*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT*/;\n/*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */;\n/*!40101 SET@OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */;\n/*!40101 SET NAMES utf8mb4*/;\n/*!40103 SET @OLD_TIME_ZONE=@@TIME_ZONE */;\n/*!40103 SET TIME_ZONE='+00:00'*/;\n/*!40014 SET @OLD_UNIQUE_CHECKS=@@UNIQUE_CHECKS, UNIQUE_CHECKS=0 */;\n/*!40014 SET@OLD_FOREIGN_KEY_CHECKS=@@FOREIGN_KEY_CHECKS, FOREIGN_KEY_CHECKS=0 */;\n/*!40101 SET@OLD_SQL_MODE=@@SQL_MODE, SQL_MODE='NO_AUTO_VALUE_ON_ZERO' */;\n/*!40111 SE@OLD_SQL_NOTES=@@SQL_NOTES, SQL_NOTES=0 */;\n\n--\n-- Current Database:`username_example_db`\n--\n\nCREATE DATABASE /*!32312 IF NOT EXISTS*/ `username_example_d/*!40100 DEFAULT CHARACTER SET latin1 */;\n\nUSE `username_example_db`;\n/*!40103 SETTIME_ZONE=@OLD_TIME_ZONE */;\n\n/*!40101 SET SQL_MODE=@OLD_SQL_MODE */;\n/*!40014 SETFOREIGN_KEY_CHECKS=@OLD_FOREIGN_KEY_CHECKS */;\n/*!40014 SET UNIQUE_CHECKS=@OLD_UNIQUE_CHECKS*/;\n/*!40101 SET CHARACTER_SET_CLIENT=@OLD_CHARACTER_SET_CLIENT */;\n/*!40101 SETCHARACTER_SET_RESULTS=@OLD_CHARACTER_SET_RESULTS */;\n/*!40101 SETCOLLATION_CONNECTION=@OLD_COLLATION_CONNECTION */;\n/*!40111 SET SQL_NOTES=@OLD_SQL_NOTES*/;\n\n-- Dump completed on 2019-06-06  9:44:04\n&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Database-Management/operation/delete_database" data-section-id="tag/Database-Management/operation/delete_database" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete_database" id="operation/delete_database" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Database-Management/operation/delete_database" aria-label="tag/Database-Management/operation/delete_database"></a>Delete MySQL database </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function deletes a MySQL® database.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;when you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles#roles&quot;&gt;MySQL/MariaDB role&lt;/a&gt; &lt;strong&gt;and&lt;/strong&gt;
remote MySQL is &lt;strong&gt;not&lt;/strong&gt; already configured, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes a MySQL® database.</p>
<p><strong>Important:</strong></p>
<p>when you disable the <a href="https://go.cpanel.net/serverroles#roles">MySQL/MariaDB role</a> <strong>and</strong>
remote MySQL is <strong>not</strong> already configured, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">name</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=example</span></div><div><div html="&lt;p&gt;The database&amp;#39;s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database&#39;s name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mysql/delete_database</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mysql/delete_database</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99b57q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99b57q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99b57q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b57q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99b57q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b57q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99b57q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b57q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99b57q:0" aria-labelledby="tab:R99b57q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mysql <span class="token punctuation">\</span>
  delete_database <span class="token punctuation">\</span>
  <span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'example'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b57q:1" aria-labelledby="tab:R99b57q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b57q:2" aria-labelledby="tab:R99b57q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b57q:3" aria-labelledby="tab:R99b57q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pb57q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pb57q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pb57q:0" aria-labelledby="tab:R9pb57q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;delete_database&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mysql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Database-Management/operation/list_databases" data-section-id="tag/Database-Management/operation/list_databases" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_databases" id="operation/list_databases" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Database-Management/operation/list_databases" aria-label="tag/Database-Management/operation/list_databases"></a>Return MySQL databases </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists an account&amp;#39;s MySQL® databases.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;MySQL/MariaDB&lt;/em&gt; role&lt;/a&gt; &lt;strong&gt;and&lt;/strong&gt; remote MySQL is &lt;strong&gt;not&lt;/strong&gt; configured, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists an account&#39;s MySQL® databases.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles"><em>MySQL/MariaDB</em> role</a> <strong>and</strong> remote MySQL is <strong>not</strong> configured, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mysql/list_databases</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mysql/list_databases</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99d57q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99d57q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99d57q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d57q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99d57q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d57q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99d57q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d57q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99d57q:0" aria-labelledby="tab:R99d57q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mysql <span class="token punctuation">\</span>
  list_databases
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99d57q:1" aria-labelledby="tab:R99d57q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99d57q:2" aria-labelledby="tab:R99d57q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99d57q:3" aria-labelledby="tab:R99d57q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pd57q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pd57q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pd57q:0" aria-labelledby="tab:R9pd57q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_databases&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mysql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"database"</span>: <span class="token string">&quot;user_db&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"disk_usage"</span>: <span class="token number">673</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"users"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;db_user&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;db2_user&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Database-Management/operation/Mysql-rename_database" data-section-id="tag/Database-Management/operation/Mysql-rename_database" class="sc-dntaoT ceciOs"><div data-section-id="operation/Mysql-rename_database" id="operation/Mysql-rename_database" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Database-Management/operation/Mysql-rename_database" aria-label="tag/Database-Management/operation/Mysql-rename_database"></a>Update MySQL database name </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function renames a MySQL® database.&lt;/p&gt;
&lt;p&gt;MySQL does not allow you to rename a database. When cPanel &amp;amp; WHM &amp;quot;renames&amp;quot; a database, the
system performs the following steps:&lt;/p&gt;
&lt;ol&gt;
&lt;li&gt;The system creates a new database.&lt;/li&gt;
&lt;li&gt;The system moves data from the old database to the new database.&lt;/li&gt;
&lt;li&gt;The system recreates grants and stored code in the new database.&lt;/li&gt;
&lt;li&gt;The system deletes the old database and its grants.&lt;/li&gt;
&lt;/ol&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;It is potentially dangerous to rename a MySQL database. We &lt;strong&gt;strongly&lt;/strong&gt; recommend that you
perform a backup of the database before you attempt to rename it.&lt;/li&gt;
&lt;li&gt;If any of the first three steps fail, the system returns an error and attempts to restore the database&amp;#39;s original state.
 If the restoration process fails, the API function&amp;#39;s error response describes these additional failures.&lt;/li&gt;
&lt;li&gt;In rare cases, the system creates the second database successfully, but fails to delete the old database or grants.
 The system treats the rename action as a success; however,
 the API function returns warnings that describe the failure to delete the old database or grants.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;MySQL/MariaDB role&lt;/a&gt;
&lt;strong&gt;and&lt;/strong&gt; remote MySQL is &lt;strong&gt;not&lt;/strong&gt; already configured, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function renames a MySQL® database.</p>
<p>MySQL does not allow you to rename a database. When cPanel &amp; WHM &quot;renames&quot; a database, the
system performs the following steps:</p>
<ol>
<li>The system creates a new database.</li>
<li>The system moves data from the old database to the new database.</li>
<li>The system recreates grants and stored code in the new database.</li>
<li>The system deletes the old database and its grants.</li>
</ol>
<p><strong>Warning:</strong></p>
<ul>
<li>It is potentially dangerous to rename a MySQL database. We <strong>strongly</strong> recommend that you
perform a backup of the database before you attempt to rename it.</li>
<li>If any of the first three steps fail, the system returns an error and attempts to restore the database&#39;s original state.
 If the restoration process fails, the API function&#39;s error response describes these additional failures.</li>
<li>In rare cases, the system creates the second database successfully, but fails to delete the old database or grants.
 The system treats the rename action as a success; however,
 the API function returns warnings that describe the failure to delete the old database or grants.</li>
</ul>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">MySQL/MariaDB role</a>
<strong>and</strong> remote MySQL is <strong>not</strong> already configured, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="newname" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">newname</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &lt;= 64 characters </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">newname=newlyrenamed</span></div><div><div html="&lt;p&gt;The database&amp;#39;s new name.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;If database prefixing is enabled, you &lt;strong&gt;must&lt;/strong&gt; prefix this value with the account prefix
and an underscore (&lt;code&gt;_&lt;/code&gt;). For example, for the &lt;code&gt;dbuser&lt;/code&gt; database on the user cPanel account,
pass in a value of &lt;code&gt;user_dbuser&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;The maximum length of the database name is 64 characters. However, due to the method that
cPanel &amp;amp; WHM uses to store MySQL database names, each underscore character requires two
characters of that limit. Therefore, if you enable database prefixing, the maximum length of
the database name is 63 characters, which includes both the database prefix and the
underscore character. Each additional underscore requires another two characters of that
limit.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database&#39;s new name.</p>
<p><strong>Important:</strong></p>
<ul>
<li>If database prefixing is enabled, you <strong>must</strong> prefix this value with the account prefix
and an underscore (<code>_</code>). For example, for the <code>dbuser</code> database on the user cPanel account,
pass in a value of <code>user_dbuser</code>.</li>
<li>The maximum length of the database name is 64 characters. However, due to the method that
cPanel &amp; WHM uses to store MySQL database names, each underscore character requires two
characters of that limit. Therefore, if you enable database prefixing, the maximum length of
the database name is 63 characters, which includes both the database prefix and the
underscore character. Each additional underscore requires another two characters of that
limit.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="oldname" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">oldname</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">oldname=mydb</span></div><div><div html="&lt;p&gt;The database&amp;#39;s current name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database&#39;s current name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mysql/rename_database</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mysql/rename_database</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99f57q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99f57q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99f57q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f57q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99f57q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f57q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99f57q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f57q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99f57q:0" aria-labelledby="tab:R99f57q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mysql <span class="token punctuation">\</span>
  rename_database <span class="token punctuation">\</span>
  <span class="token assign-left variable">oldname</span><span class="token operator">=</span><span class="token string">'mydb'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">newname</span><span class="token operator">=</span><span class="token string">'newlyrenamed'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99f57q:1" aria-labelledby="tab:R99f57q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99f57q:2" aria-labelledby="tab:R99f57q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99f57q:3" aria-labelledby="tab:R99f57q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pf57q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pf57q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pf57q:0" aria-labelledby="tab:R9pf57q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;rename_database&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mysql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Database-Management/operation/repair_database" data-section-id="tag/Database-Management/operation/repair_database" class="sc-dntaoT ceciOs"><div data-section-id="operation/repair_database" id="operation/repair_database" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Database-Management/operation/repair_database" aria-label="tag/Database-Management/operation/repair_database"></a>Repair MySQL database tables </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function repairs all of the tables in a MySQL® database.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;MySQL/MariaDB role&lt;/a&gt;
&lt;strong&gt;and&lt;/strong&gt; remote MySQL is &lt;strong&gt;not&lt;/strong&gt; already configured, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function repairs all of the tables in a MySQL® database.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">MySQL/MariaDB role</a>
<strong>and</strong> remote MySQL is <strong>not</strong> already configured, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">name</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=example_db</span></div><div><div html="&lt;p&gt;The database&amp;#39;s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database&#39;s name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mysql/repair_database</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mysql/repair_database</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99h57q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99h57q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99h57q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h57q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99h57q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h57q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99h57q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h57q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99h57q:0" aria-labelledby="tab:R99h57q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mysql <span class="token punctuation">\</span>
  repair_database <span class="token punctuation">\</span>
  <span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'example_db'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h57q:1" aria-labelledby="tab:R99h57q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h57q:2" aria-labelledby="tab:R99h57q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h57q:3" aria-labelledby="tab:R99h57q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9ph57q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9ph57q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9ph57q:0" aria-labelledby="tab:R9ph57q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;repair_database&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mysql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"msg_text"</span>: <span class="token string">&quot;OK&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"msg_type"</span>: <span class="token string">&quot;status&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"table"</span>: <span class="token string">&quot;table1&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Database-Management/operation/setup_db_and_user" data-section-id="tag/Database-Management/operation/setup_db_and_user" class="sc-dntaoT ceciOs"><div data-section-id="operation/setup_db_and_user" id="operation/setup_db_and_user" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Database-Management/operation/setup_db_and_user" aria-label="tag/Database-Management/operation/setup_db_and_user"></a>Create a randomly named MySQL username/database set. </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function creates a randomly named MySQL® database and user. This allows a 3rdparty tool to create its own DB without needing any knowledge of cPanel internals such as quotas or other limits. These will simply be passed back as an error.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;MySQL/MariaDB role&lt;/a&gt; &lt;strong&gt;and&lt;/strong&gt; remote MySQL is &lt;strong&gt;not&lt;/strong&gt; already configured, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a randomly named MySQL® database and user. This allows a 3rdparty tool to create its own DB without needing any knowledge of cPanel internals such as quotas or other limits. These will simply be passed back as an error.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles">MySQL/MariaDB role</a> <strong>and</strong> remote MySQL is <strong>not</strong> already configured, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="prefix" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">prefix</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">prefix=wp</span></div><div><div html="&lt;p&gt;An optional string to prepend to the randomly generated database name. This is in addition to the cPanel user which will appear prior to this. The prefix should be 6 characters or less and be only alphanumeric characters. WARNING: longer prexies lead to less entropy in the random username. Keep it short if you can!&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An optional string to prepend to the randomly generated database name. This is in addition to the cPanel user which will appear prior to this. The prefix should be 6 characters or less and be only alphanumeric characters. WARNING: longer prexies lead to less entropy in the random username. Keep it short if you can!</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mysql/setup_db_and_user</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mysql/setup_db_and_user</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99j57q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99j57q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99j57q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99j57q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99j57q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99j57q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99j57q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99j57q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99j57q:0" aria-labelledby="tab:R99j57q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mysql <span class="token punctuation">\</span>
  setup_db_and_user <span class="token punctuation">\</span>
  <span class="token assign-left variable">prefix</span><span class="token operator">=</span><span class="token string">'wp'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99j57q:1" aria-labelledby="tab:R99j57q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99j57q:2" aria-labelledby="tab:R99j57q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99j57q:3" aria-labelledby="tab:R99j57q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pj57q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pj57q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pj57q:0" aria-labelledby="tab:R9pj57q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;setup_db_and_user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mysql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"database"</span>: <span class="token string">&quot;cpuser_wp_gwl7vpix28owo855yjomc7rsghkbjv0d0kf45kcvzip9tyxw9kdd&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"database_user"</span>: <span class="token string">&quot;cpuser_wp_dji1jdt7nhjiwjcjju45&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"database_user_password"</span>: <span class="token string">&quot;;1t/U:wnFkCRL9q68]/+&lt;TX=.C#7]n&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hostname"</span>: <span class="token string">&quot;localhost&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"port"</span>: <span class="token number">3306</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Remote-Databases" data-section-id="tag/Remote-Databases" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Remote-Databases" aria-label="tag/Remote-Databases"></a>Remote Databases</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;MySQL and MariaDB / Remote Databases&lt;/p&gt;
"><p>MySQL and MariaDB / Remote Databases</p>
</div></div></div><div id="tag/Remote-Databases/operation/Mysql-add_host_note" data-section-id="tag/Remote-Databases/operation/Mysql-add_host_note" class="sc-dntaoT ceciOs"><div data-section-id="operation/Mysql-add_host_note" id="operation/Mysql-add_host_note" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Remote-Databases/operation/Mysql-add_host_note" aria-label="tag/Remote-Databases/operation/Mysql-add_host_note"></a>Add remote MySQL host note </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function adds a note about a remote MySQL® server.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;If you attempt to add a note to an unauthorized remote MySQL server, the function will fail.&lt;/li&gt;
&lt;li&gt;When you &lt;strong&gt;disable&lt;/strong&gt; the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;MySQL role&lt;/a&gt;, the system disables this function.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function adds a note about a remote MySQL® server.</p>
<p><strong>Important:</strong></p>
<ul>
<li>If you attempt to add a note to an unauthorized remote MySQL server, the function will fail.</li>
<li>When you <strong>disable</strong> the <a href="https://go.cpanel.net/serverroles">MySQL role</a>, the system disables this function.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="host" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand host"><span class="property-name">host</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or string or string or string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">host=192.168.1.6</span></div><div><div html="&lt;p&gt;The remote MySQL server&amp;#39;s hostname or IP address.&lt;/p&gt;
&lt;p&gt;You may use the following IP address formats:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;192.168.1.6&lt;/code&gt; — IP address.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;192.168.%.%&lt;/code&gt; — Range with the percent (%) symbol as a wildcard.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;192.168.0.0/16&lt;/code&gt; — Range in CIDR format.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The remote MySQL server&#39;s hostname or IP address.</p>
<p>You may use the following IP address formats:</p>
<ul>
<li><code>192.168.1.6</code> — IP address.</li>
<li><code>192.168.%.%</code> — Range with the percent (%) symbol as a wildcard.</li>
<li><code>192.168.0.0/16</code> — Range in CIDR format.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="note" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">note</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">note=A remote mysql server for storing my data</span></div><div><div html="&lt;p&gt;note that describes the remote MySQL server.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>note that describes the remote MySQL server.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mysql/add_host_note</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mysql/add_host_note</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kj77q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kj77q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kj77q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj77q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kj77q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj77q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kj77q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj77q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kj77q:0" aria-labelledby="tab:R4kj77q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mysql <span class="token punctuation">\</span>
  add_host_note <span class="token punctuation">\</span>
  <span class="token assign-left variable">host</span><span class="token operator">=</span><span class="token string">'192.168.1.6'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">note</span><span class="token operator">=</span><span class="token string">'A remote mysql server for storing my data'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj77q:1" aria-labelledby="tab:R4kj77q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj77q:2" aria-labelledby="tab:R4kj77q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj77q:3" aria-labelledby="tab:R4kj77q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sj77q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sj77q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sj77q:0" aria-labelledby="tab:R4sj77q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;add_host_note&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mysql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Remote-Databases/operation/add_host" data-section-id="tag/Remote-Databases/operation/add_host" class="sc-dntaoT ceciOs"><div data-section-id="operation/add_host" id="operation/add_host" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Remote-Databases/operation/add_host" aria-label="tag/Remote-Databases/operation/add_host"></a>Enable remote MySQL host access </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function authorizes a remote MySQL® host to access the account&amp;#39;s databases.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;MySQL role&lt;/a&gt;
 and remote MySQL is &lt;strong&gt;not&lt;/strong&gt; already configured,
 the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function authorizes a remote MySQL® host to access the account&#39;s databases.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">MySQL role</a>
 and remote MySQL is <strong>not</strong> already configured,
 the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="host" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand host"><span class="property-name">host</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or string or string or string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">host=192.168.1.6</span></div><div><div html="&lt;p&gt;The remote MySQL server&amp;#39;s hostname or IP address.&lt;/p&gt;
&lt;p&gt;You may use the following IP address formats:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;192.168.1.6&lt;/code&gt; — IP address.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;192.168.%.%&lt;/code&gt; — Range with the percent (%) symbol as a wildcard.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;192.168.0.0/16&lt;/code&gt; — Range in CIDR format.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The remote MySQL server&#39;s hostname or IP address.</p>
<p>You may use the following IP address formats:</p>
<ul>
<li><code>192.168.1.6</code> — IP address.</li>
<li><code>192.168.%.%</code> — Range with the percent (%) symbol as a wildcard.</li>
<li><code>192.168.0.0/16</code> — Range in CIDR format.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mysql/add_host</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mysql/add_host</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kl77q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kl77q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kl77q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl77q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kl77q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl77q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kl77q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl77q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kl77q:0" aria-labelledby="tab:R4kl77q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mysql <span class="token punctuation">\</span>
  add_host <span class="token punctuation">\</span>
  <span class="token assign-left variable">host</span><span class="token operator">=</span><span class="token string">'192.168.1.6'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl77q:1" aria-labelledby="tab:R4kl77q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl77q:2" aria-labelledby="tab:R4kl77q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl77q:3" aria-labelledby="tab:R4kl77q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sl77q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sl77q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sl77q:0" aria-labelledby="tab:R4sl77q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;add_host&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mysql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Remote-Databases/operation/get_host_notes" data-section-id="tag/Remote-Databases/operation/get_host_notes" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_host_notes" id="operation/get_host_notes" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Remote-Databases/operation/get_host_notes" aria-label="tag/Remote-Databases/operation/get_host_notes"></a>Return remote MySQL host notes </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the notes associated with the account&amp;#39;s remote MySQL® hosts.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;MySQL/MariaDB&lt;/em&gt; role&lt;/a&gt;
  &lt;strong&gt;and&lt;/strong&gt; remote MySQL is &lt;strong&gt;not&lt;/strong&gt; already configured, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the notes associated with the account&#39;s remote MySQL® hosts.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>MySQL/MariaDB</em> role</a>
  <strong>and</strong> remote MySQL is <strong>not</strong> already configured, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mysql/get_host_notes</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mysql/get_host_notes</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kn77q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kn77q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kn77q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn77q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kn77q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn77q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kn77q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn77q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kn77q:0" aria-labelledby="tab:R4kn77q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mysql <span class="token punctuation">\</span>
  get_host_notes
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn77q:1" aria-labelledby="tab:R4kn77q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn77q:2" aria-labelledby="tab:R4kn77q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn77q:3" aria-labelledby="tab:R4kn77q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sn77q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sn77q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sn77q:0" aria-labelledby="tab:R4sn77q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_host_notes&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mysql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"1.2.3.45"</span>: <span class="token string">&quot;The combination on my luggage&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"12.34.56.78"</span>: <span class="token string">&quot;Located somewhere in the Ford Galaxy&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"8.8.8.8"</span>: <span class="token string">&quot;Located on Spaceball 1&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Remote-Databases/operation/delete_host" data-section-id="tag/Remote-Databases/operation/delete_host" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete_host" id="operation/delete_host" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Remote-Databases/operation/delete_host" aria-label="tag/Remote-Databases/operation/delete_host"></a>Disable remote MySQL host access </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function removes a remote MySQL® host&amp;#39;s access to the account&amp;#39;s databases.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;MySQL role&lt;/a&gt; and remote MySQL is not already configured, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes a remote MySQL® host&#39;s access to the account&#39;s databases.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">MySQL role</a> and remote MySQL is not already configured, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="host" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">host</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">host=remote.example.com</span></div><div><div html="&lt;p&gt;The remote MySQL server&amp;#39;s hostname, IP Address, or IP address range.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;
You may use the following IP address formats:&lt;/p&gt;
&lt;p&gt;192.168.1.6 — IP address.
192.168.%.% — Range with the percent (%) symbol as a wildcard.
192.168.0.0/16 — Range in CIDR format.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The remote MySQL server&#39;s hostname, IP Address, or IP address range.</p>
<p><strong>Note:</strong>
You may use the following IP address formats:</p>
<p>192.168.1.6 — IP address.
192.168.%.% — Range with the percent (%) symbol as a wildcard.
192.168.0.0/16 — Range in CIDR format.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mysql/delete_host</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mysql/delete_host</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kp77q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kp77q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kp77q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp77q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kp77q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp77q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kp77q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp77q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kp77q:0" aria-labelledby="tab:R4kp77q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mysql <span class="token punctuation">\</span>
  delete_host <span class="token punctuation">\</span>
  <span class="token assign-left variable">host</span><span class="token operator">=</span><span class="token string">'remote.example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp77q:1" aria-labelledby="tab:R4kp77q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp77q:2" aria-labelledby="tab:R4kp77q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp77q:3" aria-labelledby="tab:R4kp77q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sp77q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sp77q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sp77q:0" aria-labelledby="tab:R4sp77q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;delete_host&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mysql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/User-Management" data-section-id="tag/User-Management" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/User-Management" aria-label="tag/User-Management"></a>User Management</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;MySQL and MariaDB / User Management&lt;/p&gt;
"><p>MySQL and MariaDB / User Management</p>
</div></div></div><div id="tag/User-Management/operation/Mysql-create_user" data-section-id="tag/User-Management/operation/Mysql-create_user" class="sc-dntaoT ceciOs"><div data-section-id="operation/Mysql-create_user" id="operation/Mysql-create_user" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/User-Management/operation/Mysql-create_user" aria-label="tag/User-Management/operation/Mysql-create_user"></a>Create MySQL user </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function creates a MySQL® database user.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you &lt;strong&gt;disable&lt;/strong&gt; the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;MySQL role&lt;/a&gt; and remote MySQL is not already configured, the system disables this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a MySQL® database user.</p>
<p><strong>Important:</strong></p>
<p>When you <strong>disable</strong> the <a href="https://go.cpanel.net/serverroles">MySQL role</a> and remote MySQL is not already configured, the system disables this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">name</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=dbuser</span></div><div><div html="&lt;p&gt;A valid database username.&lt;/p&gt;
&lt;h1 id=&quot;important&quot;&gt;Important:&lt;/h1&gt;
&lt;p&gt;To learn more about database username limits, check your database type:&lt;/p&gt;
&lt;h2 id=&quot;mysql-56&quot;&gt;MySQL 5.6&lt;/h2&gt;
&lt;p&gt;MySQL version 5.6 limits the database username to 16 characters. The server uses the first nine characters of this limit for the database prefix. The database prefix uses the cPanel account&amp;#39;s username and an underscore (&lt;code&gt;_&lt;/code&gt;). The server only applies the first eight characters of the cPanel account&amp;#39;s username.&lt;/p&gt;
&lt;p&gt;For example:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;A &lt;code&gt;db_&lt;/code&gt; database prefix allows MySQL usernames of up to 13 characters.&lt;/li&gt;
&lt;li&gt;An &lt;code&gt;example_&lt;/code&gt; database prefix allows MySQL usernames of up to eight characters.&lt;/li&gt;
&lt;/ul&gt;
&lt;h2 id=&quot;mysql-57&quot;&gt;MySQL 5.7+&lt;/h2&gt;
&lt;p&gt;MySQL versions 5.7 and later limit the database username to 32 characters. The server uses the first nine characters of this limit for the database prefix. The database prefix uses the cPanel account&amp;#39;s username and an underscore (&lt;code&gt;_&lt;/code&gt;). The server only applies the first eight characters of the cPanel account&amp;#39;s username.&lt;/p&gt;
&lt;p&gt;For example:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;A &lt;code&gt;db_&lt;/code&gt; database prefix allows MySQL usernames of up to 29 characters.&lt;/li&gt;
&lt;li&gt;An &lt;code&gt;example_&lt;/code&gt; database prefix allows MySQL usernames of up to 24 characters.&lt;/li&gt;
&lt;/ul&gt;
&lt;h2 id=&quot;mariadb&quot;&gt;MariaDB&lt;/h2&gt;
&lt;p&gt;MariaDB limits the database username to 47 characters. The server uses the first nine characters of this limit for the database prefix. The database prefix uses the cPanel account&amp;#39;s username and an underscore (&lt;code&gt;_&lt;/code&gt;). The server only applies the first eight characters of the cPanel account&amp;#39;s username.&lt;/p&gt;
&lt;p&gt;For example:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;A &lt;code&gt;db_&lt;/code&gt; database prefix allows MariaDB usernames of up to 44 characters.&lt;/li&gt;
&lt;li&gt;An &lt;code&gt;example_&lt;/code&gt; database prefix allows MariaDB usernames of up to 39 characters.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A valid database username.</p>
<h1 id="important">Important:</h1>
<p>To learn more about database username limits, check your database type:</p>
<h2 id="mysql-56">MySQL 5.6</h2>
<p>MySQL version 5.6 limits the database username to 16 characters. The server uses the first nine characters of this limit for the database prefix. The database prefix uses the cPanel account&#39;s username and an underscore (<code>_</code>). The server only applies the first eight characters of the cPanel account&#39;s username.</p>
<p>For example:</p>
<ul>
<li>A <code>db_</code> database prefix allows MySQL usernames of up to 13 characters.</li>
<li>An <code>example_</code> database prefix allows MySQL usernames of up to eight characters.</li>
</ul>
<h2 id="mysql-57">MySQL 5.7+</h2>
<p>MySQL versions 5.7 and later limit the database username to 32 characters. The server uses the first nine characters of this limit for the database prefix. The database prefix uses the cPanel account&#39;s username and an underscore (<code>_</code>). The server only applies the first eight characters of the cPanel account&#39;s username.</p>
<p>For example:</p>
<ul>
<li>A <code>db_</code> database prefix allows MySQL usernames of up to 29 characters.</li>
<li>An <code>example_</code> database prefix allows MySQL usernames of up to 24 characters.</li>
</ul>
<h2 id="mariadb">MariaDB</h2>
<p>MariaDB limits the database username to 47 characters. The server uses the first nine characters of this limit for the database prefix. The database prefix uses the cPanel account&#39;s username and an underscore (<code>_</code>). The server only applies the first eight characters of the cPanel account&#39;s username.</p>
<p>For example:</p>
<ul>
<li>A <code>db_</code> database prefix allows MariaDB usernames of up to 44 characters.</li>
<li>An <code>example_</code> database prefix allows MariaDB usernames of up to 39 characters.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="password" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">password</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">password=12345luggage</span></div><div><div html="&lt;p&gt;The new user&amp;#39;s password.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new user&#39;s password.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="prefix-size" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">prefix-size</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">16</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">8</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">16</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">prefix-size=16</span></div><div><div html="&lt;p&gt;The desired prefix size.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The desired prefix size.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mysql/create_user</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mysql/create_user</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99397q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99397q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99397q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99397q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99397q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99397q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99397q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99397q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99397q:0" aria-labelledby="tab:R99397q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mysql <span class="token punctuation">\</span>
  create_user <span class="token punctuation">\</span>
  <span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'dbuser'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">password</span><span class="token operator">=</span><span class="token string">'12345luggage'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99397q:1" aria-labelledby="tab:R99397q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99397q:2" aria-labelledby="tab:R99397q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99397q:3" aria-labelledby="tab:R99397q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p397q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p397q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p397q:0" aria-labelledby="tab:R9p397q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;create_user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mysql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/User-Management/operation/Mysql::delete_user" data-section-id="tag/User-Management/operation/Mysql::delete_user" class="sc-dntaoT ceciOs"><div data-section-id="operation/Mysql::delete_user" id="operation/Mysql::delete_user" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/User-Management/operation/Mysql::delete_user" aria-label="tag/User-Management/operation/Mysql::delete_user"></a>Delete MySQL user </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function deletes a MySQL® user.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;MySQL role&lt;/a&gt; and remote MySQL is not already configured, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes a MySQL® user.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">MySQL role</a> and remote MySQL is not already configured, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">name</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=example</span></div><div><div html="&lt;p&gt;The MySQL user&amp;#39;s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The MySQL user&#39;s name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mysql/delete_user</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mysql/delete_user</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99597q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99597q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99597q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99597q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99597q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99597q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99597q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99597q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99597q:0" aria-labelledby="tab:R99597q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mysql <span class="token punctuation">\</span>
  delete_user <span class="token punctuation">\</span>
  <span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'example'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99597q:1" aria-labelledby="tab:R99597q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99597q:2" aria-labelledby="tab:R99597q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99597q:3" aria-labelledby="tab:R99597q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p597q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p597q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p597q:0" aria-labelledby="tab:R9p597q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;delete_user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mysql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/User-Management/operation/get_restrictions" data-section-id="tag/User-Management/operation/get_restrictions" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_restrictions" id="operation/get_restrictions" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/User-Management/operation/get_restrictions" aria-label="tag/User-Management/operation/get_restrictions"></a>Return MySQL name length restrictions </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists a MySQL® database&amp;#39;s name, username length restrictions, and database prefix.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;MySQL/MariaDB&lt;/em&gt; role&lt;/a&gt;
  &lt;strong&gt;and&lt;/strong&gt; remote MySQL is &lt;strong&gt;not&lt;/strong&gt; already configured, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists a MySQL® database&#39;s name, username length restrictions, and database prefix.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>MySQL/MariaDB</em> role</a>
  <strong>and</strong> remote MySQL is <strong>not</strong> already configured, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mysql/get_restrictions</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mysql/get_restrictions</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99797q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99797q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99797q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99797q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99797q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99797q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99797q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99797q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99797q:0" aria-labelledby="tab:R99797q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mysql <span class="token punctuation">\</span>
  get_restrictions
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99797q:1" aria-labelledby="tab:R99797q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99797q:2" aria-labelledby="tab:R99797q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99797q:3" aria-labelledby="tab:R99797q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p797q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p797q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p797q:0" aria-labelledby="tab:R9p797q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_restrictions&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mysql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"max_database_name_length"</span>: <span class="token number">64</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_username_length"</span>: <span class="token number">16</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"prefix"</span>: <span class="token string">&quot;user_&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/User-Management/operation/list_routines" data-section-id="tag/User-Management/operation/list_routines" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_routines" id="operation/list_routines" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/User-Management/operation/list_routines" aria-label="tag/User-Management/operation/list_routines"></a>Return MySQL user routines </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns a database user&amp;#39;s MySQL® routines.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;MySQL/MariaDB role&lt;/a&gt; &lt;strong&gt;and&lt;/strong&gt;
  remote MySQL is &lt;strong&gt;not&lt;/strong&gt; configured, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns a database user&#39;s MySQL® routines.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">MySQL/MariaDB role</a> <strong>and</strong>
  remote MySQL is <strong>not</strong> configured, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="database_user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">database_user</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">database_user=db_user</span></div><div><div html="&lt;p&gt;The database user for whom to return MySQL routines. If you don&amp;#39;t specify a database user, this function returns the MySQL routines for all database users.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database user for whom to return MySQL routines. If you don&#39;t specify a database user, this function returns the MySQL routines for all database users.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mysql/list_routines</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mysql/list_routines</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99997q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99997q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99997q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99997q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99997q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99997q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99997q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99997q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99997q:0" aria-labelledby="tab:R99997q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mysql <span class="token punctuation">\</span>
  list_routines
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99997q:1" aria-labelledby="tab:R99997q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99997q:2" aria-labelledby="tab:R99997q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99997q:3" aria-labelledby="tab:R99997q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p997q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p997q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p997q:0" aria-labelledby="tab:R9p997q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_routines&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mysql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;cptest_newdb.hello&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;cptest_newdb.my_routine&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/User-Management/operation/Mysql-list_users" data-section-id="tag/User-Management/operation/Mysql-list_users" class="sc-dntaoT ceciOs"><div data-section-id="operation/Mysql-list_users" id="operation/Mysql-list_users" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/User-Management/operation/Mysql-list_users" aria-label="tag/User-Management/operation/Mysql-list_users"></a>Return MySQL users </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists an account&amp;#39;s MySQL® database users.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;MySQL/MariaDB role&lt;/a&gt; &lt;strong&gt;and&lt;/strong&gt;
  remote MySQL is &lt;strong&gt;not&lt;/strong&gt; configured, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists an account&#39;s MySQL® database users.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">MySQL/MariaDB role</a> <strong>and</strong>
  remote MySQL is <strong>not</strong> configured, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mysql/list_users</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mysql/list_users</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99b97q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99b97q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99b97q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b97q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99b97q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b97q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99b97q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b97q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99b97q:0" aria-labelledby="tab:R99b97q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mysql <span class="token punctuation">\</span>
  list_users
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b97q:1" aria-labelledby="tab:R99b97q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b97q:2" aria-labelledby="tab:R99b97q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b97q:3" aria-labelledby="tab:R99b97q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pb97q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pb97q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pb97q:0" aria-labelledby="tab:R9pb97q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_users&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mysql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"databases"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;user_database1&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;user_database2&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"shortuser"</span>: <span class="token string">&quot;user1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">&quot;example_user1&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/User-Management/operation/rename_user" data-section-id="tag/User-Management/operation/rename_user" class="sc-dntaoT ceciOs"><div data-section-id="operation/rename_user" id="operation/rename_user" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/User-Management/operation/rename_user" aria-label="tag/User-Management/operation/rename_user"></a>Update MySQL username </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function renames a MySQL® database user.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;MySQL role&lt;/a&gt;
 and remote MySQL is &lt;strong&gt;not&lt;/strong&gt; already configured,
 the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function renames a MySQL® database user.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">MySQL role</a>
 and remote MySQL is <strong>not</strong> already configured,
 the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="newname" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">newname</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">newname=mynewusername</span></div><div><div html="&lt;p&gt;The user&amp;#39;s new name.&lt;/p&gt;
&lt;h1 id=&quot;important&quot;&gt;Important:&lt;/h1&gt;
&lt;p&gt;To learn more about database username limits, check your database type:&lt;/p&gt;
&lt;h2 id=&quot;mysql-56&quot;&gt;MySQL 5.6&lt;/h2&gt;
&lt;p&gt;MySQL version 5.6 limits the database username to 16 characters. The server uses the first nine characters of this limit for the database prefix. The database prefix uses the cPanel account&amp;#39;s username and an underscore (&lt;code&gt;_&lt;/code&gt;). The server only applies the first eight characters of the cPanel account&amp;#39;s username.&lt;/p&gt;
&lt;p&gt;For example:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;A &lt;code&gt;db_&lt;/code&gt; database prefix allows MySQL usernames of up to 13 characters.&lt;/li&gt;
&lt;li&gt;An &lt;code&gt;example_&lt;/code&gt; database prefix allows MySQL usernames of up to eight characters.&lt;/li&gt;
&lt;/ul&gt;
&lt;h2 id=&quot;mysql-57&quot;&gt;MySQL 5.7+&lt;/h2&gt;
&lt;p&gt;MySQL versions 5.7 and later limit the database username to 32 characters. The server uses the first nine characters of this limit for the database prefix. The database prefix uses the cPanel account&amp;#39;s username and an underscore (&lt;code&gt;_&lt;/code&gt;). The server only applies the first eight characters of the cPanel account&amp;#39;s username.&lt;/p&gt;
&lt;p&gt;For example:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;A &lt;code&gt;db_&lt;/code&gt; database prefix allows MySQL usernames of up to 29 characters.&lt;/li&gt;
&lt;li&gt;An &lt;code&gt;example_&lt;/code&gt; database prefix allows MySQL usernames of up to 24 characters.&lt;/li&gt;
&lt;/ul&gt;
&lt;h2 id=&quot;mariadb&quot;&gt;MariaDB&lt;/h2&gt;
&lt;p&gt;MariaDB limits the database username to 47 characters. The server uses the first nine characters of this limit for the database prefix. The database prefix uses the cPanel account&amp;#39;s username and an underscore (&lt;code&gt;_&lt;/code&gt;). The server only applies the first eight characters of the cPanel account&amp;#39;s username.&lt;/p&gt;
&lt;p&gt;For example:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;A &lt;code&gt;db_&lt;/code&gt; database prefix allows MariaDB usernames of up to 44 characters.&lt;/li&gt;
&lt;li&gt;An &lt;code&gt;example_&lt;/code&gt; database prefix allows MariaDB usernames of up to 39 characters.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user&#39;s new name.</p>
<h1 id="important">Important:</h1>
<p>To learn more about database username limits, check your database type:</p>
<h2 id="mysql-56">MySQL 5.6</h2>
<p>MySQL version 5.6 limits the database username to 16 characters. The server uses the first nine characters of this limit for the database prefix. The database prefix uses the cPanel account&#39;s username and an underscore (<code>_</code>). The server only applies the first eight characters of the cPanel account&#39;s username.</p>
<p>For example:</p>
<ul>
<li>A <code>db_</code> database prefix allows MySQL usernames of up to 13 characters.</li>
<li>An <code>example_</code> database prefix allows MySQL usernames of up to eight characters.</li>
</ul>
<h2 id="mysql-57">MySQL 5.7+</h2>
<p>MySQL versions 5.7 and later limit the database username to 32 characters. The server uses the first nine characters of this limit for the database prefix. The database prefix uses the cPanel account&#39;s username and an underscore (<code>_</code>). The server only applies the first eight characters of the cPanel account&#39;s username.</p>
<p>For example:</p>
<ul>
<li>A <code>db_</code> database prefix allows MySQL usernames of up to 29 characters.</li>
<li>An <code>example_</code> database prefix allows MySQL usernames of up to 24 characters.</li>
</ul>
<h2 id="mariadb">MariaDB</h2>
<p>MariaDB limits the database username to 47 characters. The server uses the first nine characters of this limit for the database prefix. The database prefix uses the cPanel account&#39;s username and an underscore (<code>_</code>). The server only applies the first eight characters of the cPanel account&#39;s username.</p>
<p>For example:</p>
<ul>
<li>A <code>db_</code> database prefix allows MariaDB usernames of up to 44 characters.</li>
<li>An <code>example_</code> database prefix allows MariaDB usernames of up to 39 characters.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="oldname" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">oldname</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">oldname=dbuser</span></div><div><div html="&lt;p&gt;The user&amp;#39;s current name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user&#39;s current name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mysql/rename_user</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mysql/rename_user</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99d97q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99d97q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99d97q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d97q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99d97q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d97q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99d97q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d97q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99d97q:0" aria-labelledby="tab:R99d97q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mysql <span class="token punctuation">\</span>
  rename_user <span class="token punctuation">\</span>
  <span class="token assign-left variable">oldname</span><span class="token operator">=</span><span class="token string">'dbuser'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">newname</span><span class="token operator">=</span><span class="token string">'mynewusername'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99d97q:1" aria-labelledby="tab:R99d97q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99d97q:2" aria-labelledby="tab:R99d97q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99d97q:3" aria-labelledby="tab:R99d97q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pd97q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pd97q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pd97q:0" aria-labelledby="tab:R9pd97q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;rename_user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mysql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/User-Management/operation/Mysql-get_privileges_on_database" data-section-id="tag/User-Management/operation/Mysql-get_privileges_on_database" class="sc-dntaoT ceciOs"><div data-section-id="operation/Mysql-get_privileges_on_database" id="operation/Mysql-get_privileges_on_database" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/User-Management/operation/Mysql-get_privileges_on_database" aria-label="tag/User-Management/operation/Mysql-get_privileges_on_database"></a>Return MySQL user privileges </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists a MySQL® database user&amp;#39;s privileges.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;MySQL role&lt;/a&gt;
and remote MySQL is not already configured, the system disables this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists a MySQL® database user&#39;s privileges.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">MySQL role</a>
and remote MySQL is not already configured, the system disables this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="database" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">database</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">database=mydb</span></div><div><div html="&lt;p&gt;The database name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=dbuser</span></div><div><div html="&lt;p&gt;The database user&amp;#39;s name.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If database prefixing is enabled, you &lt;strong&gt;must&lt;/strong&gt; prefix this value with the account prefix and an underscore (&lt;code&gt;_&lt;/code&gt;).&lt;/p&gt;
&lt;p&gt;For example, for the &lt;code&gt;dbuser&lt;/code&gt; user on the &lt;code&gt;user&lt;/code&gt; cPanel account, pass in a value of &lt;code&gt;user_dbuser&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database user&#39;s name.</p>
<p><strong>Important:</strong></p>
<p>If database prefixing is enabled, you <strong>must</strong> prefix this value with the account prefix and an underscore (<code>_</code>).</p>
<p>For example, for the <code>dbuser</code> user on the <code>user</code> cPanel account, pass in a value of <code>user_dbuser</code>.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mysql/get_privileges_on_database</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mysql/get_privileges_on_database</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99f97q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99f97q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99f97q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f97q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99f97q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f97q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99f97q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f97q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99f97q:0" aria-labelledby="tab:R99f97q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mysql <span class="token punctuation">\</span>
  get_privileges_on_database <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'dbuser'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">database</span><span class="token operator">=</span><span class="token string">'mydb'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99f97q:1" aria-labelledby="tab:R99f97q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99f97q:2" aria-labelledby="tab:R99f97q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99f97q:3" aria-labelledby="tab:R99f97q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pf97q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pf97q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pf97q:0" aria-labelledby="tab:R9pf97q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_privileges_on_database&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mysql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;CREATE&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/User-Management/operation/revoke_access_to_database" data-section-id="tag/User-Management/operation/revoke_access_to_database" class="sc-dntaoT ceciOs"><div data-section-id="operation/revoke_access_to_database" id="operation/revoke_access_to_database" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/User-Management/operation/revoke_access_to_database" aria-label="tag/User-Management/operation/revoke_access_to_database"></a>Remove MySQL user privileges </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function revokes a MySQL® database user&amp;#39;s privileges.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;MySQL role&lt;/a&gt; &lt;strong&gt;and&lt;/strong&gt;
remote MySQL is &lt;strong&gt;not&lt;/strong&gt; already configured, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function revokes a MySQL® database user&#39;s privileges.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">MySQL role</a> <strong>and</strong>
remote MySQL is <strong>not</strong> already configured, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="database" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">database</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">database=mydb</span></div><div><div html="&lt;p&gt;The database&amp;#39;s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database&#39;s name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=dbuser</span></div><div><div html="&lt;p&gt;The database user&amp;#39;s name.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If database prefixing is enabled, you &lt;strong&gt;must&lt;/strong&gt; prefix this value with the account
prefix and an underscore (&lt;code&gt;_&lt;/code&gt;).&lt;/p&gt;
&lt;p&gt;For example, for the &lt;code&gt;dbuser&lt;/code&gt; user on the &lt;code&gt;user&lt;/code&gt; cPanel account, pass in a value
of &lt;code&gt;user_dbuser&lt;/code&gt;. &lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database user&#39;s name.</p>
<p><strong>Important:</strong></p>
<p>If database prefixing is enabled, you <strong>must</strong> prefix this value with the account
prefix and an underscore (<code>_</code>).</p>
<p>For example, for the <code>dbuser</code> user on the <code>user</code> cPanel account, pass in a value
of <code>user_dbuser</code>. </p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mysql/revoke_access_to_database</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mysql/revoke_access_to_database</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99h97q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99h97q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99h97q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h97q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99h97q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h97q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99h97q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h97q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99h97q:0" aria-labelledby="tab:R99h97q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mysql <span class="token punctuation">\</span>
  revoke_access_to_database <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'dbuser'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">database</span><span class="token operator">=</span><span class="token string">'mydb'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h97q:1" aria-labelledby="tab:R99h97q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h97q:2" aria-labelledby="tab:R99h97q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h97q:3" aria-labelledby="tab:R99h97q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9ph97q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9ph97q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9ph97q:0" aria-labelledby="tab:R9ph97q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;revoke_access_to_database&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mysql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/User-Management/operation/set_privileges_on_database" data-section-id="tag/User-Management/operation/set_privileges_on_database" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_privileges_on_database" id="operation/set_privileges_on_database" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/User-Management/operation/set_privileges_on_database" aria-label="tag/User-Management/operation/set_privileges_on_database"></a>Update MySQL user privileges </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function sets a MySQL® database user&amp;#39;s privileges.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;MySQL/MariaDB&lt;/em&gt; role&lt;/a&gt;, &lt;strong&gt;and&lt;/strong&gt; remote MySQL is &lt;strong&gt;not&lt;/strong&gt; already configured, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets a MySQL® database user&#39;s privileges.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles"><em>MySQL/MariaDB</em> role</a>, <strong>and</strong> remote MySQL is <strong>not</strong> already configured, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="database" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">database</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">database=cpuser_dbname</span></div><div><div html="&lt;p&gt;The database&amp;#39;s name.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If database prefixing is enabled, you &lt;strong&gt;must&lt;/strong&gt; prefix this value with the account prefix and an underscore (&lt;code&gt;_&lt;/code&gt;). For example, for the &lt;code&gt;db&lt;/code&gt; database on the &lt;code&gt;user&lt;/code&gt; cPanel account, pass in a value of &lt;code&gt;user_db&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database&#39;s name.</p>
<p><strong>Important:</strong></p>
<p>If database prefixing is enabled, you <strong>must</strong> prefix this value with the account prefix and an underscore (<code>_</code>). For example, for the <code>db</code> database on the <code>user</code> cPanel account, pass in a value of <code>user_db</code>.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="privileges" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">privileges</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">privileges=DELETE,UPDATE,CREATE,ALTER</span></div><div><div html="&lt;ul&gt;
&lt;li&gt;&lt;code&gt;ALL PRIVILEGES&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;A comma-separated list of one or more of the following individual privileges:&lt;ul&gt;
&lt;li&gt;&lt;code&gt;ALTER&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;ALTER ROUTINE&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;CREATE&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;CREATE ROUTINE&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;CREATE TEMPORARY TABLES&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;CREATE VIEW&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;DELETE&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;DROP&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;EVENT&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;EXECUTE&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;INDEX&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;INSERT&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;LOCK TABLES&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;REFERENCES&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;SELECT&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;SHOW VIEW&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;TRIGGER&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;UPDATE&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;This list replaces, rather than adds to, the existing privilege list.&lt;/li&gt;
&lt;li&gt;In browser-based and command line calls, separate multiple values with &lt;code&gt;%2C&lt;/code&gt; and replace spaces with &lt;code&gt;%20&lt;/code&gt;.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><ul>
<li><code>ALL PRIVILEGES</code></li>
<li>A comma-separated list of one or more of the following individual privileges:<ul>
<li><code>ALTER</code></li>
<li><code>ALTER ROUTINE</code></li>
<li><code>CREATE</code></li>
<li><code>CREATE ROUTINE</code></li>
<li><code>CREATE TEMPORARY TABLES</code></li>
<li><code>CREATE VIEW</code></li>
<li><code>DELETE</code></li>
<li><code>DROP</code></li>
<li><code>EVENT</code></li>
<li><code>EXECUTE</code></li>
<li><code>INDEX</code></li>
<li><code>INSERT</code></li>
<li><code>LOCK TABLES</code></li>
<li><code>REFERENCES</code></li>
<li><code>SELECT</code></li>
<li><code>SHOW VIEW</code></li>
<li><code>TRIGGER</code></li>
<li><code>UPDATE</code></li>
</ul>
</li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li>This list replaces, rather than adds to, the existing privilege list.</li>
<li>In browser-based and command line calls, separate multiple values with <code>%2C</code> and replace spaces with <code>%20</code>.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=cpuser_dbuser</span></div><div><div html="&lt;p&gt;The database user&amp;#39;s name.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If database prefixing is enabled, you &lt;strong&gt;must&lt;/strong&gt; prefix this value with the account prefix and an underscore (&lt;code&gt;_&lt;/code&gt;). For example, for the &lt;code&gt;dbuser&lt;/code&gt; user on the &lt;code&gt;user&lt;/code&gt; cPanel account, pass in a value of &lt;code&gt;user_dbuser&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database user&#39;s name.</p>
<p><strong>Important:</strong></p>
<p>If database prefixing is enabled, you <strong>must</strong> prefix this value with the account prefix and an underscore (<code>_</code>). For example, for the <code>dbuser</code> user on the <code>user</code> cPanel account, pass in a value of <code>user_dbuser</code>.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mysql/set_privileges_on_database</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mysql/set_privileges_on_database</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99j97q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99j97q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99j97q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99j97q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99j97q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99j97q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99j97q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99j97q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99j97q:0" aria-labelledby="tab:R99j97q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mysql <span class="token punctuation">\</span>
  set_privileges_on_database <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'cpuser_dbuser'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">database</span><span class="token operator">=</span><span class="token string">'cpuser_dbname'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99j97q:1" aria-labelledby="tab:R99j97q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99j97q:2" aria-labelledby="tab:R99j97q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99j97q:3" aria-labelledby="tab:R99j97q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pj97q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pj97q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pj97q:0" aria-labelledby="tab:R9pj97q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_privileges_on_database&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mysql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/User-Management/operation/Mysql-set_password" data-section-id="tag/User-Management/operation/Mysql-set_password" class="sc-dntaoT ceciOs"><div data-section-id="operation/Mysql-set_password" id="operation/Mysql-set_password" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/User-Management/operation/Mysql-set_password" aria-label="tag/User-Management/operation/Mysql-set_password"></a>Update MySQL user password </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function sets a MySQL® database user&amp;#39;s password.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;MySQL role&lt;/a&gt;
 and remote MySQL is &lt;strong&gt;not&lt;/strong&gt; already configured,
 the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets a MySQL® database user&#39;s password.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">MySQL role</a>
 and remote MySQL is <strong>not</strong> already configured,
 the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="password" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">password</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">password=12345luggage</span></div><div><div html="&lt;p&gt;The user&amp;#39;s new password.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user&#39;s new password.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=dbuser</span></div><div><div html="&lt;p&gt;The MySQL database user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The MySQL database user.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mysql/set_password</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mysql/set_password</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99l97q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99l97q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99l97q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99l97q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99l97q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99l97q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99l97q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99l97q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99l97q:0" aria-labelledby="tab:R99l97q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mysql <span class="token punctuation">\</span>
  set_password <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'dbuser'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">password</span><span class="token operator">=</span><span class="token string">'12345luggage'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99l97q:1" aria-labelledby="tab:R99l97q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99l97q:2" aria-labelledby="tab:R99l97q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99l97q:3" aria-labelledby="tab:R99l97q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pl97q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pl97q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pl97q:0" aria-labelledby="tab:R9pl97q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_password&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mysql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"failures"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"error"</span>: <span class="token string">&quot;string&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"host"</span>: <span class="token string">&quot;string&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Pushbullet" data-section-id="tag/Pushbullet" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Pushbullet" aria-label="tag/Pushbullet"></a>Pushbullet</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;The Pushbullet module for UAPI.&lt;/p&gt;
"><p>The Pushbullet module for UAPI.</p>
</div></div></div><div id="tag/Pushbullet/operation/send_test_message" data-section-id="tag/Pushbullet/operation/send_test_message" class="sc-dntaoT ceciOs"><div data-section-id="operation/send_test_message" id="operation/send_test_message" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Pushbullet/operation/send_test_message" aria-label="tag/Pushbullet/operation/send_test_message"></a>Validate Pushbullet token </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function sends a Pushbullet™ test message to determine that the token is valid and that the account holder can receive the message.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sends a Pushbullet™ test message to determine that the token is valid and that the account holder can receive the message.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="access_token" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">access_token</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">access_token=a1b2c3d4e5f6g7h8i9j0</span></div><div><div html="&lt;p&gt;The Pushbullet access token.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;Your Pushbullet token is available on
&lt;a href=&quot;https://www.pushbullet.com/account&quot;&gt;Pushbullet&amp;#39;s My Account&lt;/a&gt; page under
the &lt;em&gt;Access Token&lt;/em&gt; heading.&lt;/li&gt;
&lt;li&gt;This is confidential information that your server sends via a secure channel.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Pushbullet access token.</p>
<p><strong>Note:</strong></p>
<ul>
<li>Your Pushbullet token is available on
<a href="https://www.pushbullet.com/account">Pushbullet&#39;s My Account</a> page under
the <em>Access Token</em> heading.</li>
<li>This is confidential information that your server sends via a secure channel.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Pushbullet/send_test_message</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Pushbullet/send_test_message</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99r8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99r8a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99r8a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99r8a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99r8a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99r8a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99r8a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99r8a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99r8a:0" aria-labelledby="tab:R99r8a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Pushbullet <span class="token punctuation">\</span>
  send_test_message <span class="token punctuation">\</span>
  <span class="token assign-left variable">access_token</span><span class="token operator">=</span><span class="token string">'a1b2c3d4e5f6g7h8i9j0'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99r8a:1" aria-labelledby="tab:R99r8a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99r8a:2" aria-labelledby="tab:R99r8a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99r8a:3" aria-labelledby="tab:R99r8a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pr8a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pr8a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pr8a:0" aria-labelledby="tab:R9pr8a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;send_test_message&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Pushbullet&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"message_id"</span>: <span class="token string">&quot;554d2cbd-efe61da3cacb&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"payload"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"active"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"body"</span>: <span class="token string">&quot;This message confirms that “hostname.example.com“ (192.168.0.20)\ncan send a message to you via Pushbullet.\n\nThis message was sent on Monday, May 18, 2015 at 7:12:20 PM UTC.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token number">1431976341.38872</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"direction"</span>: <span class="token string">&quot;self&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dismissed"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"iden"</span>: <span class="token string">&quot;ujw5ScArtjUsjAeRXXMLGS&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modified"</span>: <span class="token number">1431976341.39182</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"receiver_email"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"receiver_email_normalized"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"receiver_iden"</span>: <span class="token string">&quot;ujw5ScArtjU&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sender_email"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sender_email_normalized"</span>: <span class="token string">&quot;user@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sender_iden"</span>: <span class="token string">&quot;ujw5ScArtjU&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sender_name"</span>: <span class="token string">&quot;Firstname Lastname&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"title"</span>: <span class="token string">&quot;Test message (ID: 555a3994-173a4a271062d)&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;note&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/NVData" data-section-id="tag/NVData" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/NVData" aria-label="tag/NVData"></a>NVData</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;The NVData module for UAPI.&lt;/p&gt;
"><p>The NVData module for UAPI.</p>
</div></div></div><div id="tag/Antivirus-Protection-(ClamAV)" data-section-id="tag/Antivirus-Protection-(ClamAV)" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Antivirus-Protection-(ClamAV)" aria-label="tag/Antivirus-Protection-(ClamAV)"></a>Antivirus Protection (ClamAV)</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Optional Applications / Antivirus Protection (ClamAV)&lt;/p&gt;
"><p>Optional Applications / Antivirus Protection (ClamAV)</p>
</div></div></div><div id="tag/Antivirus-Protection-(ClamAV)/operation/ClamScanner::get_scan_paths" data-section-id="tag/Antivirus-Protection-(ClamAV)/operation/ClamScanner::get_scan_paths" class="sc-dntaoT ceciOs"><div data-section-id="operation/ClamScanner::get_scan_paths" id="operation/ClamScanner::get_scan_paths" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Antivirus-Protection-(ClamAV)/operation/ClamScanner::get_scan_paths" aria-label="tag/Antivirus-Protection-(ClamAV)/operation/ClamScanner::get_scan_paths"></a>Return virus scan types </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function gets the available local paths that a cPanel account is permitted to scan.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note&lt;/strong&gt;:&lt;/p&gt;
&lt;p&gt;The system determines the available scan types based on what the system administrator has set in WHM&amp;#39;s &lt;a href=&quot;https://go.cpanel.net/configureclamavscanner&quot;&gt;Configure ClamAV®&lt;/a&gt; page.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note&lt;/strong&gt;:&lt;/p&gt;
&lt;p&gt;You must run the APIs in this order:&lt;/p&gt;
&lt;ol&gt;
&lt;li&gt;Run &lt;a href=&quot;https://go.cpanel.net/ClamScanner-start-scan&quot;&gt;&lt;code&gt;ClamScanner::start_scan&lt;/code&gt;&lt;/a&gt; to start the virus scan.&lt;/li&gt;
&lt;li&gt;Run &lt;a href=&quot;https://go.cpanel.net/ClamScanner-get-scan-status&quot;&gt;&lt;code&gt;ClamScanner::get_scan_status&lt;/code&gt;&lt;/a&gt; in a loop until the scan is finished.&lt;/li&gt;
&lt;li&gt;Run &lt;a href=&quot;https://go.cpanel.net/ClamScanner-list-infected-files&quot;&gt;&lt;code&gt;ClamScanner::list_infected_files&lt;/code&gt;&lt;/a&gt; to get a report of the complete list of infected files.&lt;/li&gt;
&lt;li&gt;Decide how you want to handle each infected file.&lt;/li&gt;
&lt;li&gt;Run &lt;a href=&quot;https://go.cpanel.net/ClamScanner-disinfect-files&quot;&gt;&lt;code&gt;ClamScanner::disinfect_files&lt;/code&gt;&lt;/a&gt; to queue the disinfection of the files.&lt;/li&gt;
&lt;li&gt;Run &lt;a href=&quot;https://go.cpanel.net/ClamScanner-check-disinfection-status&quot;&gt;&lt;code&gt;ClamScanner::check_disinfection_status&lt;/code&gt;&lt;/a&gt; in a loop until you get a done status.&lt;/li&gt;
&lt;/ol&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function gets the available local paths that a cPanel account is permitted to scan.</p>
<p><strong>Note</strong>:</p>
<p>The system determines the available scan types based on what the system administrator has set in WHM&#39;s <a href="https://go.cpanel.net/configureclamavscanner">Configure ClamAV®</a> page.</p>
<p><strong>Note</strong>:</p>
<p>You must run the APIs in this order:</p>
<ol>
<li>Run <a href="https://go.cpanel.net/ClamScanner-start-scan"><code>ClamScanner::start_scan</code></a> to start the virus scan.</li>
<li>Run <a href="https://go.cpanel.net/ClamScanner-get-scan-status"><code>ClamScanner::get_scan_status</code></a> in a loop until the scan is finished.</li>
<li>Run <a href="https://go.cpanel.net/ClamScanner-list-infected-files"><code>ClamScanner::list_infected_files</code></a> to get a report of the complete list of infected files.</li>
<li>Decide how you want to handle each infected file.</li>
<li>Run <a href="https://go.cpanel.net/ClamScanner-disinfect-files"><code>ClamScanner::disinfect_files</code></a> to queue the disinfection of the files.</li>
<li>Run <a href="https://go.cpanel.net/ClamScanner-check-disinfection-status"><code>ClamScanner::check_disinfection_status</code></a> in a loop until you get a done status.</li>
</ol>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/ClamScanner/get_scan_paths</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/ClamScanner/get_scan_paths</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kj39a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kj39a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kj39a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj39a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kj39a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj39a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kj39a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj39a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kj39a:0" aria-labelledby="tab:R4kj39a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  ClamScanner <span class="token punctuation">\</span>
  get_scan_paths
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj39a:1" aria-labelledby="tab:R4kj39a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj39a:2" aria-labelledby="tab:R4kj39a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj39a:3" aria-labelledby="tab:R4kj39a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sj39a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sj39a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sj39a:0" aria-labelledby="tab:R4sj39a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_scan_paths&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;ClamScanner&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;home&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">&quot;Scan Entire Home Directory&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Antivirus-Protection-(ClamAV)/operation/ClamScanner::start_scan" data-section-id="tag/Antivirus-Protection-(ClamAV)/operation/ClamScanner::start_scan" class="sc-dntaoT ceciOs"><div data-section-id="operation/ClamScanner::start_scan" id="operation/ClamScanner::start_scan" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Antivirus-Protection-(ClamAV)/operation/ClamScanner::start_scan" aria-label="tag/Antivirus-Protection-(ClamAV)/operation/ClamScanner::start_scan"></a>Start virus scan </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function starts a ClamAV® scan on a directory.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note&lt;/strong&gt;:&lt;/p&gt;
&lt;p&gt;You must run the APIs in this order:&lt;/p&gt;
&lt;ol&gt;
&lt;li&gt;Run &lt;a href=&quot;https://go.cpanel.net/ClamScanner-start-scan&quot;&gt;&lt;code&gt;ClamScanner::start_scan&lt;/code&gt;&lt;/a&gt; to start the virus scan.&lt;/li&gt;
&lt;li&gt;Run &lt;a href=&quot;https://go.cpanel.net/ClamScanner-get-scan-status&quot;&gt;&lt;code&gt;ClamScanner::get_scan_status&lt;/code&gt;&lt;/a&gt; in a loop until the scan is finished.&lt;/li&gt;
&lt;li&gt;Run &lt;a href=&quot;https://go.cpanel.net/ClamScanner-list-infected-files&quot;&gt;&lt;code&gt;ClamScanner::list_infected_files&lt;/code&gt;&lt;/a&gt; to get a report of the complete list of infected files.&lt;/li&gt;
&lt;li&gt;Decide how you want to handle each infected file.&lt;/li&gt;
&lt;li&gt;Run &lt;a href=&quot;https://go.cpanel.net/ClamScanner-disinfect-files&quot;&gt;&lt;code&gt;ClamScanner::disinfect_files&lt;/code&gt;&lt;/a&gt; to queue the disinfection of the files.&lt;/li&gt;
&lt;li&gt;Run &lt;a href=&quot;https://go.cpanel.net/ClamScanner-check-disinfection-status&quot;&gt;&lt;code&gt;ClamScanner::check_disinfection_status&lt;/code&gt;&lt;/a&gt; in a loop until you get a done status.&lt;/li&gt;
&lt;/ol&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function starts a ClamAV® scan on a directory.</p>
<p><strong>Note</strong>:</p>
<p>You must run the APIs in this order:</p>
<ol>
<li>Run <a href="https://go.cpanel.net/ClamScanner-start-scan"><code>ClamScanner::start_scan</code></a> to start the virus scan.</li>
<li>Run <a href="https://go.cpanel.net/ClamScanner-get-scan-status"><code>ClamScanner::get_scan_status</code></a> in a loop until the scan is finished.</li>
<li>Run <a href="https://go.cpanel.net/ClamScanner-list-infected-files"><code>ClamScanner::list_infected_files</code></a> to get a report of the complete list of infected files.</li>
<li>Decide how you want to handle each infected file.</li>
<li>Run <a href="https://go.cpanel.net/ClamScanner-disinfect-files"><code>ClamScanner::disinfect_files</code></a> to queue the disinfection of the files.</li>
<li>Run <a href="https://go.cpanel.net/ClamScanner-check-disinfection-status"><code>ClamScanner::check_disinfection_status</code></a> in a loop until you get a done status.</li>
</ol>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="scan_type" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">scan_type</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">any</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;home&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;mail&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;public_html&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;public_ftp&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">scan_type=home</span></div><div><div html="&lt;p&gt;The type of directory to scan.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;home&lt;/code&gt; — User&amp;#39;s entire home directory&lt;/li&gt;
&lt;li&gt;&lt;code&gt;mail&lt;/code&gt; — User&amp;#39;s email directory&lt;/li&gt;
&lt;li&gt;&lt;code&gt;public_html&lt;/code&gt; — User&amp;#39;s web directory&lt;/li&gt;
&lt;li&gt;&lt;code&gt;public_ftp&lt;/code&gt; — User&amp;#39;s ftp directory&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The type of directory to scan.</p>
<ul>
<li><code>home</code> — User&#39;s entire home directory</li>
<li><code>mail</code> — User&#39;s email directory</li>
<li><code>public_html</code> — User&#39;s web directory</li>
<li><code>public_ftp</code> — User&#39;s ftp directory</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/ClamScanner/start_scan</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/ClamScanner/start_scan</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kl39a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kl39a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kl39a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl39a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kl39a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl39a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kl39a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl39a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kl39a:0" aria-labelledby="tab:R4kl39a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  ClamScanner <span class="token punctuation">\</span>
  start_scan <span class="token punctuation">\</span>
  <span class="token assign-left variable">scan_type</span><span class="token operator">=</span><span class="token string">'home'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl39a:1" aria-labelledby="tab:R4kl39a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl39a:2" aria-labelledby="tab:R4kl39a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl39a:3" aria-labelledby="tab:R4kl39a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sl39a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sl39a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sl39a:0" aria-labelledby="tab:R4sl39a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;start_scan&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;ClamScanner&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Antivirus-Protection-(ClamAV)/operation/ClamScanner::list_infected_files" data-section-id="tag/Antivirus-Protection-(ClamAV)/operation/ClamScanner::list_infected_files" class="sc-dntaoT ceciOs"><div data-section-id="operation/ClamScanner::list_infected_files" id="operation/ClamScanner::list_infected_files" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Antivirus-Protection-(ClamAV)/operation/ClamScanner::list_infected_files" aria-label="tag/Antivirus-Protection-(ClamAV)/operation/ClamScanner::list_infected_files"></a>Return infected file list </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists infected files from a ClamAV® virus scan.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note&lt;/strong&gt;:&lt;/p&gt;
&lt;p&gt;You must run the APIs in this order:&lt;/p&gt;
&lt;ol&gt;
&lt;li&gt;Run &lt;a href=&quot;https://go.cpanel.net/ClamScanner-start-scan&quot;&gt;&lt;code&gt;ClamScanner::start_scan&lt;/code&gt;&lt;/a&gt; to start the virus scan.&lt;/li&gt;
&lt;li&gt;Run &lt;a href=&quot;https://go.cpanel.net/ClamScanner-get-scan-status&quot;&gt;&lt;code&gt;ClamScanner::get_scan_status&lt;/code&gt;&lt;/a&gt; in a loop until the scan is finished.&lt;/li&gt;
&lt;li&gt;Run &lt;a href=&quot;https://go.cpanel.net/ClamScanner-list-infected-files&quot;&gt;&lt;code&gt;ClamScanner::list_infected_files&lt;/code&gt;&lt;/a&gt; to get a report of the complete list of infected files.&lt;/li&gt;
&lt;li&gt;Decide how you want to handle each infected file.&lt;/li&gt;
&lt;li&gt;Run &lt;a href=&quot;https://go.cpanel.net/ClamScanner-disinfect-files&quot;&gt;&lt;code&gt;ClamScanner::disinfect_files&lt;/code&gt;&lt;/a&gt; to queue the disinfection of the files.&lt;/li&gt;
&lt;li&gt;Run &lt;a href=&quot;https://go.cpanel.net/ClamScanner-check-disinfection-status&quot;&gt;&lt;code&gt;ClamScanner::check_disinfection_status&lt;/code&gt;&lt;/a&gt; in a loop until you get a done status.&lt;/li&gt;
&lt;/ol&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists infected files from a ClamAV® virus scan.</p>
<p><strong>Note</strong>:</p>
<p>You must run the APIs in this order:</p>
<ol>
<li>Run <a href="https://go.cpanel.net/ClamScanner-start-scan"><code>ClamScanner::start_scan</code></a> to start the virus scan.</li>
<li>Run <a href="https://go.cpanel.net/ClamScanner-get-scan-status"><code>ClamScanner::get_scan_status</code></a> in a loop until the scan is finished.</li>
<li>Run <a href="https://go.cpanel.net/ClamScanner-list-infected-files"><code>ClamScanner::list_infected_files</code></a> to get a report of the complete list of infected files.</li>
<li>Decide how you want to handle each infected file.</li>
<li>Run <a href="https://go.cpanel.net/ClamScanner-disinfect-files"><code>ClamScanner::disinfect_files</code></a> to queue the disinfection of the files.</li>
<li>Run <a href="https://go.cpanel.net/ClamScanner-check-disinfection-status"><code>ClamScanner::check_disinfection_status</code></a> in a loop until you get a done status.</li>
</ol>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/ClamScanner/list_infected_files</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/ClamScanner/list_infected_files</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kn39a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kn39a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kn39a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn39a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kn39a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn39a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kn39a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn39a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kn39a:0" aria-labelledby="tab:R4kn39a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  ClamScanner <span class="token punctuation">\</span>
  list_infected_files
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn39a:1" aria-labelledby="tab:R4kn39a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn39a:2" aria-labelledby="tab:R4kn39a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn39a:3" aria-labelledby="tab:R4kn39a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sn39a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sn39a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sn39a:0" aria-labelledby="tab:R4sn39a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_infected_files&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;ClamScanner&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"file"</span>: <span class="token string">&quot;/home/username/infected_file.txt&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"virus_type"</span>: <span class="token string">&quot;Eicar-Signature&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Antivirus-Protection-(ClamAV)/operation/ClamScanner::get_scan_status" data-section-id="tag/Antivirus-Protection-(ClamAV)/operation/ClamScanner::get_scan_status" class="sc-dntaoT ceciOs"><div data-section-id="operation/ClamScanner::get_scan_status" id="operation/ClamScanner::get_scan_status" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Antivirus-Protection-(ClamAV)/operation/ClamScanner::get_scan_status" aria-label="tag/Antivirus-Protection-(ClamAV)/operation/ClamScanner::get_scan_status"></a>Request virus scan status </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function gets the status of a ClamAV® scan on a directory.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note&lt;/strong&gt;:&lt;/p&gt;
&lt;p&gt;You must run the APIs in this order:&lt;/p&gt;
&lt;ol&gt;
&lt;li&gt;Run &lt;a href=&quot;https://go.cpanel.net/ClamScanner-start-scan&quot;&gt;&lt;code&gt;ClamScanner::start_scan&lt;/code&gt;&lt;/a&gt; to start the virus scan.&lt;/li&gt;
&lt;li&gt;Run &lt;a href=&quot;https://go.cpanel.net/ClamScanner-get-scan-status&quot;&gt;&lt;code&gt;ClamScanner::get_scan_status&lt;/code&gt;&lt;/a&gt; in a loop until the scan is finished.&lt;/li&gt;
&lt;li&gt;Run &lt;a href=&quot;https://go.cpanel.net/ClamScanner-list-infected-files&quot;&gt;&lt;code&gt;ClamScanner::list_infected_files&lt;/code&gt;&lt;/a&gt; to get a report of the complete list of infected files.&lt;/li&gt;
&lt;li&gt;Decide how you want to handle each infected file.&lt;/li&gt;
&lt;li&gt;Run &lt;a href=&quot;https://go.cpanel.net/ClamScanner-disinfect-files&quot;&gt;&lt;code&gt;ClamScanner::disinfect_files&lt;/code&gt;&lt;/a&gt; to queue the disinfection of the files.&lt;/li&gt;
&lt;li&gt;Run &lt;a href=&quot;https://go.cpanel.net/ClamScanner-check-disinfection-status&quot;&gt;&lt;code&gt;ClamScanner::check_disinfection_status&lt;/code&gt;&lt;/a&gt; in a loop until you get a done status.&lt;/li&gt;
&lt;/ol&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function gets the status of a ClamAV® scan on a directory.</p>
<p><strong>Note</strong>:</p>
<p>You must run the APIs in this order:</p>
<ol>
<li>Run <a href="https://go.cpanel.net/ClamScanner-start-scan"><code>ClamScanner::start_scan</code></a> to start the virus scan.</li>
<li>Run <a href="https://go.cpanel.net/ClamScanner-get-scan-status"><code>ClamScanner::get_scan_status</code></a> in a loop until the scan is finished.</li>
<li>Run <a href="https://go.cpanel.net/ClamScanner-list-infected-files"><code>ClamScanner::list_infected_files</code></a> to get a report of the complete list of infected files.</li>
<li>Decide how you want to handle each infected file.</li>
<li>Run <a href="https://go.cpanel.net/ClamScanner-disinfect-files"><code>ClamScanner::disinfect_files</code></a> to queue the disinfection of the files.</li>
<li>Run <a href="https://go.cpanel.net/ClamScanner-check-disinfection-status"><code>ClamScanner::check_disinfection_status</code></a> in a loop until you get a done status.</li>
</ol>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/ClamScanner/get_scan_status</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/ClamScanner/get_scan_status</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kp39a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kp39a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kp39a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp39a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kp39a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp39a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kp39a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp39a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kp39a:0" aria-labelledby="tab:R4kp39a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  ClamScanner <span class="token punctuation">\</span>
  get_scan_status
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp39a:1" aria-labelledby="tab:R4kp39a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp39a:2" aria-labelledby="tab:R4kp39a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp39a:3" aria-labelledby="tab:R4kp39a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sp39a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sp39a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sp39a:0" aria-labelledby="tab:R4sp39a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_scan_status&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;ClamScanner&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"current_file"</span>: <span class="token string">&quot;/home/username/afilename.txt&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"infected_files"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;/home/username/afile/witha/virus.txt&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;/home/username/we/gotcha.exe&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"scan_complete"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"scanned_file_count"</span>: <span class="token number">135</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"scanned_file_size"</span>: <span class="token number">6022</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"time_started"</span>: <span class="token string">&quot;1608593571&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total_file_count"</span>: <span class="token number">135</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total_file_size_MiB"</span>: <span class="token number">3640222</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Antivirus-Protection-(ClamAV)/operation/disinfect_files" data-section-id="tag/Antivirus-Protection-(ClamAV)/operation/disinfect_files" class="sc-dntaoT ceciOs"><div data-section-id="operation/disinfect_files" id="operation/disinfect_files" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Antivirus-Protection-(ClamAV)/operation/disinfect_files" aria-label="tag/Antivirus-Protection-(ClamAV)/operation/disinfect_files"></a>Start disinfecting files with viruses </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function applies the disinfection option selected by the user
for each infected file.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You must run the APIs in this order:&lt;/p&gt;
&lt;ol&gt;
&lt;li&gt;Run &lt;a href=&quot;https://go.cpanel.net/ClamScanner-start-scan&quot;&gt;&lt;code&gt;ClamScanner::start_scan&lt;/code&gt;&lt;/a&gt; to start the virus scan.&lt;/li&gt;
&lt;li&gt;Run &lt;a href=&quot;https://go.cpanel.net/ClamScanner-get-scan-status&quot;&gt;&lt;code&gt;ClamScanner::get_scan_status&lt;/code&gt;&lt;/a&gt; in a loop until the scan is finished.&lt;/li&gt;
&lt;li&gt;Run &lt;a href=&quot;https://go.cpanel.net/ClamScanner-list-infected-files&quot;&gt;&lt;code&gt;ClamScanner::list_infected_files&lt;/code&gt;&lt;/a&gt; to get a report of the complete list of infected files.&lt;/li&gt;
&lt;li&gt;Decide how you want to handle each infected file.&lt;/li&gt;
&lt;li&gt;Run &lt;a href=&quot;https://go.cpanel.net/ClamScanner-disinfect-files&quot;&gt;&lt;code&gt;ClamScanner::disinfect_files&lt;/code&gt;&lt;/a&gt; to queue the disinfection of the files.&lt;/li&gt;
&lt;li&gt;Run &lt;a href=&quot;https://go.cpanel.net/ClamScanner-check-disinfection-status&quot;&gt;&lt;code&gt;ClamScanner::check_disinfection_status&lt;/code&gt;&lt;/a&gt; in a loop until you get a done status.&lt;/li&gt;
&lt;/ol&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function applies the disinfection option selected by the user
for each infected file.</p>
<p><strong>Note:</strong></p>
<p>You must run the APIs in this order:</p>
<ol>
<li>Run <a href="https://go.cpanel.net/ClamScanner-start-scan"><code>ClamScanner::start_scan</code></a> to start the virus scan.</li>
<li>Run <a href="https://go.cpanel.net/ClamScanner-get-scan-status"><code>ClamScanner::get_scan_status</code></a> in a loop until the scan is finished.</li>
<li>Run <a href="https://go.cpanel.net/ClamScanner-list-infected-files"><code>ClamScanner::list_infected_files</code></a> to get a report of the complete list of infected files.</li>
<li>Decide how you want to handle each infected file.</li>
<li>Run <a href="https://go.cpanel.net/ClamScanner-disinfect-files"><code>ClamScanner::disinfect_files</code></a> to queue the disinfection of the files.</li>
<li>Run <a href="https://go.cpanel.net/ClamScanner-check-disinfection-status"><code>ClamScanner::check_disinfection_status</code></a> in a loop until you get a done status.</li>
</ol>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><h5 class="sc-dpBQxM eJAAZj">Request Body schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><div html="" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"></div><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="actions" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand actions"><span class="property-name">actions</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="&lt;p&gt;The user provides the actions to perform on each specific infected file found in the scan.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user provides the actions to perform on each specific infected file found in the scan.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="post" class="sc-txhaY dCeVuA http-verb post">post</span><span class="sc-etPtWW iqHzp">/ClamScanner/disinfect_files</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/ClamScanner/disinfect_files</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kr39a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kr39a:0" tabindex="0" data-rttab="true">Payload</li><li class="react-tabs__tab" role="tab" id="tab:R4kr39a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kr39a:1" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kr39a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kr39a:2" data-rttab="true">HTTP Request (Wire Format)</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kr39a:0" aria-labelledby="tab:R4kr39a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"actions"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"home/unsure"</span>: <span class="token string">&quot;ignore&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"home/virus1"</span>: <span class="token string">&quot;delete&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"home/virus2"</span>: <span class="token string">&quot;quarantine&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kr39a:1" aria-labelledby="tab:R4kr39a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kr39a:2" aria-labelledby="tab:R4kr39a:2"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sr39a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sr39a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sr39a:0" aria-labelledby="tab:R4sr39a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;disinfect_files&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;ClamScanner&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"log"</span>: <span class="token string">&quot;/home/user/.clamavconnector.disinfection.log&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"task_id"</span>: <span class="token string">&quot;00000000/5a9ec8dd4c345d&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Antivirus-Protection-(ClamAV)/operation/ClamScanner::check_disinfection_status" data-section-id="tag/Antivirus-Protection-(ClamAV)/operation/ClamScanner::check_disinfection_status" class="sc-dntaoT ceciOs"><div data-section-id="operation/ClamScanner::check_disinfection_status" id="operation/ClamScanner::check_disinfection_status" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Antivirus-Protection-(ClamAV)/operation/ClamScanner::check_disinfection_status" aria-label="tag/Antivirus-Protection-(ClamAV)/operation/ClamScanner::check_disinfection_status"></a>Request disinfection process status </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function checks the status of the previously queued disinfection
of infected files.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You must run the APIs in this order:&lt;/p&gt;
&lt;ol&gt;
&lt;li&gt;Run &lt;a href=&quot;https://go.cpanel.net/ClamScanner-start-scan&quot;&gt;&lt;code&gt;ClamScanner::start_scan&lt;/code&gt;&lt;/a&gt; to start the virus scan.&lt;/li&gt;
&lt;li&gt;Run &lt;a href=&quot;https://go.cpanel.net/ClamScanner-get-scan-status&quot;&gt;&lt;code&gt;ClamScanner::get_scan_status&lt;/code&gt;&lt;/a&gt; in a loop until the scan is finished.&lt;/li&gt;
&lt;li&gt;Run &lt;a href=&quot;https://go.cpanel.net/ClamScanner-list-infected-files&quot;&gt;&lt;code&gt;ClamScanner::list_infected_files&lt;/code&gt;&lt;/a&gt; to get a report of the complete list of infected files.&lt;/li&gt;
&lt;li&gt;Decide how you want to handle each infected file.&lt;/li&gt;
&lt;li&gt;Run &lt;a href=&quot;https://go.cpanel.net/ClamScanner-disinfect-files&quot;&gt;&lt;code&gt;ClamScanner::disinfect_files&lt;/code&gt;&lt;/a&gt; to queue the disinfection of the files.&lt;/li&gt;
&lt;li&gt;Run &lt;a href=&quot;https://go.cpanel.net/ClamScanner-check-disinfection-status&quot;&gt;&lt;code&gt;ClamScanner::check_disinfection_status&lt;/code&gt;&lt;/a&gt; in a loop until you get a done status.&lt;/li&gt;
&lt;/ol&gt;
&lt;p&gt;If you want to display the progress, you can render the &lt;code&gt;ClamScanner::check_disinfection_status&lt;/code&gt; returned &amp;#39;result{data}{details}&amp;#39; array where the &lt;code&gt;type&lt;/code&gt; is &lt;code&gt;step&lt;/code&gt;.&lt;/p&gt;
&lt;p&gt;Each &lt;code&gt;step&lt;/code&gt; record indicates the action taken on a specific file in the set being processed.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks the status of the previously queued disinfection
of infected files.</p>
<p><strong>Note:</strong></p>
<p>You must run the APIs in this order:</p>
<ol>
<li>Run <a href="https://go.cpanel.net/ClamScanner-start-scan"><code>ClamScanner::start_scan</code></a> to start the virus scan.</li>
<li>Run <a href="https://go.cpanel.net/ClamScanner-get-scan-status"><code>ClamScanner::get_scan_status</code></a> in a loop until the scan is finished.</li>
<li>Run <a href="https://go.cpanel.net/ClamScanner-list-infected-files"><code>ClamScanner::list_infected_files</code></a> to get a report of the complete list of infected files.</li>
<li>Decide how you want to handle each infected file.</li>
<li>Run <a href="https://go.cpanel.net/ClamScanner-disinfect-files"><code>ClamScanner::disinfect_files</code></a> to queue the disinfection of the files.</li>
<li>Run <a href="https://go.cpanel.net/ClamScanner-check-disinfection-status"><code>ClamScanner::check_disinfection_status</code></a> in a loop until you get a done status.</li>
</ol>
<p>If you want to display the progress, you can render the <code>ClamScanner::check_disinfection_status</code> returned &#39;result{data}{details}&#39; array where the <code>type</code> is <code>step</code>.</p>
<p>Each <code>step</code> record indicates the action taken on a specific file in the set being processed.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="last_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">last_id</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= 1 </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">last_id=10</span></div><div><div html="&lt;p&gt;The unique &lt;code&gt;id&lt;/code&gt; of the message you last received from this same log.&lt;/p&gt;
&lt;p&gt;The API will return only the records after the specified &lt;code&gt;last_id&lt;/code&gt;.&lt;/p&gt;
&lt;p&gt;If this parameter is not provided, the entire log is returned.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;For improved performance, we recommend applications include the last record ID (last_id)
from a previous call to this API, so only messages since the previous API call are returned.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The unique <code>id</code> of the message you last received from this same log.</p>
<p>The API will return only the records after the specified <code>last_id</code>.</p>
<p>If this parameter is not provided, the entire log is returned.</p>
<p><strong>Note:</strong></p>
<p>For improved performance, we recommend applications include the last record ID (last_id)
from a previous call to this API, so only messages since the previous API call are returned.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/ClamScanner/check_disinfection_status</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/ClamScanner/check_disinfection_status</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kt39a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kt39a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kt39a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kt39a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kt39a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kt39a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kt39a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kt39a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kt39a:0" aria-labelledby="tab:R4kt39a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  ClamScanner <span class="token punctuation">\</span>
  check_disinfection_status
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kt39a:1" aria-labelledby="tab:R4kt39a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kt39a:2" aria-labelledby="tab:R4kt39a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kt39a:3" aria-labelledby="tab:R4kt39a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4st39a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4st39a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4st39a:0" aria-labelledby="tab:R4st39a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;check_disinfection_status&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;ClamScanner&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"file"</span>: <span class="token string">&quot;/home/user/virus&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">2</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">&quot;string&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"state"</span>: <span class="token string">&quot;deleted&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;step&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"log"</span>: <span class="token string">&quot;/home/user/.clamavconnector.disinfection.log&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">&quot;done&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Calendar-and-Contacts-(DAV)" data-section-id="tag/Calendar-and-Contacts-(DAV)" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Calendar-and-Contacts-(DAV)" aria-label="tag/Calendar-and-Contacts-(DAV)"></a>Calendar and Contacts (DAV)</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Optional Applications / Calendar and Contacts (DAV)&lt;/p&gt;
"><p>Optional Applications / Calendar and Contacts (DAV)</p>
</div></div></div><div id="tag/Calendar-and-Contacts-(DAV)/operation/enable_shared_global_addressbook" data-section-id="tag/Calendar-and-Contacts-(DAV)/operation/enable_shared_global_addressbook" class="sc-dntaoT ceciOs"><div data-section-id="operation/enable_shared_global_addressbook" id="operation/enable_shared_global_addressbook" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Calendar-and-Contacts-(DAV)/operation/enable_shared_global_addressbook" aria-label="tag/Calendar-and-Contacts-(DAV)/operation/enable_shared_global_addressbook"></a>Enable global address book </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function enables the shared global address book for the current cPanel account&amp;#39;s webmail accounts.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables the shared global address book for the current cPanel account&#39;s webmail accounts.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">name</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=user</span></div><div><div html="&lt;p&gt;cPanel account username or a Webmail user&amp;#39;s email address. If you do &lt;strong&gt;not&lt;/strong&gt; specify a user, this parameter defaults to the currently-authenticated user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>cPanel account username or a Webmail user&#39;s email address. If you do <strong>not</strong> specify a user, this parameter defaults to the currently-authenticated user.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DAV/enable_shared_global_addressbook</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DAV/enable_shared_global_addressbook</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99359a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99359a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99359a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99359a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99359a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99359a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99359a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99359a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99359a:0" aria-labelledby="tab:R99359a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DAV <span class="token punctuation">\</span>
  enable_shared_global_addressbook
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99359a:1" aria-labelledby="tab:R99359a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99359a:2" aria-labelledby="tab:R99359a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99359a:3" aria-labelledby="tab:R99359a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p359a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p359a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p359a:0" aria-labelledby="tab:R9p359a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;enable_shared_global_addressbook&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DAV&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"shared"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Calendar-and-Contacts-(DAV)/operation/has_shared_global_addressbook" data-section-id="tag/Calendar-and-Contacts-(DAV)/operation/has_shared_global_addressbook" class="sc-dntaoT ceciOs"><div data-section-id="operation/has_shared_global_addressbook" id="operation/has_shared_global_addressbook" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Calendar-and-Contacts-(DAV)/operation/has_shared_global_addressbook" aria-label="tag/Calendar-and-Contacts-(DAV)/operation/has_shared_global_addressbook"></a>Return whether global address book is enabled </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function checks whether the shared global address book is enabled on the current cPanel account&amp;#39;s webmail accounts.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether the shared global address book is enabled on the current cPanel account&#39;s webmail accounts.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">name</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=user</span></div><div><div html="&lt;p&gt;cPanel account user name or a Webmail user&amp;#39;s email address. If you do &lt;strong&gt;not&lt;/strong&gt; specify a user, this parameter defaults to the currently-authenticated user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>cPanel account user name or a Webmail user&#39;s email address. If you do <strong>not</strong> specify a user, this parameter defaults to the currently-authenticated user.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DAV/has_shared_global_addressbook</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DAV/has_shared_global_addressbook</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99559a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99559a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99559a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99559a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99559a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99559a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99559a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99559a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99559a:0" aria-labelledby="tab:R99559a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DAV <span class="token punctuation">\</span>
  has_shared_global_addressbook
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99559a:1" aria-labelledby="tab:R99559a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99559a:2" aria-labelledby="tab:R99559a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99559a:3" aria-labelledby="tab:R99559a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p559a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p559a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p559a:0" aria-labelledby="tab:R9p559a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;has_shared_global_addressbook&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DAV&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"shared"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Calendar-and-Contacts-(DAV)/operation/disable_shared_global_addressbook" data-section-id="tag/Calendar-and-Contacts-(DAV)/operation/disable_shared_global_addressbook" class="sc-dntaoT ceciOs"><div data-section-id="operation/disable_shared_global_addressbook" id="operation/disable_shared_global_addressbook" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Calendar-and-Contacts-(DAV)/operation/disable_shared_global_addressbook" aria-label="tag/Calendar-and-Contacts-(DAV)/operation/disable_shared_global_addressbook"></a>Disable global address book </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function disables the shared global address book for the current cPanel account&amp;#39;s webmail accounts.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables the shared global address book for the current cPanel account&#39;s webmail accounts.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">name</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=user</span></div><div><div html="&lt;p&gt;cPanel account username or a Webmail user&amp;#39;s email address. If you do &lt;strong&gt;not&lt;/strong&gt; specify a user, this parameter defaults to the currently-authenticated user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>cPanel account username or a Webmail user&#39;s email address. If you do <strong>not</strong> specify a user, this parameter defaults to the currently-authenticated user.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DAV/disable_shared_global_addressbook</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DAV/disable_shared_global_addressbook</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99759a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99759a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99759a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99759a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99759a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99759a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99759a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99759a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99759a:0" aria-labelledby="tab:R99759a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DAV <span class="token punctuation">\</span>
  disable_shared_global_addressbook
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99759a:1" aria-labelledby="tab:R99759a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99759a:2" aria-labelledby="tab:R99759a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99759a:3" aria-labelledby="tab:R99759a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p759a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p759a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p759a:0" aria-labelledby="tab:R9p759a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;disable_shared_global_addressbook&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DAV&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"shared"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Calendar-and-Contacts-(DAV)/operation/get_calendar_contacts_config" data-section-id="tag/Calendar-and-Contacts-(DAV)/operation/get_calendar_contacts_config" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_calendar_contacts_config" id="operation/get_calendar_contacts_config" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Calendar-and-Contacts-(DAV)/operation/get_calendar_contacts_config" aria-label="tag/Calendar-and-Contacts-(DAV)/operation/get_calendar_contacts_config"></a>Return CalDAV and CardDAV connection information </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the connection information to set up the CalDAV and CardDAV clients.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the connection information to set up the CalDAV and CardDAV clients.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand user"><span class="property-name">user</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or string</span></div> <div><div html="&lt;p&gt;A cPanel account or valid email account user.&lt;/p&gt;
&lt;p&gt;If you do &lt;strong&gt;not&lt;/strong&gt; include this parameter, the function defaults to the current
authenticated user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A cPanel account or valid email account user.</p>
<p>If you do <strong>not</strong> include this parameter, the function defaults to the current
authenticated user.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DAV/get_calendar_contacts_config</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DAV/get_calendar_contacts_config</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99959a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99959a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99959a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99959a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99959a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99959a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99959a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99959a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99959a:0" aria-labelledby="tab:R99959a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DAV <span class="token punctuation">\</span>
  get_calendar_contacts_config
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99959a:1" aria-labelledby="tab:R99959a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99959a:2" aria-labelledby="tab:R99959a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99959a:3" aria-labelledby="tab:R99959a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p959a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p959a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p959a:0" aria-labelledby="tab:R9p959a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_calendar_contacts_config&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DAV&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"activesync"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"port"</span>: <span class="token number">2091</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"server"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">&quot;username&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"no_ssl"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"calendars"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">&quot;Custom calendar 1.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;Calendar 1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/calendars/example/calendar:ZcG9JBH68WXxfMVUgvSrUw1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">&quot;</span><a href="http://example.com:2079/calendars/example/calendar:ZcG9JBH68WXxfMVUgvSrUw1">http://example.com:2079/calendars/example/calendar:ZcG9JBH68WXxfMVUgvSrUw1</a><span class="token string">&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"contacts"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">&quot;Custom address book 1.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;Custom 1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/addressbooks/example/contacts:E-KKA5uQZyQJbTBKcGP3OQ6&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">&quot;</span><a href="https://example.com:2080/addressbooks/example/contacts:E-KKA5uQZyQJbTBKcGP3OQ6">https://example.com:2080/addressbooks/example/contacts:E-KKA5uQZyQJbTBKcGP3OQ6</a><span class="token string">&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"free_busy"</span>: <span class="token string">&quot;</span><a href="http://server.example.com:2079/kronolith/fb.php?u=example">http://server.example.com:2079/kronolith/fb.php?u=example</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_server"</span>: <span class="token string">&quot;</span><a href="http://example.com:2079/rpc/principal/example">http://example.com:2079/rpc/principal/example</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"port"</span>: <span class="token number">2079</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"server"</span>: <span class="token string">&quot;</span><a href="http://example.com:2079">http://example.com:2079</a><span class="token string">&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ssl"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"calendars"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">&quot;Custom calendar 2.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;Calendar 2&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/calendars/example/calendar:ZcG9JBH68WXxfMVUgvSrUw1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">&quot;</span><a href="http://example.com:2080/calendars/example/calendar:ZcG9JBH68WXxfMVUgvSrUw1">http://example.com:2080/calendars/example/calendar:ZcG9JBH68WXxfMVUgvSrUw1</a><span class="token string">&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"contacts"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">&quot;Custom address book 2.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;Address book 2&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/addressbooks/example/contacts:E-KKA5uQZyQJbTBKcGP3OQ6&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">&quot;</span><a href="https://example.com:2080/addressbooks/example/contacts:E-KKA5uQZyQJbTBKcGP3OQ6">https://example.com:2080/addressbooks/example/contacts:E-KKA5uQZyQJbTBKcGP3OQ6</a><span class="token string">&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"free_busy"</span>: <span class="token string">&quot;</span><a href="http://server.example.com:2080/kronolith/fb.php?u=example">http://server.example.com:2080/kronolith/fb.php?u=example</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_server"</span>: <span class="token string">&quot;</span><a href="http://example.com:2080/rpc/principal/example">http://example.com:2080/rpc/principal/example</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_self_signed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"port"</span>: <span class="token number">2080</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"server"</span>: <span class="token string">&quot;</span><a href="https://example.com:2080">https://example.com:2080</a><span class="token string">&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">&quot;username&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Calendar-and-Contacts-(DAV)/operation/is_dav_service_enabled" data-section-id="tag/Calendar-and-Contacts-(DAV)/operation/is_dav_service_enabled" class="sc-dntaoT ceciOs"><div data-section-id="operation/is_dav_service_enabled" id="operation/is_dav_service_enabled" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Calendar-and-Contacts-(DAV)/operation/is_dav_service_enabled" aria-label="tag/Calendar-and-Contacts-(DAV)/operation/is_dav_service_enabled"></a>Return whether DAV is enabled </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function checks whether the DAV service is enabled.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether the DAV service is enabled.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DAV/is_dav_service_enabled</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DAV/is_dav_service_enabled</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99b59a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99b59a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99b59a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b59a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99b59a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b59a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99b59a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b59a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99b59a:0" aria-labelledby="tab:R99b59a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DAV <span class="token punctuation">\</span>
  is_dav_service_enabled
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b59a:1" aria-labelledby="tab:R99b59a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b59a:2" aria-labelledby="tab:R99b59a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b59a:3" aria-labelledby="tab:R99b59a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pb59a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pb59a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pb59a:0" aria-labelledby="tab:R9pb59a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;is_dav_service_enabled&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DAV&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Calendar-and-Contacts-(DAV)/operation/is_horde_enabled" data-section-id="tag/Calendar-and-Contacts-(DAV)/operation/is_horde_enabled" class="sc-dntaoT ceciOs"><div data-section-id="operation/is_horde_enabled" id="operation/is_horde_enabled" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Calendar-and-Contacts-(DAV)/operation/is_horde_enabled" aria-label="tag/Calendar-and-Contacts-(DAV)/operation/is_horde_enabled"></a>Return whether Horde is enabled </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function checks whether Horde is enabled. Since Horde is no longer installed with the product, the return value will only ever be 0.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether Horde is enabled. Since Horde is no longer installed with the product, the return value will only ever be 0.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DAV/is_horde_enabled</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DAV/is_horde_enabled</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99d59a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99d59a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99d59a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d59a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99d59a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d59a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99d59a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d59a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99d59a:0" aria-labelledby="tab:R99d59a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DAV <span class="token punctuation">\</span>
  is_horde_enabled
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99d59a:1" aria-labelledby="tab:R99d59a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99d59a:2" aria-labelledby="tab:R99d59a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99d59a:3" aria-labelledby="tab:R99d59a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pd59a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pd59a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pd59a:0" aria-labelledby="tab:R9pd59a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;is_horde_enabled&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DAV&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_add_delegate" data-section-id="tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_add_delegate" class="sc-dntaoT ceciOs"><div data-section-id="operation/CPDAVD_add_delegate" id="operation/CPDAVD_add_delegate" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_add_delegate" aria-label="tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_add_delegate"></a>Share a calendar </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function adds a share for the specified calendar.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function adds a share for the specified calendar.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="calendar" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">calendar</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">calendar=calendar</span></div><div><div html="&lt;p&gt;The calendar to share.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The calendar to share.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="delegatee" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">delegatee</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">delegatee=second@example.com</span></div><div><div html="&lt;p&gt;The person to whom you will share the calendar.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The person to whom you will share the calendar.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="delegator" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">delegator</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">delegator=first@example.com</span></div><div><div html="&lt;p&gt;The owner of the calendar, who wishes to share it to another user.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The owner of the calendar, who wishes to share it to another user.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="readonly" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">readonly</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">readonly=1</span></div><div><div html="&lt;p&gt;If set, the provided access will be read-only.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>If set, the provided access will be read-only.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/CPDAVD/add_delegate</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/CPDAVD/add_delegate</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99f59a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99f59a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99f59a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f59a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99f59a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f59a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99f59a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f59a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99f59a:0" aria-labelledby="tab:R99f59a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  CPDAVD <span class="token punctuation">\</span>
  add_delegate <span class="token punctuation">\</span>
  <span class="token assign-left variable">delegator</span><span class="token operator">=</span><span class="token string">'first@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">delegatee</span><span class="token operator">=</span><span class="token string">'second@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">calendar</span><span class="token operator">=</span><span class="token string">'calendar'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99f59a:1" aria-labelledby="tab:R99f59a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99f59a:2" aria-labelledby="tab:R99f59a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99f59a:3" aria-labelledby="tab:R99f59a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pf59a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pf59a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pf59a:0" aria-labelledby="tab:R9pf59a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;add_delegate&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;CPDAVD&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"shared"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_list_delegates" data-section-id="tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_list_delegates" class="sc-dntaoT ceciOs"><div data-section-id="operation/CPDAVD_list_delegates" id="operation/CPDAVD_list_delegates" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_list_delegates" aria-label="tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_list_delegates"></a>List calendar sharing. </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the sharing configuration in calendars for this account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the sharing configuration in calendars for this account.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/CPDAVD/list_delegates</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/CPDAVD/list_delegates</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99h59a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99h59a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99h59a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h59a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99h59a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h59a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99h59a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h59a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99h59a:0" aria-labelledby="tab:R99h59a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  CPDAVD <span class="token punctuation">\</span>
  list_delegates
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h59a:1" aria-labelledby="tab:R99h59a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h59a:2" aria-labelledby="tab:R99h59a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h59a:3" aria-labelledby="tab:R99h59a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9ph59a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9ph59a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9ph59a:0" aria-labelledby="tab:R9ph59a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_delegates&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;CPDAVD&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"calendar"</span>: <span class="token string">&quot;calendar&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"calname"</span>: <span class="token string">&quot;cPanel CalDAV Calendar&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delegatee"</span>: <span class="token string">&quot;second@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delegator"</span>: <span class="token string">&quot;first@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"readonly"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_list_users" data-section-id="tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_list_users" class="sc-dntaoT ceciOs"><div data-section-id="operation/CPDAVD_list_users" id="operation/CPDAVD_list_users" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_list_users" aria-label="tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_list_users"></a>Update calendar sharing </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the users that are available for use with CalDAV and CardDAV&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the users that are available for use with CalDAV and CardDAV</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/CPDAVD/list_users</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/CPDAVD/list_users</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99j59a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99j59a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99j59a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99j59a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99j59a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99j59a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99j59a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99j59a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99j59a:0" aria-labelledby="tab:R99j59a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  CPDAVD <span class="token punctuation">\</span>
  list_users
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99j59a:1" aria-labelledby="tab:R99j59a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99j59a:2" aria-labelledby="tab:R99j59a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99j59a:3" aria-labelledby="tab:R99j59a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pj59a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pj59a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pj59a:0" aria-labelledby="tab:R9pj59a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_users&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;CPDAVD&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"someone@example.com"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"addressbook"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">&quot;Default Address Book automatically created for your account.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"displayname"</span>: <span class="token string">&quot;cPanel CardDAV Address Book&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"protected"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;VADDRESSBOOK&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"calendar"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"calendar-color"</span>: <span class="token string">&quot;#ff6c2c&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">&quot;Default Calendar automatically created for your account.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"displayname"</span>: <span class="token string">&quot;cPanel CalDAV Calendar&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"protected"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;VCALENDAR&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_manage_collection" data-section-id="tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_manage_collection" class="sc-dntaoT ceciOs"><div data-section-id="operation/CPDAVD_manage_collection" id="operation/CPDAVD_manage_collection" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_manage_collection" aria-label="tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_manage_collection"></a>Perform an operation on a calendar, task list or address book. </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function creates, updates, or deletes a collection.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates, updates, or deletes a collection.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="account" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">account</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">account=user@example.com</span></div><div><div html="&lt;p&gt;The owner of the calendar.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The owner of the calendar.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="action" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">action</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;create&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;update&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;delete&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">action=delete</span></div><div><div html="&lt;p&gt;The action to perform (create, update, or delete a collection).&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The action to perform (create, update, or delete a collection).</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="calendar-color" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">calendar-color</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">calendar-color=#ee5555</span></div><div><div html="&lt;p&gt;The color of the calendar, if applicable.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The color of the calendar, if applicable.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="collection_type" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">collection_type</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;calendar&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;tasks&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;addressbook&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">collection_type=calendar</span></div><div><div html="&lt;p&gt;The collection type.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The collection type.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="description" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">description</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">description=This is my calendar.</span></div><div><div html="&lt;p&gt;The description of the collection.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The description of the collection.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">name</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=My Calendar</span></div><div><div html="&lt;p&gt;The name of the collection. Required when creating a collection.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the collection. Required when creating a collection.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="path" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">path</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">path=/calendars/user@example.com/mycalendar</span></div><div><div html="&lt;p&gt;The path to the collection.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The path to the collection.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/CPDAVD/manage_collection</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/CPDAVD/manage_collection</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99l59a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99l59a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99l59a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99l59a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99l59a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99l59a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99l59a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99l59a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99l59a:0" aria-labelledby="tab:R99l59a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  CPDAVD <span class="token punctuation">\</span>
  manage_collection <span class="token punctuation">\</span>
  <span class="token assign-left variable">account</span><span class="token operator">=</span><span class="token string">'user@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">action</span><span class="token operator">=</span><span class="token string">'delete'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">path</span><span class="token operator">=</span><span class="token string">'/calendars/user@example.com/mycalendar'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">collection_type</span><span class="token operator">=</span><span class="token string">'calendar'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99l59a:1" aria-labelledby="tab:R99l59a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99l59a:2" aria-labelledby="tab:R99l59a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99l59a:3" aria-labelledby="tab:R99l59a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pl59a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pl59a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pl59a:0" aria-labelledby="tab:R9pl59a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;manage_collection&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;CPDAVD&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"shared"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_remove_delegate" data-section-id="tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_remove_delegate" class="sc-dntaoT ceciOs"><div data-section-id="operation/CPDAVD_remove_delegate" id="operation/CPDAVD_remove_delegate" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_remove_delegate" aria-label="tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_remove_delegate"></a>Remove a share. </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function removes a share for the specified calendar.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes a share for the specified calendar.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="calendar" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">calendar</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">calendar=calendar</span></div><div><div html="&lt;p&gt;The calendar that was shared.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The calendar that was shared.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="delegatee" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">delegatee</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">delegatee=second@example.com</span></div><div><div html="&lt;p&gt;The person to whom the calendar was shared.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The person to whom the calendar was shared.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="delegator" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">delegator</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">delegator=first@example.com</span></div><div><div html="&lt;p&gt;The owner of the calendar, who wishes to remove the sharing.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The owner of the calendar, who wishes to remove the sharing.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/CPDAVD/remove_delegate</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/CPDAVD/remove_delegate</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99n59a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99n59a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99n59a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99n59a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99n59a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99n59a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99n59a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99n59a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99n59a:0" aria-labelledby="tab:R99n59a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  CPDAVD <span class="token punctuation">\</span>
  remove_delegate <span class="token punctuation">\</span>
  <span class="token assign-left variable">delegator</span><span class="token operator">=</span><span class="token string">'first@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">delegatee</span><span class="token operator">=</span><span class="token string">'second@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">calendar</span><span class="token operator">=</span><span class="token string">'calendar'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99n59a:1" aria-labelledby="tab:R99n59a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99n59a:2" aria-labelledby="tab:R99n59a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99n59a:3" aria-labelledby="tab:R99n59a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pn59a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pn59a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pn59a:0" aria-labelledby="tab:R9pn59a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;remove_delegate&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;CPDAVD&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"shared"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_update_delegate" data-section-id="tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_update_delegate" class="sc-dntaoT ceciOs"><div data-section-id="operation/CPDAVD_update_delegate" id="operation/CPDAVD_update_delegate" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_update_delegate" aria-label="tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_update_delegate"></a>Update calendar sharing. </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function updates a share for the specified calendar.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function updates a share for the specified calendar.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="calendar" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">calendar</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">calendar=calendar</span></div><div><div html="&lt;p&gt;The calendar to share.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The calendar to share.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="delegatee" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">delegatee</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">delegatee=second@example.com</span></div><div><div html="&lt;p&gt;The person to whom you will share the calendar.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The person to whom you will share the calendar.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="delegator" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">delegator</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">delegator=first@example.com</span></div><div><div html="&lt;p&gt;The owner of the calendar, who wishes to change the details of the sharing.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The owner of the calendar, who wishes to change the details of the sharing.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="readonly" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">readonly</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">readonly=1</span></div><div><div html="&lt;p&gt;If set, the provided access will be read-only.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>If set, the provided access will be read-only.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/CPDAVD/update_delegate</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/CPDAVD/update_delegate</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99p59a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99p59a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99p59a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99p59a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99p59a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99p59a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99p59a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99p59a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99p59a:0" aria-labelledby="tab:R99p59a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  CPDAVD <span class="token punctuation">\</span>
  update_delegate <span class="token punctuation">\</span>
  <span class="token assign-left variable">delegator</span><span class="token operator">=</span><span class="token string">'first@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">delegatee</span><span class="token operator">=</span><span class="token string">'second@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">calendar</span><span class="token operator">=</span><span class="token string">'calendar'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99p59a:1" aria-labelledby="tab:R99p59a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99p59a:2" aria-labelledby="tab:R99p59a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99p59a:3" aria-labelledby="tab:R99p59a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pp59a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pp59a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pp59a:0" aria-labelledby="tab:R9pp59a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;update_delegate&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;CPDAVD&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"shared"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Calendar-and-Contacts-Server" data-section-id="tag/Calendar-and-Contacts-Server" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Calendar-and-Contacts-Server" aria-label="tag/Calendar-and-Contacts-Server"></a>Calendar and Contacts Server</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Optional Applications / Calendar and Contacts Server&lt;/p&gt;
"><p>Optional Applications / Calendar and Contacts Server</p>
</div></div></div><div id="tag/Calendar-and-Contacts-Server/operation/remove_delegate" data-section-id="tag/Calendar-and-Contacts-Server/operation/remove_delegate" class="sc-dntaoT ceciOs"><div data-section-id="operation/remove_delegate" id="operation/remove_delegate" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Calendar-and-Contacts-Server/operation/remove_delegate" aria-label="tag/Calendar-and-Contacts-Server/operation/remove_delegate"></a>Remove calendar delegation </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function removes a delegate from another user&amp;#39;s calendar.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You &lt;strong&gt;must&lt;/strong&gt; install the &lt;a href=&quot;https://go.cpanel.net/CalendarAndContactsServer&quot;&gt;Calendar and Contacts Server&lt;/a&gt; cPanel plugin to access this API function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes a delegate from another user&#39;s calendar.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> install the <a href="https://go.cpanel.net/CalendarAndContactsServer">Calendar and Contacts Server</a> cPanel plugin to access this API function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="delegatee" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">delegatee</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">delegatee=user2@example.com</span></div><div><div html="&lt;p&gt;The user from whom you wish to remove delegation rights.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user from whom you wish to remove delegation rights.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="delegator" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">delegator</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">delegator=user1@example.com</span></div><div><div html="&lt;p&gt;The calendar&amp;#39;s owner.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The calendar&#39;s owner.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/CCS/remove_delegate</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/CCS/remove_delegate</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kj79a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kj79a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kj79a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj79a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kj79a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj79a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kj79a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj79a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kj79a:0" aria-labelledby="tab:R4kj79a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  CCS <span class="token punctuation">\</span>
  remove_delegate <span class="token punctuation">\</span>
  <span class="token assign-left variable">delegator</span><span class="token operator">=</span><span class="token string">'user1@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">delegatee</span><span class="token operator">=</span><span class="token string">'user2@example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj79a:1" aria-labelledby="tab:R4kj79a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj79a:2" aria-labelledby="tab:R4kj79a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj79a:3" aria-labelledby="tab:R4kj79a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sj79a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sj79a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sj79a:0" aria-labelledby="tab:R4sj79a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;remove_delegate&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;CCS&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Calendar-and-Contacts-Server/operation/list_users" data-section-id="tag/Calendar-and-Contacts-Server/operation/list_users" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_users" id="operation/list_users" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Calendar-and-Contacts-Server/operation/list_users" aria-label="tag/Calendar-and-Contacts-Server/operation/list_users"></a>List cPanel account&#x27;s calendar users </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists all calendar users on the cPanel account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You &lt;strong&gt;must&lt;/strong&gt; install the &lt;a href=&quot;https://go.cpanel.net/CalendarAndContactsServer&quot;&gt;Calendar and Contacts Server&lt;/a&gt; cPanel plugin to access this API function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists all calendar users on the cPanel account.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> install the <a href="https://go.cpanel.net/CalendarAndContactsServer">Calendar and Contacts Server</a> cPanel plugin to access this API function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/CCS/list_users</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/CCS/list_users</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kl79a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kl79a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kl79a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl79a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kl79a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl79a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kl79a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl79a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kl79a:0" aria-labelledby="tab:R4kl79a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  CCS <span class="token punctuation">\</span>
  list_users
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl79a:1" aria-labelledby="tab:R4kl79a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl79a:2" aria-labelledby="tab:R4kl79a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl79a:3" aria-labelledby="tab:R4kl79a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sl79a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sl79a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sl79a:0" aria-labelledby="tab:R4sl79a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_users&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;CCS&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"user1@example.com"</span>: <span class="token string">&quot;0882362A-0B98-11E8-BAF5-D988266709C1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user2@example.com"</span>: <span class="token string">&quot;96F1EB2F-A501-11EA-A3EF-A553B2E4FFA8&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user3@example.com"</span>: <span class="token string">&quot;195C8A51-E1B3-11E6-8715-F54FA4E00DDD&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user4@example.com"</span>: <span class="token string">&quot;028F4AB1-0F1A-11E7-AEC7-E08FECEC8036&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Calendar-and-Contacts-Server/operation/update_delegate" data-section-id="tag/Calendar-and-Contacts-Server/operation/update_delegate" class="sc-dntaoT ceciOs"><div data-section-id="operation/update_delegate" id="operation/update_delegate" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Calendar-and-Contacts-Server/operation/update_delegate" aria-label="tag/Calendar-and-Contacts-Server/operation/update_delegate"></a>Update calendar delegation </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function updates the delegation of a user&amp;#39;s calendar to another user.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You &lt;strong&gt;must&lt;/strong&gt; install the &lt;a href=&quot;https://go.cpanel.net/CalendarAndContactsServer&quot;&gt;Calendar and Contacts Server&lt;/a&gt; cPanel plugin to access this API function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function updates the delegation of a user&#39;s calendar to another user.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> install the <a href="https://go.cpanel.net/CalendarAndContactsServer">Calendar and Contacts Server</a> cPanel plugin to access this API function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="delegatee" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">delegatee</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">delegatee=user2@example.com</span></div><div><div html="&lt;p&gt;The user to whom you delegated the calendar.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user to whom you delegated the calendar.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="delegator" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">delegator</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">delegator=user1@example.com</span></div><div><div html="&lt;p&gt;The calendar&amp;#39;s owner.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The calendar&#39;s owner.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="readonly" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">readonly</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">readonly=1</span></div><div><div html="&lt;p&gt;Whether the delegatee will only have read-only access on the calendar.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Read-only access.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Full access.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the delegatee will only have read-only access on the calendar.</p>
<ul>
<li><code>1</code> - Read-only access.</li>
<li><code>0</code> - Full access.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/CCS/update_delegate</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/CCS/update_delegate</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kn79a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kn79a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kn79a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn79a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kn79a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn79a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kn79a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn79a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kn79a:0" aria-labelledby="tab:R4kn79a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  CCS <span class="token punctuation">\</span>
  update_delegate <span class="token punctuation">\</span>
  <span class="token assign-left variable">delegator</span><span class="token operator">=</span><span class="token string">'user1@example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">delegatee</span><span class="token operator">=</span><span class="token string">'user2@example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn79a:1" aria-labelledby="tab:R4kn79a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn79a:2" aria-labelledby="tab:R4kn79a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn79a:3" aria-labelledby="tab:R4kn79a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sn79a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sn79a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sn79a:0" aria-labelledby="tab:R4sn79a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;update_delegate&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;CCS&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Calendar-and-Contacts-Server/operation/add_delegate" data-section-id="tag/Calendar-and-Contacts-Server/operation/add_delegate" class="sc-dntaoT ceciOs"><div data-section-id="operation/add_delegate" id="operation/add_delegate" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Calendar-and-Contacts-Server/operation/add_delegate" aria-label="tag/Calendar-and-Contacts-Server/operation/add_delegate"></a>Add calendar delegation </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function delegates a user&amp;#39;s calendar to another user.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You &lt;strong&gt;must&lt;/strong&gt; install the &lt;a href=&quot;https://go.cpanel.net/CalendarAndContactsServer&quot;&gt;Calendar and Contacts Server&lt;/a&gt; cPanel plugin to access this API function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function delegates a user&#39;s calendar to another user.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> install the <a href="https://go.cpanel.net/CalendarAndContactsServer">Calendar and Contacts Server</a> cPanel plugin to access this API function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="delegatee" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">delegatee</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">delegatee=delegatee@cptest.test</span></div><div><div html="&lt;p&gt;The user to whom you wish to delegate the calendar.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user to whom you wish to delegate the calendar.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="delegator" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">delegator</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">delegator=delegator@cptest.test</span></div><div><div html="&lt;p&gt;The calendar&amp;#39;s owner.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The calendar&#39;s owner.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="readonly" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">readonly</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">readonly=1</span></div><div><div html="&lt;p&gt;Whether the delegatee will only have read-only access on the calendar.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Read-only access.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Full access.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether the delegatee will only have read-only access on the calendar.</p>
<ul>
<li><code>1</code> - Read-only access.</li>
<li><code>0</code> - Full access.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/CCS/add_delegate</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/CCS/add_delegate</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kp79a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kp79a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kp79a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp79a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kp79a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp79a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kp79a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp79a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kp79a:0" aria-labelledby="tab:R4kp79a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  CCS <span class="token punctuation">\</span>
  add_delegate <span class="token punctuation">\</span>
  <span class="token assign-left variable">delegator</span><span class="token operator">=</span><span class="token string">'delegator@cptest.test'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">delegatee</span><span class="token operator">=</span><span class="token string">'delegatee@cptest.test'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp79a:1" aria-labelledby="tab:R4kp79a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp79a:2" aria-labelledby="tab:R4kp79a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp79a:3" aria-labelledby="tab:R4kp79a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sp79a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sp79a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sp79a:0" aria-labelledby="tab:R4sp79a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;add_delegate&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;CCS&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Calendar-and-Contacts-Server/operation/list_delegates" data-section-id="tag/Calendar-and-Contacts-Server/operation/list_delegates" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_delegates" id="operation/list_delegates" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Calendar-and-Contacts-Server/operation/list_delegates" aria-label="tag/Calendar-and-Contacts-Server/operation/list_delegates"></a>List cPanel account&#x27;s calendar delegates </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists all &lt;a href=&quot;https://docs.cpanel.net/cpanel/email/calendar-delegation/&quot;&gt;calendar delegates&lt;/a&gt; on the cPanel account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You &lt;strong&gt;must&lt;/strong&gt; install the &lt;a href=&quot;https://go.cpanel.net/CalendarAndContactsServer&quot;&gt;Calendar and Contacts Server&lt;/a&gt; cPanel plugin to access this API function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists all <a href="https://docs.cpanel.net/cpanel/email/calendar-delegation/">calendar delegates</a> on the cPanel account.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> install the <a href="https://go.cpanel.net/CalendarAndContactsServer">Calendar and Contacts Server</a> cPanel plugin to access this API function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/CCS/list_delegates</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/CCS/list_delegates</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kr79a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kr79a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kr79a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kr79a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kr79a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kr79a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kr79a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kr79a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kr79a:0" aria-labelledby="tab:R4kr79a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  CCS <span class="token punctuation">\</span>
  list_delegates
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kr79a:1" aria-labelledby="tab:R4kr79a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kr79a:2" aria-labelledby="tab:R4kr79a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kr79a:3" aria-labelledby="tab:R4kr79a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sr79a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sr79a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sr79a:0" aria-labelledby="tab:R4sr79a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_delegates&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;CCS&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"delegatee"</span>: <span class="token string">&quot;delegatee@cptest.test&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"delegator"</span>: <span class="token string">&quot;delegator@cptest.test&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"read_only"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/cPanel-Addons-(cPAddons)" data-section-id="tag/cPanel-Addons-(cPAddons)" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Addons-(cPAddons)" aria-label="tag/cPanel-Addons-(cPAddons)"></a>cPanel Addons (cPAddons)</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Optional Applications / cPanel Addons (cPAddons)&lt;/p&gt;
"><p>Optional Applications / cPanel Addons (cPAddons)</p>
</div></div></div><div id="tag/cPanel-Addons-(cPAddons)/operation/get_available_addons" data-section-id="tag/cPanel-Addons-(cPAddons)/operation/get_available_addons" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_available_addons" id="operation/get_available_addons" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Addons-(cPAddons)/operation/get_available_addons" aria-label="tag/cPanel-Addons-(cPAddons)/operation/get_available_addons"></a>Return available cPAddons </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists an account&amp;#39;s available cPAddons.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists an account&#39;s available cPAddons.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/cPAddons/get_available_addons</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/cPAddons/get_available_addons</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ab99a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ab99a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ab99a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab99a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2ab99a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab99a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2ab99a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab99a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ab99a:0" aria-labelledby="tab:R2ab99a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  cPAddons <span class="token punctuation">\</span>
  get_available_addons
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab99a:1" aria-labelledby="tab:R2ab99a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab99a:2" aria-labelledby="tab:R2ab99a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab99a:3" aria-labelledby="tab:R2ab99a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eb99a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eb99a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eb99a:0" aria-labelledby="tab:R2eb99a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_available_addons&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;cPAddons&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">&quot;WordPress (cPanel)&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;cPanel::Blogs::WordPress&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/cPanel-Addons-(cPAddons)/operation/get_instance_settings" data-section-id="tag/cPanel-Addons-(cPAddons)/operation/get_instance_settings" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_instance_settings" id="operation/get_instance_settings" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Addons-(cPAddons)/operation/get_instance_settings" aria-label="tag/cPanel-Addons-(cPAddons)/operation/get_instance_settings"></a>Return deployed cPAddons instance&#x27;s settings </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists a cPAddons instance&amp;#39;s settings.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists a cPAddons instance&#39;s settings.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="unique_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">unique_id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">unique_id=cPanel::Blogs::WordPressX.0.1486754861</span></div><div><div html="&lt;p&gt;The unique identifier of the cPAddon.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To find this identifier, run the &lt;code&gt;list_addon_instances&lt;/code&gt; function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The unique identifier of the cPAddon.</p>
<p><strong>Note:</strong></p>
<p>To find this identifier, run the <code>list_addon_instances</code> function.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/cPAddons/get_instance_settings</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/cPAddons/get_instance_settings</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ad99a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ad99a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ad99a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ad99a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2ad99a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ad99a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2ad99a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ad99a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ad99a:0" aria-labelledby="tab:R2ad99a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  cPAddons <span class="token punctuation">\</span>
  get_instance_settings <span class="token punctuation">\</span>
  <span class="token assign-left variable">unique_id</span><span class="token operator">=</span><span class="token string">'cPanel::Blogs::WordPressX.0.1486754861'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ad99a:1" aria-labelledby="tab:R2ad99a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ad99a:2" aria-labelledby="tab:R2ad99a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ad99a:3" aria-labelledby="tab:R2ad99a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ed99a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ed99a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ed99a:0" aria-labelledby="tab:R2ed99a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_instance_settings&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;cPAddons&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"addon"</span>: <span class="token string">&quot;cPanel::Blogs::WordPressX&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"admin_user"</span>: <span class="token string">&quot;string&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"autoupdate"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_name"</span>: <span class="token string">&quot;example_wp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_type"</span>: <span class="token string">&quot;mysql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_user"</span>: <span class="token string">&quot;example_wp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"installdir"</span>: <span class="token string">&quot;/home/example/public_html/wordpress&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url_to_install"</span>: <span class="token string">&quot;</span><a href="http://example.com/wordpress/">http://example.com/wordpress/</a><span class="token string">&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/cPanel-Addons-(cPAddons)/operation/list_addon_instances" data-section-id="tag/cPanel-Addons-(cPAddons)/operation/list_addon_instances" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_addon_instances" id="operation/list_addon_instances" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Addons-(cPAddons)/operation/list_addon_instances" aria-label="tag/cPanel-Addons-(cPAddons)/operation/list_addon_instances"></a>Return deployed cPAddons instances </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists an account&amp;#39;s deployed cPAddons instances.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists an account&#39;s deployed cPAddons instances.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="addon" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">addon</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">addon=cPanel::Blogs::WordPressX</span></div><div><div html="&lt;p&gt;The cPAddon for which to return the instances data.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPAddon for which to return the instances data.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/cPAddons/list_addon_instances</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/cPAddons/list_addon_instances</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2af99a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2af99a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2af99a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2af99a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2af99a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2af99a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2af99a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2af99a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2af99a:0" aria-labelledby="tab:R2af99a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  cPAddons <span class="token punctuation">\</span>
  list_addon_instances
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2af99a:1" aria-labelledby="tab:R2af99a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2af99a:2" aria-labelledby="tab:R2af99a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2af99a:3" aria-labelledby="tab:R2af99a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ef99a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ef99a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ef99a:0" aria-labelledby="tab:R2ef99a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_addon_instances&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;cPAddons&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"addon"</span>: <span class="token string">&quot;cPanel::Blogs::WordPressX&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"installdir"</span>: <span class="token string">&quot;/home/example/public_html/wordpress&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"instance"</span>: <span class="token string">&quot;cPanel::Blogs::WordPressX.0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"unique_id"</span>: <span class="token string">&quot;cPanel::Blogs::WordPressX.0.1486754861&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/WordPress-Manager-Backups" data-section-id="tag/WordPress-Manager-Backups" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/WordPress-Manager-Backups" aria-label="tag/WordPress-Manager-Backups"></a>WordPress Manager Backups</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Optional Applications / WordPress Manager Backups&lt;/p&gt;
"><p>Optional Applications / WordPress Manager Backups</p>
</div></div></div><div id="tag/WordPress-Manager-Backups/operation/cancel" data-section-id="tag/WordPress-Manager-Backups/operation/cancel" class="sc-dntaoT ceciOs"><div data-section-id="operation/cancel" id="operation/cancel" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/WordPress-Manager-Backups/operation/cancel" aria-label="tag/WordPress-Manager-Backups/operation/cancel"></a>Stop WordPress site backup </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function cancels a WordPress® site backup.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  You &lt;strong&gt;must&lt;/strong&gt; install the &lt;a href=&quot;https://go.cpanel.net/wordpressmanager&quot;&gt;WordPress Manager&lt;/a&gt; cPanel plugin to access this API function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function cancels a WordPress® site backup.</p>
<p><strong>Note:</strong></p>
<p>  You <strong>must</strong> install the <a href="https://go.cpanel.net/wordpressmanager">WordPress Manager</a> cPanel plugin to access this API function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="site" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand site"><span class="property-name">site</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">site=example.com</span></div><div><div html="&lt;p&gt;The WordPress site&amp;#39;s URL without the protocol prefix.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The WordPress site&#39;s URL without the protocol prefix.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/WordPressBackup/cancel</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/WordPressBackup/cancel</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R993b9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R993b9a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R993b9a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R993b9a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R993b9a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R993b9a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R993b9a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R993b9a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R993b9a:0" aria-labelledby="tab:R993b9a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  WordPressBackup <span class="token punctuation">\</span>
  cancel <span class="token punctuation">\</span>
  <span class="token assign-left variable">site</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R993b9a:1" aria-labelledby="tab:R993b9a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R993b9a:2" aria-labelledby="tab:R993b9a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R993b9a:3" aria-labelledby="tab:R993b9a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p3b9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p3b9a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p3b9a:0" aria-labelledby="tab:R9p3b9a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;cancel&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;WordPressBackup&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"ok"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"site"</span>: <span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/WordPress-Manager-Backups/operation/any_running" data-section-id="tag/WordPress-Manager-Backups/operation/any_running" class="sc-dntaoT ceciOs"><div data-section-id="operation/any_running" id="operation/any_running" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/WordPress-Manager-Backups/operation/any_running" aria-label="tag/WordPress-Manager-Backups/operation/any_running"></a>Return all WordPress sites&#x27; backup status </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function checks for any active WordPress® site backups on the cPanel account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You &lt;strong&gt;must&lt;/strong&gt; install the &lt;a href=&quot;https://go.cpanel.net/wordpressmanager&quot;&gt;WordPress Manager&lt;/a&gt; cPanel plugin to access this API function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks for any active WordPress® site backups on the cPanel account.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> install the <a href="https://go.cpanel.net/wordpressmanager">WordPress Manager</a> cPanel plugin to access this API function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/WordPressBackup/any_running</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/WordPressBackup/any_running</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R995b9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R995b9a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R995b9a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R995b9a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R995b9a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R995b9a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R995b9a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R995b9a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R995b9a:0" aria-labelledby="tab:R995b9a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  WordPressBackup <span class="token punctuation">\</span>
  any_running
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R995b9a:1" aria-labelledby="tab:R995b9a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R995b9a:2" aria-labelledby="tab:R995b9a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R995b9a:3" aria-labelledby="tab:R995b9a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p5b9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p5b9a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p5b9a:0" aria-labelledby="tab:R9p5b9a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;any_running&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;WordPressBackup&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"any_running"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sites"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;null&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"site"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;backup&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sse_url"</span>: <span class="token string">&quot;/sse/WordPressBackup&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/WordPress-Manager-Backups/operation/cleanup" data-section-id="tag/WordPress-Manager-Backups/operation/cleanup" class="sc-dntaoT ceciOs"><div data-section-id="operation/cleanup" id="operation/cleanup" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/WordPress-Manager-Backups/operation/cleanup" aria-label="tag/WordPress-Manager-Backups/operation/cleanup"></a>Delete WordPress backup temporary files </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function releases any system resources from a previous WordPress® site backup.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You &lt;strong&gt;must&lt;/strong&gt; install the &lt;a href=&quot;https://go.cpanel.net/wordpressmanager&quot;&gt;WordPress Manager&lt;/a&gt; cPanel plugin to access this API function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function releases any system resources from a previous WordPress® site backup.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> install the <a href="https://go.cpanel.net/wordpressmanager">WordPress Manager</a> cPanel plugin to access this API function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="site" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">site</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">site=example.com/wordpress</span></div><div><div html="&lt;p&gt;The WordPress site&amp;#39;s URL &lt;strong&gt;without&lt;/strong&gt; the protocol prefix.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The WordPress site&#39;s URL <strong>without</strong> the protocol prefix.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/WordPressBackup/cleanup</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/WordPressBackup/cleanup</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R997b9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R997b9a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R997b9a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R997b9a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R997b9a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R997b9a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R997b9a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R997b9a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R997b9a:0" aria-labelledby="tab:R997b9a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  WordPressBackup <span class="token punctuation">\</span>
  cleanup <span class="token punctuation">\</span>
  <span class="token assign-left variable">site</span><span class="token operator">=</span><span class="token string">'example.com/wordpress'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R997b9a:1" aria-labelledby="tab:R997b9a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R997b9a:2" aria-labelledby="tab:R997b9a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R997b9a:3" aria-labelledby="tab:R997b9a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p7b9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p7b9a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p7b9a:0" aria-labelledby="tab:R9p7b9a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;cleanup&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;WordPressBackup&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"ok"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"site"</span>: <span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/WordPress-Manager-Backups/operation/get_available_backups" data-section-id="tag/WordPress-Manager-Backups/operation/get_available_backups" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_available_backups" id="operation/get_available_backups" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/WordPress-Manager-Backups/operation/get_available_backups" aria-label="tag/WordPress-Manager-Backups/operation/get_available_backups"></a>Return WordPress site backups </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves a list of available WordPress® site backups of a single site.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You &lt;strong&gt;must&lt;/strong&gt; install the &lt;a href=&quot;https://go.cpanel.net/wordpressmanager&quot;&gt;WordPress Manager&lt;/a&gt; cPanel plugin to access this API function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a list of available WordPress® site backups of a single site.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> install the <a href="https://go.cpanel.net/wordpressmanager">WordPress Manager</a> cPanel plugin to access this API function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="site" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">site</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">site=example.com/wordpress</span></div><div><div html="&lt;p&gt;The WordPress site&amp;#39;s URL &lt;strong&gt;without&lt;/strong&gt; the protocol prefix.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The WordPress site&#39;s URL <strong>without</strong> the protocol prefix.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/WordPressBackup/get_available_backups</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/WordPressBackup/get_available_backups</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R999b9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R999b9a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R999b9a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R999b9a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R999b9a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R999b9a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R999b9a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R999b9a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R999b9a:0" aria-labelledby="tab:R999b9a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  WordPressBackup <span class="token punctuation">\</span>
  get_available_backups <span class="token punctuation">\</span>
  <span class="token assign-left variable">site</span><span class="token operator">=</span><span class="token string">'example.com/wordpress'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R999b9a:1" aria-labelledby="tab:R999b9a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R999b9a:2" aria-labelledby="tab:R999b9a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R999b9a:3" aria-labelledby="tab:R999b9a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p9b9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p9b9a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p9b9a:0" aria-labelledby="tab:R9p9b9a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_available_backups&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;WordPressBackup&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"available"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"date"</span>: <span class="token number">1539267197000</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file"</span>: <span class="token string">&quot;example.com__2018-10-10T10:53:31-0500.tar.gz&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/home/example/wordpress-backups/example.com__2018-10-10T10:53:31-0500.tar.gz&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"site"</span>: <span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dir"</span>: <span class="token string">&quot;/home/example/wordpress-backups&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/WordPress-Manager-Backups/operation/is_running" data-section-id="tag/WordPress-Manager-Backups/operation/is_running" class="sc-dntaoT ceciOs"><div data-section-id="operation/is_running" id="operation/is_running" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/WordPress-Manager-Backups/operation/is_running" aria-label="tag/WordPress-Manager-Backups/operation/is_running"></a>Return WordPress site backup status </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function checks for an active WordPress® site backup.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You &lt;strong&gt;must&lt;/strong&gt; install the &lt;a href=&quot;https://go.cpanel.net/wordpressmanager&quot;&gt;WordPress Manager&lt;/a&gt; cPanel plugin to access this API function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks for an active WordPress® site backup.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> install the <a href="https://go.cpanel.net/wordpressmanager">WordPress Manager</a> cPanel plugin to access this API function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="site" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">site</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">site=example.com

example.com/wordpress</span></div><div><div html="&lt;p&gt;The WordPress site&amp;#39;s URL &lt;strong&gt;without&lt;/strong&gt; &lt;code&gt;http://&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The WordPress site&#39;s URL <strong>without</strong> <code>http://</code>.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/WordPressBackup/is_running</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/WordPressBackup/is_running</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99bb9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99bb9a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99bb9a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99bb9a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99bb9a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99bb9a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99bb9a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99bb9a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99bb9a:0" aria-labelledby="tab:R99bb9a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  WordPressBackup <span class="token punctuation">\</span>
  is_running <span class="token punctuation">\</span>
  <span class="token assign-left variable">site</span><span class="token operator">=</span><span class="token string">'example.com

example.com/wordpress'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99bb9a:1" aria-labelledby="tab:R99bb9a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99bb9a:2" aria-labelledby="tab:R99bb9a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99bb9a:3" aria-labelledby="tab:R99bb9a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pbb9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pbb9a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pbb9a:0" aria-labelledby="tab:R9pbb9a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;is_running&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;WordPressBackup&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"action_id"</span>: <span class="token string">&quot;example.com__2018-10-10T10:53:31-0500&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_running"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/WordPress-Manager-Backups/operation/start" data-section-id="tag/WordPress-Manager-Backups/operation/start" class="sc-dntaoT ceciOs"><div data-section-id="operation/start" id="operation/start" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/WordPress-Manager-Backups/operation/start" aria-label="tag/WordPress-Manager-Backups/operation/start"></a>Backup WordPress site </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function starts a single WordPress® site backup.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You &lt;strong&gt;must&lt;/strong&gt; install the &lt;a href=&quot;https://go.cpanel.net/wordpressmanager&quot;&gt;WordPress Manager&lt;/a&gt; cPanel plugin to access this API function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function starts a single WordPress® site backup.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> install the <a href="https://go.cpanel.net/wordpressmanager">WordPress Manager</a> cPanel plugin to access this API function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="site" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand site"><span class="property-name">site</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">site=example.com</span></div><div><div html="&lt;p&gt;The WordPress site&amp;#39;s URL without the protocol prefix.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The WordPress site&#39;s URL without the protocol prefix.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/WordPressBackup/start</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/WordPressBackup/start</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99db9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99db9a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99db9a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99db9a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99db9a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99db9a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99db9a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99db9a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99db9a:0" aria-labelledby="tab:R99db9a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  WordPressBackup <span class="token punctuation">\</span>
  start <span class="token punctuation">\</span>
  <span class="token assign-left variable">site</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99db9a:1" aria-labelledby="tab:R99db9a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99db9a:2" aria-labelledby="tab:R99db9a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99db9a:3" aria-labelledby="tab:R99db9a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pdb9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pdb9a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pdb9a:0" aria-labelledby="tab:R9pdb9a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;start&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;WordPressBackup&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"backup_id"</span>: <span class="token string">&quot;example.com__2018-10-10T10:53:31-0500&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"site"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sse_url"</span>: <span class="token string">&quot;/sse/WordPressBackup&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/WordPress-Manager-Backups/operation/WordPressRestore-start" data-section-id="tag/WordPress-Manager-Backups/operation/WordPressRestore-start" class="sc-dntaoT ceciOs"><div data-section-id="operation/WordPressRestore-start" id="operation/WordPressRestore-start" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/WordPress-Manager-Backups/operation/WordPressRestore-start" aria-label="tag/WordPress-Manager-Backups/operation/WordPressRestore-start"></a>Restore WordPress site </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function starts a single WordPress® site backup restoration.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You &lt;strong&gt;must&lt;/strong&gt; install the &lt;a href=&quot;https://go.cpanel.net/wordpressmanager&quot;&gt;WordPress Manager&lt;/a&gt; cPanel plugin to access this API function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function starts a single WordPress® site backup restoration.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> install the <a href="https://go.cpanel.net/wordpressmanager">WordPress Manager</a> cPanel plugin to access this API function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="backup_path" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">backup_path</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">backup_path=/home/example/wordpress-backups/example.com__2018-11-13T11:11:31-0600.tar.gz</span></div><div><div html="&lt;p&gt;The file path to the backup archive.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The file path to the backup archive.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="site" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">site</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">site=example.com</span> - Just a domain.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">site=example.com/wordpress</span> - Domain with path.</li></ul><div><div html="&lt;p&gt;The WordPress site&amp;#39;s URL to restore.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The WordPress site&#39;s URL to restore.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/WordPressRestore/start</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/WordPressRestore/start</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99fb9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99fb9a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99fb9a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99fb9a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99fb9a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99fb9a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99fb9a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99fb9a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99fb9a:0" aria-labelledby="tab:R99fb9a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  WordPressRestore <span class="token punctuation">\</span>
  start <span class="token punctuation">\</span>
  <span class="token assign-left variable">site</span><span class="token operator">=</span><span class="token string">'example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">backup_path</span><span class="token operator">=</span><span class="token string">'/home/example/wordpress-backups/example.com__2018-11-13T11:11:31-0600.tar.gz'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99fb9a:1" aria-labelledby="tab:R99fb9a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99fb9a:2" aria-labelledby="tab:R99fb9a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99fb9a:3" aria-labelledby="tab:R99fb9a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pfb9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pfb9a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pfb9a:0" aria-labelledby="tab:R9pfb9a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;start&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;WordPressRestore&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"restore_id"</span>: <span class="token string">&quot;example.com__2018-11-15T08:03:22-0600&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/WordPress-Manager-Backups/operation/WordPressRestore::any_running" data-section-id="tag/WordPress-Manager-Backups/operation/WordPressRestore::any_running" class="sc-dntaoT ceciOs"><div data-section-id="operation/WordPressRestore::any_running" id="operation/WordPressRestore::any_running" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/WordPress-Manager-Backups/operation/WordPressRestore::any_running" aria-label="tag/WordPress-Manager-Backups/operation/WordPressRestore::any_running"></a>Return WordPress site restore status </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns whether a WordPress® site backup restoration is in progress.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;You &lt;strong&gt;must&lt;/strong&gt; install the &lt;a href=&quot;https://go.cpanel.net/wordpressmanager&quot;&gt;WordPress Manager&lt;/a&gt; cPanel plugin to access this API function.&lt;/li&gt;
&lt;li&gt;The output of this function changes, depending on the state of the backup restoration.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns whether a WordPress® site backup restoration is in progress.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You <strong>must</strong> install the <a href="https://go.cpanel.net/wordpressmanager">WordPress Manager</a> cPanel plugin to access this API function.</li>
<li>The output of this function changes, depending on the state of the backup restoration.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/WordPressRestore/any_running</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/WordPressRestore/any_running</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99hb9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99hb9a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99hb9a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99hb9a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99hb9a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99hb9a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99hb9a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99hb9a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99hb9a:0" aria-labelledby="tab:R99hb9a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  WordPressRestore <span class="token punctuation">\</span>
  any_running
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99hb9a:1" aria-labelledby="tab:R99hb9a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99hb9a:2" aria-labelledby="tab:R99hb9a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99hb9a:3" aria-labelledby="tab:R99hb9a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9phb9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9phb9a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9phb9a:0" aria-labelledby="tab:R9phb9a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Example</span><div class="sc-diYFot sc-frniUE jsRqjj esCYIP"><svg class="sc-kZrBCu JXohG" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="Example output of a backup restore in progress." selected="">Example output of a backup restore in progress.</option><option value="Example output of a backup restore not in progress.">Example output of a backup restore not in progress.</option></select><label>Example output of a backup restore in progress.</label></div></div><div><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"any_running"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sites"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"site"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;restore&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div></div><div id="tag/WordPress-Manager-Backups/operation/WordPressRestore-cleanup" data-section-id="tag/WordPress-Manager-Backups/operation/WordPressRestore-cleanup" class="sc-dntaoT ceciOs"><div data-section-id="operation/WordPressRestore-cleanup" id="operation/WordPressRestore-cleanup" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/WordPress-Manager-Backups/operation/WordPressRestore-cleanup" aria-label="tag/WordPress-Manager-Backups/operation/WordPressRestore-cleanup"></a>Delete restored WordPress site&#x27;s temporary files </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function cleans up any temporary system resources after a WordPress® site backup restoration.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You &lt;strong&gt;must&lt;/strong&gt; install the &lt;a href=&quot;https://go.cpanel.net/wordpressmanager&quot;&gt;WordPress Manager&lt;/a&gt; cPanel plugin to access this API function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function cleans up any temporary system resources after a WordPress® site backup restoration.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> install the <a href="https://go.cpanel.net/wordpressmanager">WordPress Manager</a> cPanel plugin to access this API function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="site" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">site</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">site=example.com</span> - Just a domain.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">site=example.com/wordpress</span> - Domain with path.</li></ul><div><div html="&lt;p&gt;The WordPress site&amp;#39;s URL &lt;strong&gt;without&lt;/strong&gt; the protocol prefix.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The WordPress site&#39;s URL <strong>without</strong> the protocol prefix.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/WordPressRestore/cleanup</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/WordPressRestore/cleanup</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99jb9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99jb9a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99jb9a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99jb9a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99jb9a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99jb9a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99jb9a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99jb9a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99jb9a:0" aria-labelledby="tab:R99jb9a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  WordPressRestore <span class="token punctuation">\</span>
  cleanup <span class="token punctuation">\</span>
  <span class="token assign-left variable">site</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99jb9a:1" aria-labelledby="tab:R99jb9a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99jb9a:2" aria-labelledby="tab:R99jb9a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99jb9a:3" aria-labelledby="tab:R99jb9a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pjb9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pjb9a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pjb9a:0" aria-labelledby="tab:R9pjb9a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;cleanup&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;WordPressRestore&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/WordPress-Manager-Settings" data-section-id="tag/WordPress-Manager-Settings" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/WordPress-Manager-Settings" aria-label="tag/WordPress-Manager-Settings"></a>WordPress Manager Settings</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Optional Applications / WordPress Manager Settings&lt;/p&gt;
"><p>Optional Applications / WordPress Manager Settings</p>
</div></div></div><div id="tag/WordPress-Manager-Settings/operation/change_admin_password" data-section-id="tag/WordPress-Manager-Settings/operation/change_admin_password" class="sc-dntaoT ceciOs"><div data-section-id="operation/change_admin_password" id="operation/change_admin_password" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/WordPress-Manager-Settings/operation/change_admin_password" aria-label="tag/WordPress-Manager-Settings/operation/change_admin_password"></a>Update WordPress site admin password </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function updates a WordPress® cPAddon instance&amp;#39;s administrator password.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  You &lt;strong&gt;must&lt;/strong&gt; install the &lt;a href=&quot;https://go.cpanel.net/wordpressmanager&quot;&gt;WordPress Manager&lt;/a&gt; cPanel plugin to access this API function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function updates a WordPress® cPAddon instance&#39;s administrator password.</p>
<p><strong>Note:</strong></p>
<p>  You <strong>must</strong> install the <a href="https://go.cpanel.net/wordpressmanager">WordPress Manager</a> cPanel plugin to access this API function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">id=cPanel__Blogs__WordPressX.0.1491917088</span></div><div><div html="&lt;p&gt;The cPAddon instance&amp;#39;s unique ID.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; You can retrieve an instance ID with the &lt;code&gt;get_instances&lt;/code&gt; function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPAddon instance&#39;s unique ID.</p>
<p><strong>Note:</strong></p>
<p> You can retrieve an instance ID with the <code>get_instances</code> function.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="password" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">password</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">password=luggage12345</span></div><div><div html="&lt;p&gt;The cPAddon instance&amp;#39;s new administrator password.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPAddon instance&#39;s new administrator password.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/WordPressInstanceManager/change_admin_password</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/WordPressInstanceManager/change_admin_password</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R993d9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R993d9a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R993d9a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R993d9a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R993d9a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R993d9a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R993d9a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R993d9a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R993d9a:0" aria-labelledby="tab:R993d9a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  WordPressInstanceManager <span class="token punctuation">\</span>
  change_admin_password <span class="token punctuation">\</span>
  <span class="token assign-left variable">id</span><span class="token operator">=</span><span class="token string">'cPanel__Blogs__WordPressX.0.1491917088'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">password</span><span class="token operator">=</span><span class="token string">'luggage12345'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R993d9a:1" aria-labelledby="tab:R993d9a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R993d9a:2" aria-labelledby="tab:R993d9a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R993d9a:3" aria-labelledby="tab:R993d9a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p3d9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p3d9a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p3d9a:0" aria-labelledby="tab:R9p3d9a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;change_admin_password&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;WordPressInstanceManager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/WordPress-Manager-Settings/operation/cleanup_scan" data-section-id="tag/WordPress-Manager-Settings/operation/cleanup_scan" class="sc-dntaoT ceciOs"><div data-section-id="operation/cleanup_scan" id="operation/cleanup_scan" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/WordPress-Manager-Settings/operation/cleanup_scan" aria-label="tag/WordPress-Manager-Settings/operation/cleanup_scan"></a>Remove scan log after completed scan </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function cleans up the scan log file after you complete a scan with the WordPressInstanceManager::start_scan function. To read more information about the complete scan process, read our UAPI Functions - WordPressInstanceManager::start_scan documentation.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  You &lt;strong&gt;must&lt;/strong&gt; install the &lt;a href=&quot;https://go.cpanel.net/wordpressmanager&quot;&gt;WordPress Manager&lt;/a&gt; cPanel plugin to access this API function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function cleans up the scan log file after you complete a scan with the WordPressInstanceManager::start_scan function. To read more information about the complete scan process, read our UAPI Functions - WordPressInstanceManager::start_scan documentation.</p>
<p><strong>Note:</strong></p>
<p>  You <strong>must</strong> install the <a href="https://go.cpanel.net/wordpressmanager">WordPress Manager</a> cPanel plugin to access this API function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="guid" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">guid</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">guid=B3A27B96-51F7-11E8-92E3-CC90C4F823F0</span></div><div><div html="&lt;p&gt;The scan’s unique ID.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The scan’s unique ID.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/WordPressInstanceManager/cleanup_scan</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/WordPressInstanceManager/cleanup_scan</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R995d9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R995d9a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R995d9a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R995d9a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R995d9a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R995d9a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R995d9a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R995d9a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R995d9a:0" aria-labelledby="tab:R995d9a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  WordPressInstanceManager <span class="token punctuation">\</span>
  cleanup_scan <span class="token punctuation">\</span>
  <span class="token assign-left variable">guid</span><span class="token operator">=</span><span class="token string">'B3A27B96-51F7-11E8-92E3-CC90C4F823F0'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R995d9a:1" aria-labelledby="tab:R995d9a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R995d9a:2" aria-labelledby="tab:R995d9a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R995d9a:3" aria-labelledby="tab:R995d9a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p5d9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p5d9a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p5d9a:0" aria-labelledby="tab:R9p5d9a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;cleanup_scan&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;WordPressInstanceManager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/WordPress-Manager-Settings/operation/configure_autoupdate" data-section-id="tag/WordPress-Manager-Settings/operation/configure_autoupdate" class="sc-dntaoT ceciOs"><div data-section-id="operation/configure_autoupdate" id="operation/configure_autoupdate" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/WordPress-Manager-Settings/operation/configure_autoupdate" aria-label="tag/WordPress-Manager-Settings/operation/configure_autoupdate"></a>Update WordPress site automatic update settings </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function configures a WordPress cPAddon instance&amp;#39;s automatic updates settings. If you enable automatic updates for a legacy WordPress cPAddon instance, the function will convert it to use the RPM-based WordPress cPAddon.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  This function changes the instance&amp;#39;s automatic update setting in the &lt;code&gt;wp-config.php&lt;/code&gt; file. Before you run this function, you should verify that a filter does &lt;strong&gt;not&lt;/strong&gt; exist for the automatic update settings. Use the &lt;code&gt;get_instance_by_id&lt;/code&gt; function and view the &lt;code&gt;autoupdate.core.has_filter&lt;/code&gt; return to determine if a filter exists.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  You &lt;strong&gt;must&lt;/strong&gt; install the &lt;a href=&quot;https://go.cpanel.net/wordpressmanager&quot;&gt;WordPress Manager&lt;/a&gt; cPanel plugin to access this API function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function configures a WordPress cPAddon instance&#39;s automatic updates settings. If you enable automatic updates for a legacy WordPress cPAddon instance, the function will convert it to use the RPM-based WordPress cPAddon.</p>
<p><strong>Important:</strong></p>
<p>  This function changes the instance&#39;s automatic update setting in the <code>wp-config.php</code> file. Before you run this function, you should verify that a filter does <strong>not</strong> exist for the automatic update settings. Use the <code>get_instance_by_id</code> function and view the <code>autoupdate.core.has_filter</code> return to determine if a filter exists.</p>
<p><strong>Note:</strong></p>
<p>  You <strong>must</strong> install the <a href="https://go.cpanel.net/wordpressmanager">WordPress Manager</a> cPanel plugin to access this API function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="autoupdate.core.major" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">autoupdate.core.major</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">autoupdate.core.major=0</span></div><div><div html="&lt;p&gt;Whether to enable automatic updates for major releases.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Enable.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Disable.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to enable automatic updates for major releases.</p>
<ul>
<li><code>1</code> - Enable.</li>
<li><code>0</code> - Disable.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="autoupdate.core.minor" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">autoupdate.core.minor</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">autoupdate.core.minor=0</span></div><div><div html="&lt;p&gt;Whether to enable automatic updates for minor releases.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Enable.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Disable.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to enable automatic updates for minor releases.</p>
<ul>
<li><code>1</code> - Enable.</li>
<li><code>0</code> - Disable.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">id=cPanel__Blogs__WordPressX.0.1491917088</span></div><div><div html="&lt;p&gt;The cPAddon instance&amp;#39;s unique ID.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; You can retrieve an instance ID with the &lt;code&gt;get_instances&lt;/code&gt; function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The cPAddon instance&#39;s unique ID.</p>
<p><strong>Note:</strong></p>
<p> You can retrieve an instance ID with the <code>get_instances</code> function.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/WordPressInstanceManager/configure_autoupdate</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/WordPressInstanceManager/configure_autoupdate</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R997d9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R997d9a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R997d9a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R997d9a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R997d9a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R997d9a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R997d9a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R997d9a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R997d9a:0" aria-labelledby="tab:R997d9a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  WordPressInstanceManager <span class="token punctuation">\</span>
  configure_autoupdate <span class="token punctuation">\</span>
  <span class="token assign-left variable">id</span><span class="token operator">=</span><span class="token string">'cPanel__Blogs__WordPressX.0.1491917088'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">autoupdate.core.major</span><span class="token operator">=</span><span class="token string">'0'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">autoupdate.core.minor</span><span class="token operator">=</span><span class="token string">'0'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R997d9a:1" aria-labelledby="tab:R997d9a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R997d9a:2" aria-labelledby="tab:R997d9a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R997d9a:3" aria-labelledby="tab:R997d9a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p7d9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p7d9a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p7d9a:0" aria-labelledby="tab:R9p7d9a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;configure_autoupdate&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;WordPressInstanceManager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"after"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"addon_config"</span>: <span class="token string">&quot;/home/example/.cpaddons/cPanel::Blogs::WordPressX.0.yaml&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"addon_name"</span>: <span class="token string">&quot;cPanel::Blogs::WordPressX&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"addon_type"</span>: <span class="token string">&quot;modern&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"admin_url"</span>: <span class="token string">&quot;example.com/wordpress-41/wp-login.php&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"admin_username"</span>: <span class="token string">&quot;wpadmin&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"available_version"</span>: <span class="token string">&quot;4.9.1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"current_version"</span>: <span class="token string">&quot;4.9.1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_name"</span>: <span class="token string">&quot;example_wp1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_prefix"</span>: <span class="token string">&quot;example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_server"</span>: <span class="token string">&quot;localhost&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_type"</span>: <span class="token string">&quot;mysql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_username"</span>: <span class="token string">&quot;example_wp1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_path"</span>: <span class="token string">&quot;/home/example/public_html/wordpress-41&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/home/example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;cPanel__Blogs__WordPress.1.1509732223&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"initial_install_version"</span>: <span class="token string">&quot;4.1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"migrated_from"</span>: <span class="token string">&quot;cPanel::Blogs::WordPress&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"migrated_on"</span>: <span class="token number">1513965986</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rel_path"</span>: <span class="token string">&quot;wordpress-41&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"site_url"</span>: <span class="token string">&quot;example.com/wordpress-41&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"before"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"addon_config"</span>: <span class="token string">&quot;/home/example/.cpaddons/cPanel::Blogs::WordPressX.0.yaml&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"addon_name"</span>: <span class="token string">&quot;cPanel::Blogs::WordPress&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"addon_type"</span>: <span class="token string">&quot;legacy&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"admin_url"</span>: <span class="token string">&quot;example.com/wordpress-41/wp-login.php&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"admin_username"</span>: <span class="token string">&quot;wpadmin&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"available_version"</span>: <span class="token string">&quot;4.9.1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"current_version"</span>: <span class="token string">&quot;4.9.1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_name"</span>: <span class="token string">&quot;example_wp1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_prefix"</span>: <span class="token string">&quot;example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_server"</span>: <span class="token string">&quot;localhost&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_type"</span>: <span class="token string">&quot;mysql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_username"</span>: <span class="token string">&quot;example_wp1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_path"</span>: <span class="token string">&quot;/home/example/public_html/wordpress-41&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/home/example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;cPanel__Blogs__WordPress.1.1509732223&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"initial_install_version"</span>: <span class="token string">&quot;4.1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rel_path"</span>: <span class="token string">&quot;wordpress-41&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"site_url"</span>: <span class="token string">&quot;example.com/wordpress-41&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/WordPress-Manager-Settings/operation/get_api_version" data-section-id="tag/WordPress-Manager-Settings/operation/get_api_version" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_api_version" id="operation/get_api_version" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/WordPress-Manager-Settings/operation/get_api_version" aria-label="tag/WordPress-Manager-Settings/operation/get_api_version"></a>Return WordPress Manager plugin version </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves the WordPress Manager plugin&amp;#39;s version.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  You &lt;strong&gt;must&lt;/strong&gt; install the &lt;a href=&quot;https://go.cpanel.net/wordpressmanager&quot;&gt;WordPress Manager&lt;/a&gt; cPanel plugin to access this API function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the WordPress Manager plugin&#39;s version.</p>
<p><strong>Note:</strong></p>
<p>  You <strong>must</strong> install the <a href="https://go.cpanel.net/wordpressmanager">WordPress Manager</a> cPanel plugin to access this API function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/WordPressInstanceManager/get_api_version</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/WordPressInstanceManager/get_api_version</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R999d9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R999d9a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R999d9a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R999d9a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R999d9a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R999d9a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R999d9a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R999d9a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R999d9a:0" aria-labelledby="tab:R999d9a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  WordPressInstanceManager <span class="token punctuation">\</span>
  get_api_version
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R999d9a:1" aria-labelledby="tab:R999d9a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R999d9a:2" aria-labelledby="tab:R999d9a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R999d9a:3" aria-labelledby="tab:R999d9a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p9d9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p9d9a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p9d9a:0" aria-labelledby="tab:R9p9d9a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_api_version&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;WordPressInstanceManager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">&quot;1.0.1-0&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/WordPress-Manager-Settings/operation/get_instances" data-section-id="tag/WordPress-Manager-Settings/operation/get_instances" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_instances" id="operation/get_instances" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/WordPress-Manager-Settings/operation/get_instances" aria-label="tag/WordPress-Manager-Settings/operation/get_instances"></a>Return WordPress sites </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists an account&amp;#39;s WordPress® instances.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;You &lt;strong&gt;must&lt;/strong&gt; install the &lt;a href=&quot;https://go.cpanel.net/wordpressmanager&quot;&gt;WordPress Manager&lt;/a&gt; cPanel plugin to access this API function.&lt;/li&gt;
&lt;li&gt;This function retrieves data that the system stored during the WordPress installation. That data may not reflect the most recent user changes.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists an account&#39;s WordPress® instances.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You <strong>must</strong> install the <a href="https://go.cpanel.net/wordpressmanager">WordPress Manager</a> cPanel plugin to access this API function.</li>
<li>This function retrieves data that the system stored during the WordPress installation. That data may not reflect the most recent user changes.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/WordPressInstanceManager/get_instances</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/WordPressInstanceManager/get_instances</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99bd9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99bd9a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99bd9a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99bd9a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99bd9a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99bd9a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99bd9a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99bd9a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99bd9a:0" aria-labelledby="tab:R99bd9a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  WordPressInstanceManager <span class="token punctuation">\</span>
  get_instances
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99bd9a:1" aria-labelledby="tab:R99bd9a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99bd9a:2" aria-labelledby="tab:R99bd9a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99bd9a:3" aria-labelledby="tab:R99bd9a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pbd9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pbd9a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pbd9a:0" aria-labelledby="tab:R9pbd9a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_instances&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;WordPressInstanceManager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"errors"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;string&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"instances"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"addon_config"</span>: <span class="token string">&quot;/home/example/.cpaddons/cPanel::Blogs::WordPressX.0.yaml&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"addon_name"</span>: <span class="token string">&quot;cPanel::Blogs::WordPressX&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"addon_type"</span>: <span class="token string">&quot;modern&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"admin_url"</span>: <span class="token string">&quot;example.com/wp-login.php&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"admin_username"</span>: <span class="token string">&quot;admin&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"available_version"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_on"</span>: <span class="token number">1528208546</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"current_version"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_name"</span>: <span class="token string">&quot;example_wp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_prefix"</span>: <span class="token string">&quot;wp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_server"</span>: <span class="token string">&quot;localhost&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_type"</span>: <span class="token string">&quot;mysql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_username"</span>: <span class="token string">&quot;example_wp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_path"</span>: <span class="token string">&quot;/home/example/public_html&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/home/example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;cPanel__Blogs__WordPressX.0.1528208546&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"import_guid"</span>: <span class="token string">&quot;8AF1767E-68CD-11E8-90D1-96B06D626D05&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"imported_on"</span>: <span class="token number">1528209264</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"initial_install_version"</span>: <span class="token string">&quot;4.9.6&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"migrated_from"</span>: <span class="token string">&quot;cPanel::Blogs::WordPress&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"migrated_on"</span>: <span class="token number">1528209264</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"recent"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rel_path"</span>: <span class="token string">&quot; &quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"site_url"</span>: <span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/WordPress-Manager-Settings/operation/get_latest_wordpress_version_from_wordpress_org" data-section-id="tag/WordPress-Manager-Settings/operation/get_latest_wordpress_version_from_wordpress_org" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_latest_wordpress_version_from_wordpress_org" id="operation/get_latest_wordpress_version_from_wordpress_org" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/WordPress-Manager-Settings/operation/get_latest_wordpress_version_from_wordpress_org" aria-label="tag/WordPress-Manager-Settings/operation/get_latest_wordpress_version_from_wordpress_org"></a>Return latest wordpress.org updates </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the available WordPress® updates from wordpress.org.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  You &lt;strong&gt;must&lt;/strong&gt; install the &lt;a href=&quot;https://go.cpanel.net/wordpressmanager&quot;&gt;WordPress Manager&lt;/a&gt; cPanel plugin to access this API function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the available WordPress® updates from wordpress.org.</p>
<p><strong>Note:</strong></p>
<p>  You <strong>must</strong> install the <a href="https://go.cpanel.net/wordpressmanager">WordPress Manager</a> cPanel plugin to access this API function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="cache_time" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">cache_time</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= 0 </span></span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">86400</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">cache_time=3600</span></div><div><div html="&lt;p&gt;The length of time in seconds to cache the database between requests to wordpress.org.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The length of time in seconds to cache the database between requests to wordpress.org.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="force" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">force</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">force=0</span></div><div><div html="&lt;p&gt;Whether to force a reload from the remote API. Otherwise, the
function returns information stored in local cache.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Force reload&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Read local cashe.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to force a reload from the remote API. Otherwise, the
function returns information stored in local cache.</p>
<ul>
<li><code>1</code> — Force reload</li>
<li><code>0</code> — Read local cashe.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/WordPressInstanceManager/get_latest_wordpress_version_from_wordpress_org</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/WordPressInstanceManager/get_latest_wordpress_version_from_wordpress_org</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99dd9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99dd9a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99dd9a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99dd9a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99dd9a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99dd9a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99dd9a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99dd9a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99dd9a:0" aria-labelledby="tab:R99dd9a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  WordPressInstanceManager <span class="token punctuation">\</span>
  get_latest_wordpress_version_from_wordpress_org
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99dd9a:1" aria-labelledby="tab:R99dd9a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99dd9a:2" aria-labelledby="tab:R99dd9a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99dd9a:3" aria-labelledby="tab:R99dd9a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pdd9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pdd9a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pdd9a:0" aria-labelledby="tab:R9pdd9a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_latest_wordpress_version_from_wordpress_org&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;WordPressInstanceManager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"offers"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"current"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"download"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"locale"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_version"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"new_bundled"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"packages"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"full"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"new_bundled"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"no_content"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"partial"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rollback"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"partial_version"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"php_version"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"response"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"translations"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;string&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/WordPress-Manager-Settings/operation/get_instance_by_id" data-section-id="tag/WordPress-Manager-Settings/operation/get_instance_by_id" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_instance_by_id" id="operation/get_instance_by_id" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/WordPress-Manager-Settings/operation/get_instance_by_id" aria-label="tag/WordPress-Manager-Settings/operation/get_instance_by_id"></a>Return WordPress site settings </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves a WordPress® instance&amp;#39;s configuration.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;You &lt;strong&gt;must&lt;/strong&gt; install the &lt;a href=&quot;https://go.cpanel.net/wordpressmanager&quot;&gt;WordPress Manager&lt;/a&gt; cPanel plugin to access this API function.&lt;/li&gt;
&lt;li&gt;This function retrieves some data that the system stored during the WordPress installation. That data may not reflect the most recent user changes.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a WordPress® instance&#39;s configuration.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You <strong>must</strong> install the <a href="https://go.cpanel.net/wordpressmanager">WordPress Manager</a> cPanel plugin to access this API function.</li>
<li>This function retrieves some data that the system stored during the WordPress installation. That data may not reflect the most recent user changes.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">id=cPanel__Blogs__WordPressX.0.1528208546</span></div><div><div html="&lt;p&gt;The WordPress instance&amp;#39;s unique ID.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; You can retrieve an instance ID with the &lt;code&gt;get_instances&lt;/code&gt; function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The WordPress instance&#39;s unique ID.</p>
<p><strong>Note:</strong></p>
<p> You can retrieve an instance ID with the <code>get_instances</code> function.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/WordPressInstanceManager/get_instance_by_id</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/WordPressInstanceManager/get_instance_by_id</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99fd9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99fd9a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99fd9a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99fd9a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99fd9a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99fd9a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99fd9a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99fd9a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99fd9a:0" aria-labelledby="tab:R99fd9a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  WordPressInstanceManager <span class="token punctuation">\</span>
  get_instance_by_id <span class="token punctuation">\</span>
  <span class="token assign-left variable">id</span><span class="token operator">=</span><span class="token string">'cPanel__Blogs__WordPressX.0.1528208546'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99fd9a:1" aria-labelledby="tab:R99fd9a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99fd9a:2" aria-labelledby="tab:R99fd9a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99fd9a:3" aria-labelledby="tab:R99fd9a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pfd9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pfd9a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pfd9a:0" aria-labelledby="tab:R9pfd9a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_instance_by_id&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;WordPressInstanceManager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"addon_config"</span>: <span class="token string">&quot;/home/example/.cpaddons/cPanel::Blogs::WordPressX.0.yaml&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"addon_name"</span>: <span class="token string">&quot;cPanel::Blogs::WordPressX&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"addon_type"</span>: <span class="token string">&quot;modern&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"admin_url"</span>: <span class="token string">&quot;example.com/wp-login.php&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"admin_username"</span>: <span class="token string">&quot;admin&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"admins"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"ID"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_name"</span>: <span class="token string">&quot;admin&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user_email"</span>: <span class="token string">&quot;admin@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user_login"</span>: <span class="token string">&quot;admin&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user_nicename"</span>: <span class="token string">&quot;admin&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user_status"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"autoupdate"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"autoupdate.core.has_filter"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"autoupdate.core.major"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"autoupdate.core.minor"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"available_version"</span>: <span class="token string">&quot;4.9.6&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_on"</span>: <span class="token number">1528208546</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"current_version"</span>: <span class="token string">&quot;4.9.5&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_name"</span>: <span class="token string">&quot;example_wp2&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_prefix"</span>: <span class="token string">&quot;wp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_server"</span>: <span class="token string">&quot;localhost&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_type"</span>: <span class="token string">&quot;mysql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_username"</span>: <span class="token string">&quot;example_wp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_path"</span>: <span class="token string">&quot;/home/example/public_html&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/home/example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;cPanel__Blogs__WordPressX.0.1528208546&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"initial_install_version"</span>: <span class="token string">&quot;4.7.2&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"recent"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rel_path"</span>: <span class="token string">&quot; &quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"site_url"</span>: <span class="token string">&quot;example.com/wordpress&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/WordPress-Manager-Settings/operation/get_scan_results" data-section-id="tag/WordPress-Manager-Settings/operation/get_scan_results" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_scan_results" id="operation/get_scan_results" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/WordPress-Manager-Settings/operation/get_scan_results" aria-label="tag/WordPress-Manager-Settings/operation/get_scan_results"></a>Return WordPress site scan results </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function checks the status of a completed scan and reports the results. To find more information about the scan process, read our UAPI documentation for &lt;code&gt;WordPressInstanceManager::start_scan&lt;/code&gt;.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  You &lt;strong&gt;must&lt;/strong&gt; install the &lt;a href=&quot;https://go.cpanel.net/wordpressmanager&quot;&gt;WordPress Manager&lt;/a&gt; cPanel plugin to access this API function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks the status of a completed scan and reports the results. To find more information about the scan process, read our UAPI documentation for <code>WordPressInstanceManager::start_scan</code>.</p>
<p><strong>Note:</strong></p>
<p>  You <strong>must</strong> install the <a href="https://go.cpanel.net/wordpressmanager">WordPress Manager</a> cPanel plugin to access this API function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/WordPressInstanceManager/get_scan_results</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/WordPressInstanceManager/get_scan_results</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99hd9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99hd9a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99hd9a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99hd9a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99hd9a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99hd9a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99hd9a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99hd9a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99hd9a:0" aria-labelledby="tab:R99hd9a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  WordPressInstanceManager <span class="token punctuation">\</span>
  get_scan_results
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99hd9a:1" aria-labelledby="tab:R99hd9a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99hd9a:2" aria-labelledby="tab:R99hd9a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99hd9a:3" aria-labelledby="tab:R99hd9a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9phd9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9phd9a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9phd9a:0" aria-labelledby="tab:R9phd9a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_scan_results&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;WordPressInstanceManager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"instances"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"addon_config"</span>: <span class="token string">&quot;/home/example/.cpaddons/cPanel::Blogs::WordPressX.0.yaml&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"addon_name"</span>: <span class="token string">&quot;cPanel::Blogs::WordPressX&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"addon_type"</span>: <span class="token string">&quot;modern&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"admin_url"</span>: <span class="token string">&quot;example.com/wp-login.php&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"admin_username"</span>: <span class="token string">&quot;admin&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"available_version"</span>: <span class="token string">&quot;4.9.5&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"current_version"</span>: <span class="token string">&quot;4.9.5&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_name"</span>: <span class="token string">&quot;example_wp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_prefix"</span>: <span class="token string">&quot;wp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_server"</span>: <span class="token string">&quot;localhost&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_type"</span>: <span class="token string">&quot;mysql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"db_username"</span>: <span class="token string">&quot;example_wp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"full_path"</span>: <span class="token string">&quot;/home/example/public_html&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/home/example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;cPanel__Blogs__WordPressX.0.1528208546&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"initial_install_version"</span>: <span class="token string">&quot;4.9.6&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"rel_path"</span>: <span class="token string">&quot;public_html&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"site_url"</span>: <span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_running"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/WordPress-Manager-Settings/operation/is_installable_addon_available" data-section-id="tag/WordPress-Manager-Settings/operation/is_installable_addon_available" class="sc-dntaoT ceciOs"><div data-section-id="operation/is_installable_addon_available" id="operation/is_installable_addon_available" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/WordPress-Manager-Settings/operation/is_installable_addon_available" aria-label="tag/WordPress-Manager-Settings/operation/is_installable_addon_available"></a>Verify WordPress cPAddon availability </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function verifies that the RPM-based WordPress® cPAddon exists on the system.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  You must install the WordPress Manager cPanel plugin to access this API function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function verifies that the RPM-based WordPress® cPAddon exists on the system.</p>
<p><strong>Note:</strong></p>
<p>  You must install the WordPress Manager cPanel plugin to access this API function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/WordPressInstanceManager/is_installable_addon_available</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/WordPressInstanceManager/is_installable_addon_available</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99jd9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99jd9a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99jd9a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99jd9a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99jd9a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99jd9a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99jd9a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99jd9a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99jd9a:0" aria-labelledby="tab:R99jd9a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  WordPressInstanceManager <span class="token punctuation">\</span>
  is_installable_addon_available
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99jd9a:1" aria-labelledby="tab:R99jd9a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99jd9a:2" aria-labelledby="tab:R99jd9a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99jd9a:3" aria-labelledby="tab:R99jd9a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pjd9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pjd9a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pjd9a:0" aria-labelledby="tab:R9pjd9a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;is_installable_addon_available&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;WordPressInstanceManager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/WordPress-Manager-Settings/operation/WordPressInstanceManager-start_scan" data-section-id="tag/WordPress-Manager-Settings/operation/WordPressInstanceManager-start_scan" class="sc-dntaoT ceciOs"><div data-section-id="operation/WordPressInstanceManager-start_scan" id="operation/WordPressInstanceManager-start_scan" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/WordPress-Manager-Settings/operation/WordPressInstanceManager-start_scan" aria-label="tag/WordPress-Manager-Settings/operation/WordPressInstanceManager-start_scan"></a>Start WordPress sites scan </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function scans for WordPress® instances installed on a cPanel account. The system will populate cPanel&amp;#39;s WordPress Manager interface with any newly discovered instances.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You &lt;strong&gt;must&lt;/strong&gt; install the &lt;a href=&quot;https://go.cpanel.net/wordpressmanager&quot;&gt;WordPress Manager&lt;/a&gt; cPanel plugin to access this API function.&lt;/p&gt;
&lt;h3 id=&quot;server-sent-events-sse&quot;&gt;Server Sent Events (SSE)&lt;/h3&gt;
&lt;p&gt;This function uses the following SSE events:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;register&lt;/code&gt; — The scan operation discovered a WordPress instance and registered it. The data is a
JSON-encoded object containing the attributes of the instance, with the same format used in the
UAPI &lt;code&gt;get_instances&lt;/code&gt; and UAPI &lt;code&gt;get_instance_by_id&lt;/code&gt; functions.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;found&lt;/code&gt; — The scan operation found a WordPress instance. If the WordPress instance is newly
discovered, the system will also generate a &lt;code&gt;register&lt;/code&gt; event for the instance. The data is a
JSON-encoded object containing the following:&lt;ul&gt;
&lt;li&gt;&lt;code&gt;path&lt;/code&gt; — The absolute file path to the instance.&lt;/li&gt;
&lt;/ul&gt;
&lt;/li&gt;
&lt;li&gt;&lt;code&gt;done&lt;/code&gt; — The scan is finished. The data is a JSON-encoded object that contains:&lt;ul&gt;
&lt;li&gt;&lt;code&gt;found&lt;/code&gt; — An array of strings that represents the absolute path to the discovered instances and
any instances that the system already registered.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;converted&lt;/code&gt; — An array of converted instances that the system returns in the same format
provided in the UAPI &lt;code&gt;get_instances&lt;/code&gt; and UAPI &lt;code&gt;get_instance_by_id&lt;/code&gt; functions.&lt;/li&gt;
&lt;/ul&gt;
&lt;/li&gt;
&lt;li&gt;&lt;code&gt;terminated&lt;/code&gt; — The system or user terminated the scan.	&lt;/li&gt;
&lt;li&gt;&lt;code&gt;timedout&lt;/code&gt; — The scan timed out before it completed.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;register-failed&lt;/code&gt; — The system failed to build the instance registry.	The data is a JSON-encoded
string that contains the error message.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;register-load-failed&lt;/code&gt; — The system could not load the registry after building the instance
registry. The data is a JSON-encoded string that contains the error message.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;For more information about server sent events, read Mozilla&amp;#39;s &lt;a href=&quot;https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events&quot;&gt;Using server-sent events&lt;/a&gt; documentation.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function scans for WordPress® instances installed on a cPanel account. The system will populate cPanel&#39;s WordPress Manager interface with any newly discovered instances.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> install the <a href="https://go.cpanel.net/wordpressmanager">WordPress Manager</a> cPanel plugin to access this API function.</p>
<h3 id="server-sent-events-sse">Server Sent Events (SSE)</h3>
<p>This function uses the following SSE events:</p>
<ul>
<li><code>register</code> — The scan operation discovered a WordPress instance and registered it. The data is a
JSON-encoded object containing the attributes of the instance, with the same format used in the
UAPI <code>get_instances</code> and UAPI <code>get_instance_by_id</code> functions.</li>
<li><code>found</code> — The scan operation found a WordPress instance. If the WordPress instance is newly
discovered, the system will also generate a <code>register</code> event for the instance. The data is a
JSON-encoded object containing the following:<ul>
<li><code>path</code> — The absolute file path to the instance.</li>
</ul>
</li>
<li><code>done</code> — The scan is finished. The data is a JSON-encoded object that contains:<ul>
<li><code>found</code> — An array of strings that represents the absolute path to the discovered instances and
any instances that the system already registered.</li>
<li><code>converted</code> — An array of converted instances that the system returns in the same format
provided in the UAPI <code>get_instances</code> and UAPI <code>get_instance_by_id</code> functions.</li>
</ul>
</li>
<li><code>terminated</code> — The system or user terminated the scan.	</li>
<li><code>timedout</code> — The scan timed out before it completed.</li>
<li><code>register-failed</code> — The system failed to build the instance registry.	The data is a JSON-encoded
string that contains the error message.</li>
<li><code>register-load-failed</code> — The system could not load the registry after building the instance
registry. The data is a JSON-encoded string that contains the error message.</li>
</ul>
<p>For more information about server sent events, read Mozilla&#39;s <a href="https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events">Using server-sent events</a> documentation.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/WordPressInstanceManager/start_scan</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/WordPressInstanceManager/start_scan</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99ld9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99ld9a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99ld9a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99ld9a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99ld9a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99ld9a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99ld9a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99ld9a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99ld9a:0" aria-labelledby="tab:R99ld9a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  WordPressInstanceManager <span class="token punctuation">\</span>
  start_scan
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99ld9a:1" aria-labelledby="tab:R99ld9a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99ld9a:2" aria-labelledby="tab:R99ld9a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99ld9a:3" aria-labelledby="tab:R99ld9a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pld9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pld9a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pld9a:0" aria-labelledby="tab:R9pld9a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;start_scan&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;WordPressInstanceManager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"guid"</span>: <span class="token string">&quot;B3A27B96-51F7-11E8-92E3-CC90C4F823F0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"log"</span>: <span class="token string">&quot;/home/example/.cpanel/plugins/wordpress/scans/B3A27B96-51F7-11E8-92E3-CC90C4F823F0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sse_url"</span>: <span class="token string">&quot;/sse/WordPressScan/B3A27B96-51F7-11E8-92E3-CC90C4F823F0&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/WordPress-Manager-Settings/operation/cancel_scan" data-section-id="tag/WordPress-Manager-Settings/operation/cancel_scan" class="sc-dntaoT ceciOs"><div data-section-id="operation/cancel_scan" id="operation/cancel_scan" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/WordPress-Manager-Settings/operation/cancel_scan" aria-label="tag/WordPress-Manager-Settings/operation/cancel_scan"></a>Stop WordPress site scan </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function cancels a scan that you start with the &lt;code&gt;WordPressInstanceManager::start_scan&lt;/code&gt; function.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  You &lt;strong&gt;must&lt;/strong&gt; install the &lt;a href=&quot;https://go.cpanel.net/wordpressmanager&quot;&gt;WordPress Manager&lt;/a&gt; cPanel plugin to access this API function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function cancels a scan that you start with the <code>WordPressInstanceManager::start_scan</code> function.</p>
<p><strong>Note:</strong></p>
<p>  You <strong>must</strong> install the <a href="https://go.cpanel.net/wordpressmanager">WordPress Manager</a> cPanel plugin to access this API function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/WordPressInstanceManager/cancel_scan</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/WordPressInstanceManager/cancel_scan</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99nd9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99nd9a:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99nd9a:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99nd9a:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99nd9a:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99nd9a:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99nd9a:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99nd9a:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99nd9a:0" aria-labelledby="tab:R99nd9a:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  WordPressInstanceManager <span class="token punctuation">\</span>
  cancel_scan
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99nd9a:1" aria-labelledby="tab:R99nd9a:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99nd9a:2" aria-labelledby="tab:R99nd9a:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99nd9a:3" aria-labelledby="tab:R99nd9a:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pnd9a:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pnd9a:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pnd9a:0" aria-labelledby="tab:R9pnd9a:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;cancel_scan&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;WordPressInstanceManager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/PostgreSQL-Database-Management" data-section-id="tag/PostgreSQL-Database-Management" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PostgreSQL-Database-Management" aria-label="tag/PostgreSQL-Database-Management"></a>PostgreSQL Database Management</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;PostgreSQL / Database Management&lt;/p&gt;
"><p>PostgreSQL / Database Management</p>
</div></div></div><div id="tag/PostgreSQL-Database-Management/operation/Postgresql::create_database" data-section-id="tag/PostgreSQL-Database-Management/operation/Postgresql::create_database" class="sc-dntaoT ceciOs"><div data-section-id="operation/Postgresql::create_database" id="operation/Postgresql::create_database" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PostgreSQL-Database-Management/operation/Postgresql::create_database" aria-label="tag/PostgreSQL-Database-Management/operation/Postgresql::create_database"></a>Create PostgreSQL database </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function creates a PostgreSQL® database.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;PostgreSQL role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a PostgreSQL® database.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles">PostgreSQL role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">name</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=database</span></div><div><div html="&lt;p&gt;The database&amp;#39;s name.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note&lt;/strong&gt;:&lt;/p&gt;
&lt;p&gt;  If database prefixing is enabled, this parameter &lt;strong&gt;must&lt;/strong&gt; include the database prefix for the account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database&#39;s name.</p>
<p><strong>Note</strong>:</p>
<p>  If database prefixing is enabled, this parameter <strong>must</strong> include the database prefix for the account.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Postgresql/create_database</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Postgresql/create_database</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a9j9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9j9q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9j9q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9j9q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2a9j9q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9j9q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2a9j9q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9j9q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9j9q:0" aria-labelledby="tab:R2a9j9q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Postgresql <span class="token punctuation">\</span>
  create_database <span class="token punctuation">\</span>
  <span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'database'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9j9q:1" aria-labelledby="tab:R2a9j9q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9j9q:2" aria-labelledby="tab:R2a9j9q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9j9q:3" aria-labelledby="tab:R2a9j9q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2e9j9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9j9q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9j9q:0" aria-labelledby="tab:R2e9j9q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;create_database&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Postgresql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/PostgreSQL-Database-Management/operation/Postgresql::get_restrictions" data-section-id="tag/PostgreSQL-Database-Management/operation/Postgresql::get_restrictions" class="sc-dntaoT ceciOs"><div data-section-id="operation/Postgresql::get_restrictions" id="operation/Postgresql::get_restrictions" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PostgreSQL-Database-Management/operation/Postgresql::get_restrictions" aria-label="tag/PostgreSQL-Database-Management/operation/Postgresql::get_restrictions"></a>Return PostgreSQL name length restrictions </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves the PostgreSQL® user and database name length restrictions.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;PostgreSQL&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.      &lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the PostgreSQL® user and database name length restrictions.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles"><em>PostgreSQL</em> role</a>, the system <strong>disables</strong> this function.      </p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Postgresql/get_restrictions</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Postgresql/get_restrictions</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aaj9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aaj9q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aaj9q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aaj9q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2aaj9q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aaj9q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2aaj9q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aaj9q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aaj9q:0" aria-labelledby="tab:R2aaj9q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Postgresql <span class="token punctuation">\</span>
  get_restrictions
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aaj9q:1" aria-labelledby="tab:R2aaj9q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aaj9q:2" aria-labelledby="tab:R2aaj9q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aaj9q:3" aria-labelledby="tab:R2aaj9q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eaj9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eaj9q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eaj9q:0" aria-labelledby="tab:R2eaj9q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_restrictions&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Postgresql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"max_database_name_length"</span>: <span class="token number">63</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"max_username_length"</span>: <span class="token number">63</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"prefix"</span>: <span class="token string">&quot;example_&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/PostgreSQL-Database-Management/operation/Postgresql::delete_database" data-section-id="tag/PostgreSQL-Database-Management/operation/Postgresql::delete_database" class="sc-dntaoT ceciOs"><div data-section-id="operation/Postgresql::delete_database" id="operation/Postgresql::delete_database" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PostgreSQL-Database-Management/operation/Postgresql::delete_database" aria-label="tag/PostgreSQL-Database-Management/operation/Postgresql::delete_database"></a>Delete PostgreSQL database </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function deletes a PostgreSQL® database.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Postgres role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes a PostgreSQL® database.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">Postgres role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">name</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=database</span></div><div><div html="&lt;p&gt;The database&amp;#39;s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database&#39;s name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Postgresql/delete_database</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Postgresql/delete_database</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2abj9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abj9q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abj9q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abj9q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2abj9q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abj9q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2abj9q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abj9q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abj9q:0" aria-labelledby="tab:R2abj9q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Postgresql <span class="token punctuation">\</span>
  delete_database <span class="token punctuation">\</span>
  <span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'database'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abj9q:1" aria-labelledby="tab:R2abj9q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abj9q:2" aria-labelledby="tab:R2abj9q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abj9q:3" aria-labelledby="tab:R2abj9q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ebj9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebj9q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebj9q:0" aria-labelledby="tab:R2ebj9q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;delete_database&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Postgresql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/PostgreSQL-Database-Management/operation/Postgresql-list_databases" data-section-id="tag/PostgreSQL-Database-Management/operation/Postgresql-list_databases" class="sc-dntaoT ceciOs"><div data-section-id="operation/Postgresql-list_databases" id="operation/Postgresql-list_databases" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PostgreSQL-Database-Management/operation/Postgresql-list_databases" aria-label="tag/PostgreSQL-Database-Management/operation/Postgresql-list_databases"></a>Return PostgreSQL databases </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists an account&amp;#39;s PostgreSQL® databases.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;Postgres&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists an account&#39;s PostgreSQL® databases.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles"><em>Postgres</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Postgresql/list_databases</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Postgresql/list_databases</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2acj9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2acj9q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2acj9q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acj9q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2acj9q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acj9q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2acj9q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acj9q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2acj9q:0" aria-labelledby="tab:R2acj9q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Postgresql <span class="token punctuation">\</span>
  list_databases
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acj9q:1" aria-labelledby="tab:R2acj9q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acj9q:2" aria-labelledby="tab:R2acj9q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acj9q:3" aria-labelledby="tab:R2acj9q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ecj9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ecj9q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ecj9q:0" aria-labelledby="tab:R2ecj9q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_databases&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Postgresql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"database"</span>: <span class="token string">&quot;user_db&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"disk_usage"</span>: <span class="token number">673</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"users"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;db_user&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/PostgreSQL-Database-Management/operation/rename_database" data-section-id="tag/PostgreSQL-Database-Management/operation/rename_database" class="sc-dntaoT ceciOs"><div data-section-id="operation/rename_database" id="operation/rename_database" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PostgreSQL-Database-Management/operation/rename_database" aria-label="tag/PostgreSQL-Database-Management/operation/rename_database"></a>Update PostgreSQL database name </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function renames a PostgreSQL® database.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;PostgreSQL&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function renames a PostgreSQL® database.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles"><em>PostgreSQL</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="newname" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">newname</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">newname=database2</span></div><div><div html="&lt;p&gt;The database&amp;#39;s new name.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If database prefixing is enabled, this parameter &lt;strong&gt;must&lt;/strong&gt; include the database prefix for the account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database&#39;s new name.</p>
<p><strong>Note:</strong></p>
<p>If database prefixing is enabled, this parameter <strong>must</strong> include the database prefix for the account.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="oldname" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">oldname</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">oldname=database</span></div><div><div html="&lt;p&gt;The database&amp;#39;s current name.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If database prefixing is enabled, this parameter &lt;strong&gt;must&lt;/strong&gt; include the database prefix for the account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database&#39;s current name.</p>
<p><strong>Note:</strong></p>
<p>If database prefixing is enabled, this parameter <strong>must</strong> include the database prefix for the account.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Postgresql/rename_database</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Postgresql/rename_database</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2adj9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2adj9q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2adj9q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adj9q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2adj9q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adj9q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2adj9q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adj9q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2adj9q:0" aria-labelledby="tab:R2adj9q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Postgresql <span class="token punctuation">\</span>
  rename_database <span class="token punctuation">\</span>
  <span class="token assign-left variable">oldname</span><span class="token operator">=</span><span class="token string">'database'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">newname</span><span class="token operator">=</span><span class="token string">'database2'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adj9q:1" aria-labelledby="tab:R2adj9q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adj9q:2" aria-labelledby="tab:R2adj9q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adj9q:3" aria-labelledby="tab:R2adj9q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2edj9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2edj9q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2edj9q:0" aria-labelledby="tab:R2edj9q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;rename_database&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Postgresql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/PostgreSQL-User-Management" data-section-id="tag/PostgreSQL-User-Management" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PostgreSQL-User-Management" aria-label="tag/PostgreSQL-User-Management"></a>PostgreSQL User Management</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;PostgreSQL / User Management&lt;/p&gt;
"><p>PostgreSQL / User Management</p>
</div></div></div><div id="tag/PostgreSQL-User-Management/operation/Postgresql-update_privileges" data-section-id="tag/PostgreSQL-User-Management/operation/Postgresql-update_privileges" class="sc-dntaoT ceciOs"><div data-section-id="operation/Postgresql-update_privileges" id="operation/Postgresql-update_privileges" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PostgreSQL-User-Management/operation/Postgresql-update_privileges" aria-label="tag/PostgreSQL-User-Management/operation/Postgresql-update_privileges"></a>Update PostgreSQL® privileges </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function synchronizes PostgreSQL® database user privileges on an account.&lt;/p&gt;
&lt;p&gt;Some versions of PostgreSQL are ANSI SQL-92 compliant and do not support recursive grants,
wildcard grants, or future grants. If you use phpPgAdmin, or manually create new tables, and
you want multiple PostgreSQL users to access your PostgreSQL tables, you may either call this
API function or click &lt;em&gt;Synchronize Grants&lt;/em&gt; in the &lt;em&gt;PostgreSQL Databases&lt;/em&gt; interface
(&lt;em&gt;Home &amp;gt;&amp;gt; Databases &amp;gt;&amp;gt; PostgreSQL Databases&lt;/em&gt;) after you add a table.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;PostgreSQL role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function synchronizes PostgreSQL® database user privileges on an account.</p>
<p>Some versions of PostgreSQL are ANSI SQL-92 compliant and do not support recursive grants,
wildcard grants, or future grants. If you use phpPgAdmin, or manually create new tables, and
you want multiple PostgreSQL users to access your PostgreSQL tables, you may either call this
API function or click <em>Synchronize Grants</em> in the <em>PostgreSQL Databases</em> interface
(<em>Home &gt;&gt; Databases &gt;&gt; PostgreSQL Databases</em>) after you add a table.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">PostgreSQL role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Postgresql/update_privileges</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Postgresql/update_privileges</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4khl9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4khl9q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4khl9q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4khl9q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4khl9q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4khl9q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4khl9q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4khl9q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4khl9q:0" aria-labelledby="tab:R4khl9q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Postgresql <span class="token punctuation">\</span>
  update_privileges
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4khl9q:1" aria-labelledby="tab:R4khl9q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4khl9q:2" aria-labelledby="tab:R4khl9q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4khl9q:3" aria-labelledby="tab:R4khl9q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4shl9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4shl9q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4shl9q:0" aria-labelledby="tab:R4shl9q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;update_privileges&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Postgresql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/PostgreSQL-User-Management/operation/create_user" data-section-id="tag/PostgreSQL-User-Management/operation/create_user" class="sc-dntaoT ceciOs"><div data-section-id="operation/create_user" id="operation/create_user" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PostgreSQL-User-Management/operation/create_user" aria-label="tag/PostgreSQL-User-Management/operation/create_user"></a>Create PostgreSQL user </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function creates a PostgreSQL® database user.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;PostgreSQL&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates a PostgreSQL® database user.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles"><em>PostgreSQL</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">name</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=dbuser</span></div><div><div html="&lt;p&gt;The database user&amp;#39;s name.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If database prefixing is enabled, this parameter &lt;strong&gt;must&lt;/strong&gt; include the database prefix for the account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database user&#39;s name.</p>
<p><strong>Note:</strong></p>
<p>If database prefixing is enabled, this parameter <strong>must</strong> include the database prefix for the account.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="password" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">password</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">password=123456luggage</span></div><div><div html="&lt;p&gt;The new user&amp;#39;s password.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new user&#39;s password.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Postgresql/create_user</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Postgresql/create_user</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kil9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kil9q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kil9q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kil9q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kil9q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kil9q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kil9q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kil9q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kil9q:0" aria-labelledby="tab:R4kil9q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Postgresql <span class="token punctuation">\</span>
  create_user <span class="token punctuation">\</span>
  <span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'dbuser'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">password</span><span class="token operator">=</span><span class="token string">'123456luggage'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kil9q:1" aria-labelledby="tab:R4kil9q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kil9q:2" aria-labelledby="tab:R4kil9q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kil9q:3" aria-labelledby="tab:R4kil9q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sil9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sil9q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sil9q:0" aria-labelledby="tab:R4sil9q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;create_user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Postgresql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/PostgreSQL-User-Management/operation/Postgresql::delete_user" data-section-id="tag/PostgreSQL-User-Management/operation/Postgresql::delete_user" class="sc-dntaoT ceciOs"><div data-section-id="operation/Postgresql::delete_user" id="operation/Postgresql::delete_user" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PostgreSQL-User-Management/operation/Postgresql::delete_user" aria-label="tag/PostgreSQL-User-Management/operation/Postgresql::delete_user"></a>Delete PostgreSQL user </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function deletes a PostgreSQL® user.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;PostgreSQL role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes a PostgreSQL® user.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">PostgreSQL role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">name</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=example</span></div><div><div html="&lt;p&gt;The PostgreSQL user&amp;#39;s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The PostgreSQL user&#39;s name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Postgresql/delete_user</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Postgresql/delete_user</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kjl9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kjl9q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kjl9q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kjl9q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kjl9q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kjl9q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kjl9q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kjl9q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kjl9q:0" aria-labelledby="tab:R4kjl9q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Postgresql <span class="token punctuation">\</span>
  delete_user <span class="token punctuation">\</span>
  <span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'example'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kjl9q:1" aria-labelledby="tab:R4kjl9q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kjl9q:2" aria-labelledby="tab:R4kjl9q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kjl9q:3" aria-labelledby="tab:R4kjl9q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sjl9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sjl9q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sjl9q:0" aria-labelledby="tab:R4sjl9q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;delete_user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Postgresql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/PostgreSQL-User-Management/operation/grant_all_privileges" data-section-id="tag/PostgreSQL-User-Management/operation/grant_all_privileges" class="sc-dntaoT ceciOs"><div data-section-id="operation/grant_all_privileges" id="operation/grant_all_privileges" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PostgreSQL-User-Management/operation/grant_all_privileges" aria-label="tag/PostgreSQL-User-Management/operation/grant_all_privileges"></a>Enable all user privileges on PostgreSQL database </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function grants all privileges for a PostgreSQL® database to a database user.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;&lt;em&gt;PostgreSQL&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function grants all privileges for a PostgreSQL® database to a database user.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles"><em>PostgreSQL</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="database" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">database</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">database=example_database</span></div><div><div html="&lt;p&gt;The database&amp;#39;s name.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If database prefixing is enabled, this value &lt;strong&gt;must&lt;/strong&gt; include the database prefix for the account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database&#39;s name.</p>
<p><strong>Note</strong></p>
<p>If database prefixing is enabled, this value <strong>must</strong> include the database prefix for the account.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=example_dbuser</span></div><div><div html="&lt;p&gt;The database user&amp;#39;s name.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If database prefixing is enabled, this value &lt;strong&gt;must&lt;/strong&gt; include the database prefix for the account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database user&#39;s name.</p>
<p><strong>Note</strong></p>
<p>If database prefixing is enabled, this value <strong>must</strong> include the database prefix for the account.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Postgresql/grant_all_privileges</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Postgresql/grant_all_privileges</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kkl9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kkl9q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kkl9q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kkl9q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kkl9q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kkl9q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kkl9q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kkl9q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kkl9q:0" aria-labelledby="tab:R4kkl9q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Postgresql <span class="token punctuation">\</span>
  grant_all_privileges <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'example_dbuser'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">database</span><span class="token operator">=</span><span class="token string">'example_database'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kkl9q:1" aria-labelledby="tab:R4kkl9q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kkl9q:2" aria-labelledby="tab:R4kkl9q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kkl9q:3" aria-labelledby="tab:R4kkl9q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4skl9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4skl9q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4skl9q:0" aria-labelledby="tab:R4skl9q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;grant_all_privileges&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Postgresql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/PostgreSQL-User-Management/operation/Postgresql::list_users" data-section-id="tag/PostgreSQL-User-Management/operation/Postgresql::list_users" class="sc-dntaoT ceciOs"><div data-section-id="operation/Postgresql::list_users" id="operation/Postgresql::list_users" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PostgreSQL-User-Management/operation/Postgresql::list_users" aria-label="tag/PostgreSQL-User-Management/operation/Postgresql::list_users"></a>Return PostgreSQL users </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists an account&amp;#39;s PostgreSQL® database users.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;PostgreSQL&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists an account&#39;s PostgreSQL® database users.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles"><em>PostgreSQL</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Postgresql/list_users</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Postgresql/list_users</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kll9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kll9q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kll9q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kll9q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kll9q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kll9q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kll9q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kll9q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kll9q:0" aria-labelledby="tab:R4kll9q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Postgresql <span class="token punctuation">\</span>
  list_users
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kll9q:1" aria-labelledby="tab:R4kll9q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kll9q:2" aria-labelledby="tab:R4kll9q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kll9q:3" aria-labelledby="tab:R4kll9q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sll9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sll9q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sll9q:0" aria-labelledby="tab:R4sll9q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_users&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Postgresql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example_user1&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;example_user2&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/PostgreSQL-User-Management/operation/rename_user_no_password" data-section-id="tag/PostgreSQL-User-Management/operation/rename_user_no_password" class="sc-dntaoT ceciOs"><div data-section-id="operation/rename_user_no_password" id="operation/rename_user_no_password" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PostgreSQL-User-Management/operation/rename_user_no_password" aria-label="tag/PostgreSQL-User-Management/operation/rename_user_no_password"></a>Update PostgreSQL username without password </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function renames a PostgreSQL® database user.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;If you rename a PostgreSQL user, you &lt;strong&gt;must&lt;/strong&gt; set the password for the database user. This is required because of the md5 hash that PostgreSQL creates to store user passwords.&lt;/li&gt;
&lt;li&gt;We &lt;strong&gt;strongly&lt;/strong&gt; recommend that you use the &lt;code&gt;Postgresql::rename_user function&lt;/code&gt; instead of this one.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the  &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;PostgreSQL&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function renames a PostgreSQL® database user.</p>
<p><strong>Warning:</strong></p>
<ul>
<li>If you rename a PostgreSQL user, you <strong>must</strong> set the password for the database user. This is required because of the md5 hash that PostgreSQL creates to store user passwords.</li>
<li>We <strong>strongly</strong> recommend that you use the <code>Postgresql::rename_user function</code> instead of this one.</li>
</ul>
<p><strong>Important:</strong></p>
<p>When you disable the  <a href="https://go.cpanel.net/serverroles"><em>PostgreSQL</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="newname" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">newname</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">newname=dbuser2</span></div><div><div html="&lt;p&gt;The database user&amp;#39;s new name.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If database prefixing is enabled, this parameter &lt;strong&gt;must&lt;/strong&gt; include the database prefix for the account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database user&#39;s new name.</p>
<p><strong>Note:</strong></p>
<p>If database prefixing is enabled, this parameter <strong>must</strong> include the database prefix for the account.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="oldname" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">oldname</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">oldname=dbuser</span></div><div><div html="&lt;p&gt;The database user&amp;#39;s current name.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If database prefixing is enabled, this parameter &lt;strong&gt;must&lt;/strong&gt; include the database prefix for the account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database user&#39;s current name.</p>
<p><strong>Note:</strong></p>
<p>If database prefixing is enabled, this parameter <strong>must</strong> include the database prefix for the account.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Postgresql/rename_user_no_password</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Postgresql/rename_user_no_password</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kml9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kml9q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kml9q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kml9q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kml9q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kml9q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kml9q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kml9q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kml9q:0" aria-labelledby="tab:R4kml9q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Postgresql <span class="token punctuation">\</span>
  rename_user_no_password <span class="token punctuation">\</span>
  <span class="token assign-left variable">oldname</span><span class="token operator">=</span><span class="token string">'dbuser'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">newname</span><span class="token operator">=</span><span class="token string">'dbuser2'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kml9q:1" aria-labelledby="tab:R4kml9q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kml9q:2" aria-labelledby="tab:R4kml9q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kml9q:3" aria-labelledby="tab:R4kml9q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sml9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sml9q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sml9q:0" aria-labelledby="tab:R4sml9q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;rename_user_no_password&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Postgresql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/PostgreSQL-User-Management/operation/revoke_all_privileges" data-section-id="tag/PostgreSQL-User-Management/operation/revoke_all_privileges" class="sc-dntaoT ceciOs"><div data-section-id="operation/revoke_all_privileges" id="operation/revoke_all_privileges" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PostgreSQL-User-Management/operation/revoke_all_privileges" aria-label="tag/PostgreSQL-User-Management/operation/revoke_all_privileges"></a>Remove PostgreSQL user privileges </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function revokes all privileges for a PostgreSQL® database from a database user.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;PostgreSQL&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function revokes all privileges for a PostgreSQL® database from a database user.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles"><em>PostgreSQL</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="database" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">database</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">database=example_database</span></div><div><div html="&lt;p&gt;The database&amp;#39;s name.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If database prefixing is enabled, this value &lt;strong&gt;must&lt;/strong&gt; include the database prefix for the account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database&#39;s name.</p>
<p><strong>Note</strong></p>
<p>If database prefixing is enabled, this value <strong>must</strong> include the database prefix for the account.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=example_dbuser</span></div><div><div html="&lt;p&gt;The database user&amp;#39;s name.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If database prefixing is enabled, this value &lt;strong&gt;must&lt;/strong&gt; include the database prefix for the account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database user&#39;s name.</p>
<p><strong>Note</strong></p>
<p>If database prefixing is enabled, this value <strong>must</strong> include the database prefix for the account.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Postgresql/revoke_all_privileges</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Postgresql/revoke_all_privileges</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4knl9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4knl9q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4knl9q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4knl9q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4knl9q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4knl9q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4knl9q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4knl9q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4knl9q:0" aria-labelledby="tab:R4knl9q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Postgresql <span class="token punctuation">\</span>
  revoke_all_privileges <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'example_dbuser'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">database</span><span class="token operator">=</span><span class="token string">'example_database'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4knl9q:1" aria-labelledby="tab:R4knl9q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4knl9q:2" aria-labelledby="tab:R4knl9q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4knl9q:3" aria-labelledby="tab:R4knl9q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4snl9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4snl9q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4snl9q:0" aria-labelledby="tab:R4snl9q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;revoke_all_privileges&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Postgresql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/PostgreSQL-User-Management/operation/set_password" data-section-id="tag/PostgreSQL-User-Management/operation/set_password" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_password" id="operation/set_password" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PostgreSQL-User-Management/operation/set_password" aria-label="tag/PostgreSQL-User-Management/operation/set_password"></a>Update PostgreSQL user password </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function changes a PostgreSQL® database user&amp;#39;s password.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Postgres role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function changes a PostgreSQL® database user&#39;s password.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">Postgres role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="password" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">password</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">password=12345luggage</span></div><div><div html="&lt;p&gt;The user&amp;#39;s new password.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The user&#39;s new password.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="user" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">user</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">user=dbuser</span></div><div><div html="&lt;p&gt;The database user&amp;#39;s name.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If database prefixing is enabled, this parameter &lt;strong&gt;must&lt;/strong&gt; include the database prefix for the account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database user&#39;s name.</p>
<p><strong>Note:</strong></p>
<p>If database prefixing is enabled, this parameter <strong>must</strong> include the database prefix for the account.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Postgresql/set_password</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Postgresql/set_password</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kol9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kol9q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kol9q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kol9q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kol9q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kol9q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kol9q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kol9q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kol9q:0" aria-labelledby="tab:R4kol9q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Postgresql <span class="token punctuation">\</span>
  set_password <span class="token punctuation">\</span>
  <span class="token assign-left variable">user</span><span class="token operator">=</span><span class="token string">'dbuser'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">password</span><span class="token operator">=</span><span class="token string">'12345luggage'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kol9q:1" aria-labelledby="tab:R4kol9q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kol9q:2" aria-labelledby="tab:R4kol9q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kol9q:3" aria-labelledby="tab:R4kol9q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sol9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sol9q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sol9q:0" aria-labelledby="tab:R4sol9q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_password&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Postgresql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/PostgreSQL-User-Management/operation/Postgresql::rename_user" data-section-id="tag/PostgreSQL-User-Management/operation/Postgresql::rename_user" class="sc-dntaoT ceciOs"><div data-section-id="operation/Postgresql::rename_user" id="operation/Postgresql::rename_user" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PostgreSQL-User-Management/operation/Postgresql::rename_user" aria-label="tag/PostgreSQL-User-Management/operation/Postgresql::rename_user"></a>Update PostgreSQL username </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function renames a PostgreSQL® database user.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;&lt;em&gt;PostgreSQL&lt;/em&gt; role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function renames a PostgreSQL® database user.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles"><em>PostgreSQL</em> role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="newname" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">newname</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">newname=dbuser2</span></div><div><div html="&lt;p&gt;The database user&amp;#39;s new name.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If database prefixing is enabled, this parameter &lt;strong&gt;must&lt;/strong&gt; include the database prefix for the account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database user&#39;s new name.</p>
<p><strong>Note:</strong></p>
<p>If database prefixing is enabled, this parameter <strong>must</strong> include the database prefix for the account.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="oldname" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">oldname</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">oldname=dbuser</span></div><div><div html="&lt;p&gt;The database user&amp;#39;s current name.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If database prefixing is enabled, this parameter &lt;strong&gt;must&lt;/strong&gt; include the database prefix for the account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database user&#39;s current name.</p>
<p><strong>Note:</strong></p>
<p>If database prefixing is enabled, this parameter <strong>must</strong> include the database prefix for the account.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="password" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">password</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">password=123456luggage</span></div><div><div html="&lt;p&gt;The database user&amp;#39;s new password.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The database user&#39;s new password.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Postgresql/rename_user</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Postgresql/rename_user</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kpl9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kpl9q:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kpl9q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kpl9q:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kpl9q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kpl9q:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kpl9q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kpl9q:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kpl9q:0" aria-labelledby="tab:R4kpl9q:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Postgresql <span class="token punctuation">\</span>
  rename_user <span class="token punctuation">\</span>
  <span class="token assign-left variable">oldname</span><span class="token operator">=</span><span class="token string">'dbuser'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">newname</span><span class="token operator">=</span><span class="token string">'dbuser2'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">password</span><span class="token operator">=</span><span class="token string">'123456luggage'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kpl9q:1" aria-labelledby="tab:R4kpl9q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kpl9q:2" aria-labelledby="tab:R4kpl9q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kpl9q:3" aria-labelledby="tab:R4kpl9q:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4spl9q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4spl9q:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4spl9q:0" aria-labelledby="tab:R4spl9q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;rename_user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Postgresql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Bandwidth" data-section-id="tag/Bandwidth" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Bandwidth" aria-label="tag/Bandwidth"></a>Bandwidth</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;The Bandwidth module for UAPI.&lt;/p&gt;
"><p>The Bandwidth module for UAPI.</p>
</div></div></div><div id="tag/Bandwidth/operation/get_enabled_protocols" data-section-id="tag/Bandwidth/operation/get_enabled_protocols" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_enabled_protocols" id="operation/get_enabled_protocols" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Bandwidth/operation/get_enabled_protocols" aria-label="tag/Bandwidth/operation/get_enabled_protocols"></a>Return services monitored in bandwidth data </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns a list of the server&amp;#39;s enabled protocols.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns a list of the server&#39;s enabled protocols.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Bandwidth/get_enabled_protocols</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Bandwidth/get_enabled_protocols</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiraa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiraa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiraa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiraa:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riiraa:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiraa:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riiraa:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiraa:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiraa:0" aria-labelledby="tab:Riiraa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Bandwidth <span class="token punctuation">\</span>
  get_enabled_protocols
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiraa:1" aria-labelledby="tab:Riiraa:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiraa:2" aria-labelledby="tab:Riiraa:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiraa:3" aria-labelledby="tab:Riiraa:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjiraa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiraa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiraa:0" aria-labelledby="tab:Rjiraa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_enabled_protocols&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Bandwidth&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;imap&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Bandwidth/operation/query" data-section-id="tag/Bandwidth/operation/query" class="sc-dntaoT ceciOs"><div data-section-id="operation/query" id="operation/query" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Bandwidth/operation/query" aria-label="tag/Bandwidth/operation/query"></a>Return cPanel account&#x27;s bandwidth usage report </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function queries an account&amp;#39;s bandwidth data and returns a report.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This function also returns the bandwidth use of a &lt;a href=&quot;https://go.cpanel.net/cPanelGlossary#distributed-cpanel-account&quot;&gt;distributed cPanel account&lt;/a&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function queries an account&#39;s bandwidth data and returns a report.</p>
<p><strong>Note:</strong></p>
<p>This function also returns the bandwidth use of a <a href="https://go.cpanel.net/cPanelGlossary#distributed-cpanel-account">distributed cPanel account</a>.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domains" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domains</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl"></span> - Get data for multiple domains and UNKNOWN.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl"></span> - Get data for a specific domain.</li></ul><div><div html="&lt;p&gt;A pipe-separated list of domains for which to provided data.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;If you do not include this parameter, the function will return data for all domains on the cPanel account.&lt;/li&gt;
&lt;li&gt;The &lt;code&gt;UNKNOWN&lt;/code&gt; &amp;quot;pseudo-domain&amp;quot; refers to data recorded without a specific domain. All traffic except HTTP traffic
is recorded without a specific domain.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A pipe-separated list of domains for which to provided data.</p>
<p><strong>Note:</strong></p>
<ul>
<li>If you do not include this parameter, the function will return data for all domains on the cPanel account.</li>
<li>The <code>UNKNOWN</code> &quot;pseudo-domain&quot; refers to data recorded without a specific domain. All traffic except HTTP traffic
is recorded without a specific domain.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="end" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">end</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;unix_timestamp&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">end=1446664809</span></div><div><div html="&lt;p&gt;The end date of the report window.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The end date of the report window.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="grouping" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand grouping"><span class="property-name">grouping</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl"></span> - domain|protocol|year</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl"></span> - domain|year</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl"></span> - protocol|year_month</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl"></span> - year_month_day</li></ul><div><div html="&lt;p&gt;How to group the data in the report, in pipe-separated format. This list &lt;strong&gt;must&lt;/strong&gt; contain one or both of the following parameters:&lt;/p&gt;
&lt;p&gt;A pipe-separated list that contains one or both of the following parameters:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;domain&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;protocol&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;This parameter can also include only &lt;strong&gt;one&lt;/strong&gt; of the following start time interval types:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;year&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;year_month&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;year_month_day&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;year_month_day_hour&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;year_month_day_mour_minute&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;This parameter accepts a maximum of three values.&lt;/li&gt;
&lt;li&gt;The function nests the return objects in the order that you declare the values in this parameter.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>How to group the data in the report, in pipe-separated format. This list <strong>must</strong> contain one or both of the following parameters:</p>
<p>A pipe-separated list that contains one or both of the following parameters:</p>
<ul>
<li><code>domain</code></li>
<li><code>protocol</code></li>
</ul>
<p>This parameter can also include only <strong>one</strong> of the following start time interval types:</p>
<ul>
<li><code>year</code></li>
<li><code>year_month</code></li>
<li><code>year_month_day</code></li>
<li><code>year_month_day_hour</code></li>
<li><code>year_month_day_mour_minute</code></li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li>This parameter accepts a maximum of three values.</li>
<li>The function nests the return objects in the order that you declare the values in this parameter.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="interval" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">interval</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;daily&quot;</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;daily&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;hourly&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;5min&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">interval=daily</span></div><div><div html="&lt;p&gt;Length of time between bandwidth data samples.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;daily&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;hourly&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;5min&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;The interval&amp;#39;s retention period determines availability of the interval&amp;#39;s data.
Use the &lt;code&gt;Bandwidth::get_retention_periods&lt;/code&gt; API to determine an interval&amp;#39;s retention period.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Length of time between bandwidth data samples.</p>
<ul>
<li><code>daily</code></li>
<li><code>hourly</code></li>
<li><code>5min</code></li>
</ul>
<p><strong>Note:</strong></p>
<p>The interval&#39;s retention period determines availability of the interval&#39;s data.
Use the <code>Bandwidth::get_retention_periods</code> API to determine an interval&#39;s retention period.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="protocols" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">protocols</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl"></span> - Get data for multiple protocols.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl"></span> - Get data for a specific protocol.</li></ul><div><div html="&lt;p&gt;A pipe-separated list of the protocols for which to provide data.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;http&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;imap&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;smtp&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;pop3&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;ftp&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A pipe-separated list of the protocols for which to provide data.</p>
<ul>
<li><code>http</code></li>
<li><code>imap</code></li>
<li><code>smtp</code></li>
<li><code>pop3</code></li>
<li><code>ftp</code></li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="start" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">start</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;unix_timestamp&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">start=1445664609</span></div><div><div html="&lt;p&gt;The start date of the report window.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The start date of the report window.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="timezone" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">timezone</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;olson_timezone_name&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">timezone=America/Chicago</span></div><div><div html="&lt;p&gt;The timezone in which to report the data.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The timezone in which to report the data.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Bandwidth/query</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Bandwidth/query</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rijbaa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rijbaa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rijbaa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijbaa:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rijbaa:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijbaa:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rijbaa:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijbaa:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rijbaa:0" aria-labelledby="tab:Rijbaa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Bandwidth <span class="token punctuation">\</span>
  query <span class="token punctuation">\</span>
  <span class="token assign-left variable">grouping</span><span class="token operator">=</span><span class="token string">'domain|protocol|year'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijbaa:1" aria-labelledby="tab:Rijbaa:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijbaa:2" aria-labelledby="tab:Rijbaa:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijbaa:3" aria-labelledby="tab:Rijbaa:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjjbaa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjjbaa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjjbaa:0" aria-labelledby="tab:Rjjbaa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Example</span><div class="sc-diYFot sc-frniUE jsRqjj esCYIP"><svg class="sc-kZrBCu JXohG" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="domain" selected="">domain</option><option value="domain_protocol_year">domain_protocol_year</option><option value="domain_year">domain_year</option><option value="year_domain">year_domain</option></select><label>domain</label></div></div><div><div html="&lt;p&gt;grouping=domain&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>grouping=domain</p>
</div><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"UNKNOWN"</span>: <span class="token number">70447164</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"example.com"</span>: <span class="token number">815258916235</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"parkedexample.com"</span>: <span class="token number">18861122614</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subdomain.example.com"</span>: <span class="token number">11407</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subdomain2.example.com"</span>: <span class="token number">683533</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Bandwidth/operation/get_retention_periods" data-section-id="tag/Bandwidth/operation/get_retention_periods" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_retention_periods" id="operation/get_retention_periods" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Bandwidth/operation/get_retention_periods" aria-label="tag/Bandwidth/operation/get_retention_periods"></a>Return bandwidth retention period </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves the retention periods for bandwidth data.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the retention periods for bandwidth data.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Bandwidth/get_retention_periods</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Bandwidth/get_retention_periods</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rijraa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rijraa:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rijraa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijraa:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rijraa:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijraa:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rijraa:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijraa:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rijraa:0" aria-labelledby="tab:Rijraa:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Bandwidth <span class="token punctuation">\</span>
  get_retention_periods
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijraa:1" aria-labelledby="tab:Rijraa:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijraa:2" aria-labelledby="tab:Rijraa:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijraa:3" aria-labelledby="tab:Rijraa:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjjraa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjjraa:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjjraa:0" aria-labelledby="tab:Rjjraa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_retention_periods&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Bandwidth&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"interval"</span>: <span class="token string">&quot;5min&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"retention"</span>: <span class="token number">2678400</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Known-SSH-Hosts-Management" data-section-id="tag/Known-SSH-Hosts-Management" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Known-SSH-Hosts-Management" aria-label="tag/Known-SSH-Hosts-Management"></a>Known SSH Hosts Management</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Security / Known SSH Hosts Management&lt;/p&gt;
"><p>Security / Known SSH Hosts Management</p>
</div></div></div><div id="tag/Known-SSH-Hosts-Management/operation/create" data-section-id="tag/Known-SSH-Hosts-Management/operation/create" class="sc-dntaoT ceciOs"><div data-section-id="operation/create" id="operation/create" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Known-SSH-Hosts-Management/operation/create" aria-label="tag/Known-SSH-Hosts-Management/operation/create"></a>Create host </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function registers a host in the cPanel account&amp;#39;s &lt;code&gt;/home/user/.ssh/known_hosts&lt;/code&gt; file.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function registers a host in the cPanel account&#39;s <code>/home/user/.ssh/known_hosts</code> file.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="host_name" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand host_name"><span class="property-name">host_name</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">host_name=hostname.example.com</span></div><div><div html="&lt;p&gt;The hostname or IP address to add.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hostname or IP address to add.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="port" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">port</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">22</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">port=1234</span></div><div><div html="&lt;p&gt;The SSH port to use, if the system uses a non-standard SSH port.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The SSH port to use, if the system uses a non-standard SSH port.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/KnownHosts/create</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/KnownHosts/create</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a9jaq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9jaq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9jaq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9jaq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2a9jaq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9jaq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2a9jaq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9jaq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9jaq:0" aria-labelledby="tab:R2a9jaq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  KnownHosts <span class="token punctuation">\</span>
  create <span class="token punctuation">\</span>
  <span class="token assign-left variable">host_name</span><span class="token operator">=</span><span class="token string">'hostname.example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9jaq:1" aria-labelledby="tab:R2a9jaq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9jaq:2" aria-labelledby="tab:R2a9jaq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9jaq:3" aria-labelledby="tab:R2a9jaq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2e9jaq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9jaq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9jaq:0" aria-labelledby="tab:R2e9jaq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;create&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;KnownHosts&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"host"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"host"</span>: <span class="token string">&quot;hostname.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">&quot;ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ==&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"line"</span>: <span class="token string">&quot;host.example.com ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ==&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"meta"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"algorithm"</span>: <span class="token string">&quot;ssh-rsa&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"body"</span>: <span class="token string">&quot;AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ==&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"md5"</span>: <span class="token string">&quot;b6030e39979ed0e724cea3773e014209&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"md5-printable"</span>: <span class="token string">&quot;MD5:b6:03:0e:39:97:9e:d0:e7:24:ce:a3:77:3e:01:42:09&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sha256"</span>: <span class="token string">&quot;44e405bcf4e11ab5b846e58ba0bf6dabd23dcc9e367cae17cb0c91b5b 3b3fc44&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sha256-printable"</span>: <span class="token string">&quot;SHA256:ROQFvPThGrW4RuWLoL9tq9I9zJ42fK4XywyRtbOz/EQ&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Known-SSH-Hosts-Management/operation/KnownHosts::delete" data-section-id="tag/Known-SSH-Hosts-Management/operation/KnownHosts::delete" class="sc-dntaoT ceciOs"><div data-section-id="operation/KnownHosts::delete" id="operation/KnownHosts::delete" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Known-SSH-Hosts-Management/operation/KnownHosts::delete" aria-label="tag/Known-SSH-Hosts-Management/operation/KnownHosts::delete"></a>Delete host </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function removes a host from the cPanel account&amp;#39;s &lt;code&gt;/home/user/.ssh/known_hosts&lt;/code&gt; file.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes a host from the cPanel account&#39;s <code>/home/user/.ssh/known_hosts</code> file.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="host_name" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand host_name"><span class="property-name">host_name</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">host_name=host.example.com</span></div><div><div html="&lt;p&gt;The hostname or IP address of the host to delete.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hostname or IP address of the host to delete.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="port" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">port</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= 1 </span></span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">22</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">port=1234</span></div><div><div html="&lt;p&gt;The SSH port to use.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The SSH port to use.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/KnownHosts/delete</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/KnownHosts/delete</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aajaq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aajaq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aajaq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aajaq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2aajaq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aajaq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2aajaq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aajaq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aajaq:0" aria-labelledby="tab:R2aajaq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  KnownHosts <span class="token punctuation">\</span>
  delete <span class="token punctuation">\</span>
  <span class="token assign-left variable">host_name</span><span class="token operator">=</span><span class="token string">'host.example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aajaq:1" aria-labelledby="tab:R2aajaq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aajaq:2" aria-labelledby="tab:R2aajaq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aajaq:3" aria-labelledby="tab:R2aajaq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eajaq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eajaq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eajaq:0" aria-labelledby="tab:R2eajaq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;delete&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;KnownHosts&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Known-SSH-Hosts-Management/operation/KnownHosts::update" data-section-id="tag/Known-SSH-Hosts-Management/operation/KnownHosts::update" class="sc-dntaoT ceciOs"><div data-section-id="operation/KnownHosts::update" id="operation/KnownHosts::update" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Known-SSH-Hosts-Management/operation/KnownHosts::update" aria-label="tag/Known-SSH-Hosts-Management/operation/KnownHosts::update"></a>Update host in the known_hosts file </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function updates a host&amp;#39;s entry in the cPanel account&amp;#39;s /home/user/.ssh/known_hosts file.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function updates a host&#39;s entry in the cPanel account&#39;s /home/user/.ssh/known_hosts file.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="host_name" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand host_name"><span class="property-name">host_name</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">host_name=host.example.com</span></div><div><div html="&lt;p&gt;The host to update.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The host to update.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="port" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">port</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> [ 1 .. 65535 ] </span></span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">22</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">port=1234</span></div><div><div html="&lt;p&gt;The SSH port to use.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The SSH port to use.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/KnownHosts/update</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/KnownHosts/update</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2abjaq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abjaq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abjaq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abjaq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2abjaq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abjaq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2abjaq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abjaq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abjaq:0" aria-labelledby="tab:R2abjaq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  KnownHosts <span class="token punctuation">\</span>
  update <span class="token punctuation">\</span>
  <span class="token assign-left variable">host_name</span><span class="token operator">=</span><span class="token string">'host.example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abjaq:1" aria-labelledby="tab:R2abjaq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abjaq:2" aria-labelledby="tab:R2abjaq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abjaq:3" aria-labelledby="tab:R2abjaq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ebjaq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebjaq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebjaq:0" aria-labelledby="tab:R2ebjaq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;update&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;KnownHosts&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"host"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"host"</span>: <span class="token string">&quot;host.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">&quot;ssh-rsa AAAAB3NzaC1yc2AEEEEDAQABAAABAQCsj2bNKTBSpIYDEGk9KxsGh3mySTRgMtXL583qmBpzeQ+jqCMRgBqB98u3z++J1sKlXHWfM9dyhSevkMwSbhoR8XIq/U0tCNyokEi/ueaBMCvbcTHhO7FcwzY92WK4Yt0aGROY5qX2UKSeOvuP4D6TPqKF1onSzH9bx9XUf2lEdWT/ia1NEKjunUqu1xOB/StKDHMoX4/OKyIzuS0q/T1zOATthvasJFoPrAjkohTyaDUz2LN5JoH839hViyEG82yB+MjcFV5MU3N1l1QL3cVUCh93xSaua1N85qivl+siMkPGbO5xR/En4iEY6K2XPASUEMaieWVNTRCtJ4S8H+9&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"line"</span>: <span class="token string">&quot;host.example.com ssh-rsa AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"meta"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"algorithm"</span>: <span class="token string">&quot;ssh-rsa&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"body"</span>: <span class="token string">&quot;EEEEB3NzaC1yc2EAAAADAQABAAABAQCsj2bNKTBSpIYDEGk9KxsGh3mySTRgMtXL583qmBpzeQ+jqCMRgBqB98u3z++J1sKlXHWfM9dyhSevkMwSbhoR8XIq/U0tCNyokEi/ueaBMCvbcTHhO7FcwzY92WK4Yt0aGROY5qX2UKSeOvuP4D6TPqKF1onrSzH9\\bx9XUf2lEdWT/ia1NEKjunUqu1xOB/StKDHMoX4/OKyIzuS0q/T1zOATthvasJFoPrAjkohTyaDUz2LN5JoH839hViyEG82yB+MjcFV5MU3N1l1QL3cVUCh93xSaua1N85qivl+siMkPGbO5xR/En4iEY6K2XPASUEMaieWVNTRCtJ4S8H+9&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"md5"</span>: <span class="token string">&quot;b6030e39868ed0e724cea3773e014219&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"md5-printable"</span>: <span class="token string">&quot;MD5:b6:03:0e:39:97:2e:d0:e7:24:ab:c3:77:3d:01:42:09&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sha256"</span>: <span class="token string">&quot;55a405bcf4e11ab5b846e58ba0bf6dabd23dcc9e367cae17cb0c91b5b3b3fc55&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sha256-printable"</span>: <span class="token string">&quot;SHA256:RPLFvPThGrW4RuWLoL9tq9I9zJ42fK3XywyRtbOz/EQ&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Known-SSH-Hosts-Management/operation/verify" data-section-id="tag/Known-SSH-Hosts-Management/operation/verify" class="sc-dntaoT ceciOs"><div data-section-id="operation/verify" id="operation/verify" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Known-SSH-Hosts-Management/operation/verify" aria-label="tag/Known-SSH-Hosts-Management/operation/verify"></a>Validate host </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function checks whether a host&amp;#39;s public key exists in the cPanel account&amp;#39;s &lt;code&gt;/home/user/.ssh/known_hosts&lt;/code&gt; file.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether a host&#39;s public key exists in the cPanel account&#39;s <code>/home/user/.ssh/known_hosts</code> file.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="host_name" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand host_name"><span class="property-name">host_name</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">host_name=host.example.com</span></div><div><div html="&lt;p&gt;The host to query.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The host to query.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="port" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">port</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> [ 1 .. 65535 ] </span></span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">22</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">port=1234</span></div><div><div html="&lt;p&gt;The SSH port to use.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The SSH port to use.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/KnownHosts/verify</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/KnownHosts/verify</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2acjaq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2acjaq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2acjaq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acjaq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2acjaq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acjaq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2acjaq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acjaq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2acjaq:0" aria-labelledby="tab:R2acjaq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  KnownHosts <span class="token punctuation">\</span>
  verify <span class="token punctuation">\</span>
  <span class="token assign-left variable">host_name</span><span class="token operator">=</span><span class="token string">'host.example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acjaq:1" aria-labelledby="tab:R2acjaq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acjaq:2" aria-labelledby="tab:R2acjaq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acjaq:3" aria-labelledby="tab:R2acjaq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ecjaq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ecjaq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ecjaq:0" aria-labelledby="tab:R2ecjaq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;verify&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;KnownHosts&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"errors"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;The example.com host does not exist in the known_hosts file.&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"failure_type"</span>: <span class="token string">&quot;new&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"host"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"host"</span>: <span class="token string">&quot;host.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">&quot;ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ==&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"line"</span>: <span class="token string">&quot;host.example.com ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ==&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"meta"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"algorithm"</span>: <span class="token string">&quot;ssh-rsa&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"body"</span>: <span class="token string">&quot;AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ==&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"md5"</span>: <span class="token string">&quot;b6030e39979ed0e724cea3773e014209&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"md5-printable"</span>: <span class="token string">&quot;MD5:b6:03:0e:39:97:9e:d0:e7:24:ce:a3:77:3e:01:42:09&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sha256"</span>: <span class="token string">&quot;44e405bcf4e11ab5b846e58ba0bf6dabd23dcc9e367cae17cb0c91b5b3b3fc44&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sha256-printable"</span>: <span class="token string">&quot;SHA256:ROQFvPThGrW4RuWLoL9tq9I9zJ42fK4XywyRtbOz/EQ&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Login-Information" data-section-id="tag/Login-Information" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Login-Information" aria-label="tag/Login-Information"></a>Login Information</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Security / Login Information&lt;/p&gt;
"><p>Security / Login Information</p>
</div></div></div><div id="tag/Login-Information/operation/get_last_or_current_logged_in_ip" data-section-id="tag/Login-Information/operation/get_last_or_current_logged_in_ip" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_last_or_current_logged_in_ip" id="operation/get_last_or_current_logged_in_ip" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Login-Information/operation/get_last_or_current_logged_in_ip" aria-label="tag/Login-Information/operation/get_last_or_current_logged_in_ip"></a>Return last authenticated login IP address </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the IP address of the user who most recently logged in.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the IP address of the user who most recently logged in.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/LastLogin/get_last_or_current_logged_in_ip</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/LastLogin/get_last_or_current_logged_in_ip</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R155laq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R155laq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R155laq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R155laq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R155laq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R155laq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R155laq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R155laq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R155laq:0" aria-labelledby="tab:R155laq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  LastLogin <span class="token punctuation">\</span>
  get_last_or_current_logged_in_ip
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155laq:1" aria-labelledby="tab:R155laq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155laq:2" aria-labelledby="tab:R155laq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155laq:3" aria-labelledby="tab:R155laq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R175laq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R175laq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R175laq:0" aria-labelledby="tab:R175laq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_last_or_current_logged_in_ip&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;LastLogin&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;192.168.0.1&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Login-Information/operation/get_session_information" data-section-id="tag/Login-Information/operation/get_session_information" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_session_information" id="operation/get_session_information" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Login-Information/operation/get_session_information" aria-label="tag/Login-Information/operation/get_session_information"></a>Return web server&#x27;s hostname </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves a web server&amp;#39;s hostname.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a web server&#39;s hostname.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">name</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;host&quot;</span></div><div><span class="sc-CNKsk hPAOR"> Value:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;host&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=host</span></div><div><div html="&lt;p&gt;The web server environment variable to retrieve. You can &lt;strong&gt;only&lt;/strong&gt;
retrieve the web server&amp;#39;s hostname.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;host&lt;/code&gt; is the only possible value.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The web server environment variable to retrieve. You can <strong>only</strong>
retrieve the web server&#39;s hostname.</p>
<ul>
<li><code>host</code> is the only possible value.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Variables/get_session_information</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Variables/get_session_information</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R156laq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R156laq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R156laq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R156laq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R156laq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R156laq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R156laq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R156laq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R156laq:0" aria-labelledby="tab:R156laq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Variables <span class="token punctuation">\</span>
  get_session_information
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R156laq:1" aria-labelledby="tab:R156laq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R156laq:2" aria-labelledby="tab:R156laq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R156laq:3" aria-labelledby="tab:R156laq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R176laq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R176laq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R176laq:0" aria-labelledby="tab:R176laq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_session_information&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Variables&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"host"</span>: <span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/cPanel-Server-Information" data-section-id="tag/cPanel-Server-Information" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Server-Information" aria-label="tag/cPanel-Server-Information"></a>cPanel Server Information</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Server Information / cPanel Server Information&lt;/p&gt;
"><p>Server Information / cPanel Server Information</p>
</div></div></div><div id="tag/cPanel-Server-Information/operation/get_information" data-section-id="tag/cPanel-Server-Information/operation/get_information" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_information" id="operation/get_information" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Server-Information/operation/get_information" aria-label="tag/cPanel-Server-Information/operation/get_information"></a>Return service and device status </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the status of each
&lt;a href=&quot;https://go.cpanel.net/ThecPanelWHMServiceDaemons&quot;&gt;cPanel service (daemon)&lt;/a&gt;,
device, and server health check point on your server.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the status of each
<a href="https://go.cpanel.net/ThecPanelWHMServiceDaemons">cPanel service (daemon)</a>,
device, and server health check point on your server.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/ServerInformation/get_information</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/ServerInformation/get_information</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ab3ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ab3ba:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ab3ba:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab3ba:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2ab3ba:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab3ba:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2ab3ba:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab3ba:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ab3ba:0" aria-labelledby="tab:R2ab3ba:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  ServerInformation <span class="token punctuation">\</span>
  get_information
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab3ba:1" aria-labelledby="tab:R2ab3ba:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab3ba:2" aria-labelledby="tab:R2ab3ba:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab3ba:3" aria-labelledby="tab:R2ab3ba:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eb3ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eb3ba:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eb3ba:0" aria-labelledby="tab:R2eb3ba:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_information&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;ServerInformation&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;apache_php_fpm&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;service&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;up&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;cpanel-dovecot-solr&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;service&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;up&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;cpanellogd&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;service&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;up&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;cpdavd&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;service&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;up&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;cphulkd&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;service&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;up&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;cpsrvd&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;service&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;up&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;crond&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;service&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;up&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;dnsadmin&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;service&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;up&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;exim&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;service&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;up&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">&quot;exim-4.92-1.cp1180.x86_64&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;ftpd&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;service&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;up&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;httpd&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;service&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;up&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">&quot;2.4.39&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;imap&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;service&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;up&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;ipaliases&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;service&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;up&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;lmtp&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;service&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;up&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;mailman&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;service&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;up&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;mysql&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;service&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;up&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">&quot;5.7.25&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;named&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;service&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;up&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;nscd&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;service&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;up&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;pop&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;service&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;up&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;queueprocd&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;service&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;up&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;rsyslogd&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;service&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;up&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;spamd&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;service&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;up&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;sshd&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;service&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;up&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;Server Load&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;metric&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;1.73&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;CPU Count&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;metric&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;2&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;Memory Used&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;device&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;44.12%&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;Swap&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;device&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;0.73%&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;Disk / (/)&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;device&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;26%&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;Disk /tmp (/tmp)&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;device&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;0%&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;Disk /var/tmp (/var/tmp)&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;device&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;0%&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/cPanel-Server-Information/operation/Variables-get_server_information" data-section-id="tag/cPanel-Server-Information/operation/Variables-get_server_information" class="sc-dntaoT ceciOs"><div data-section-id="operation/Variables-get_server_information" id="operation/Variables-get_server_information" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Server-Information/operation/Variables-get_server_information" aria-label="tag/cPanel-Server-Information/operation/Variables-get_server_information"></a>Return server&#x27;s configuration settings </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves the configuration settings for the cPanel &amp;amp; WHM server on which an account exists. This is useful, for example, to verify which applications and functionality are available on the account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the configuration settings for the cPanel &amp; WHM server on which an account exists. This is useful, for example, to verify which applications and functionality are available on the account.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">name</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;default_theme&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;email_filter_storage_directory&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;allow_park_subdomain_on_hostname&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;allow_remote_domains&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;allow_unregistered_domains&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;apache_port&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;apache_ssl_port&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;api_shell&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;awstats_browser_update&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;awstats_reverse_dns&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;cpanel_root_directory&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;database_prefix_required&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;display_cpanel_doclinks&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;dnsadmin_app&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;empty_trash_days&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;enable_file_protect&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;file_upload_maximum_bytes&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;file_upload_must_leave_bytes&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;file_usage&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;ftp_server&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;htaccess_check_recurse&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;invite_sub&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;ipv6_listen&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;local_nameserver_type&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;logout_redirect_url&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;mailbox_storage_format&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;mail_server&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;minimum_password_strength&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;minimum_password_strength_mysql&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;mysql_host&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;mysql_version&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;php_maximum_execution_time&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;php_post_maximum_size&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;php_system_default_version&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;php_upload_maximum_filesize&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;php_loader&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;php_open_basedir_home&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;phpmyadmin_disable_search_info_schema&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;docroots_in_public_html_only&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;require_ssl&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;allow_reset_password&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;allow_reset_password_for_subaccounts&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;disable_analog&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;skip_apache_clients_optimizer&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;disable_awstats&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;skip_mailbox_warnings_check&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;disable_boxtrapper&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;skip_bandwidth_limit_check&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;disable_mailman&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;disable_roundcube&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;disable_spamassassin&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;disable_spambox&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;disable_webalizer&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;ssl_default_key_type&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;use_information_schema&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;use_mail_for_mailman_url&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;is_mod_userdir_enabled&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;version&quot;</span> </div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=name=allow_park_subdomain_on_hostname&amp;name=allow_remote_domains&amp;name=allow_reset_password</span> - Get multiple configuration settings.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=allow_park_subdomain_on_hostname</span> - Get a single configuration setting.</li></ul><div><div html="&lt;p&gt;The server configuration settings to return.&lt;/p&gt;
&lt;details&gt;
&lt;summary&gt;Click to view information about the available server configuration settings.&lt;/summary&gt;

&lt;ul&gt;
&lt;li&gt;&lt;code&gt;default_theme&lt;/code&gt; - The cPanel interface&amp;#39;s default theme.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;email_filter_storage_directory&lt;/code&gt; - The location of the Exim email filter storage directory.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;allow_park_subdomain_on_hostname&lt;/code&gt; - Whether the system allows users to park subdomains of the server&amp;#39;s hostname.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;allow_remote_domains&lt;/code&gt; - Whether the system allows users to create addon domains or aliases that resolve to other servers.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;allow_unregistered_domains&lt;/code&gt; - Whether the system allows users to add domains they didn&amp;#39;t register with a domain name registrar.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;apache_port&lt;/code&gt; - The IP address or IP address with a firewall port number that Apache® uses to listen for requests and serve web pages over an unsecured connection.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;apache_ssl_port&lt;/code&gt; - The port or IP address that Apache uses to listen for requests and serve web pages over a secure connection.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;api_shell&lt;/code&gt; - Whether the user can access cPanel&amp;#39;s &lt;a href=&quot;https://go.cpanel.net/cpaneldocsAPIShell&quot;&gt;&lt;em&gt;API Shell&lt;/em&gt;&lt;/a&gt; interface (&lt;em&gt;cPanel &amp;gt;&amp;gt; Home &amp;gt;&amp;gt; Advanced &amp;gt;&amp;gt; API Shell&lt;/em&gt;).&lt;/li&gt;
&lt;li&gt;&lt;code&gt;awstats_browser_update&lt;/code&gt; - Whether the user can update their &lt;a href=&quot;http://awstats.sourceforge.net/&quot;&gt;AWStats&lt;/a&gt; software.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;awstats_reverse_dns&lt;/code&gt; - Whether the AWStats statistical analysis software interprets visitors&amp;#39; domain names as IP addresses.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;cpanel_root_directory&lt;/code&gt; - The cPanel &lt;code&gt;root&lt;/code&gt; directory.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;database_prefix_required&lt;/code&gt; - Whether the account requires database prefixing.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;display_cpanel_doclinks&lt;/code&gt; - Whether the system displays links to cPanel feature documentation in the cPanel interface.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;dnsadmin_app&lt;/code&gt; - The application that processes DNS management requests.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;empty_trash_days&lt;/code&gt; - The minimum age of files that the system will automatically purge from &lt;code&gt;.trash&lt;/code&gt; folders in user home directories.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;enable_file_protect&lt;/code&gt; - Whether &lt;a href=&quot;https://go.cpanel.net/EasyApache4FileprotectOption&quot;&gt;EasyApache 4&amp;#39;s &lt;em&gt;FileProtect&lt;/em&gt; option&lt;/a&gt; is enabled.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;file_upload_maximum_bytes&lt;/code&gt; - The maximum file size, in megabytes (MB), that a user can upload to a server.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;file_upload_must_leave_bytes&lt;/code&gt; - The minimum filesystem quota that the system requires after a file uploads to a server.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;file_usage&lt;/code&gt; - Whether file usage information displays in the cPanel &lt;em&gt;Home&lt;/em&gt; interface&amp;#39;s statistics bar.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;ftp_server&lt;/code&gt; - The FTP server.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;htaccess_check_recurse&lt;/code&gt; - The maximum number of directories deep to look for &lt;code&gt;.htaccess&lt;/code&gt; files when you change the PHP handler.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;invite_sub&lt;/code&gt; - Whether cPanel account users can send invitations to new Subaccount users via cPanel&amp;#39;s &lt;a href=&quot;https://go.cpanel.net/cpaneldocsUserManager&quot;&gt;&lt;em&gt;User Manager&lt;/em&gt;&lt;/a&gt; interface (&lt;em&gt;cPanel &amp;gt;&amp;gt; Home &amp;gt;&amp;gt; Preferences &amp;gt;&amp;gt; User Manager&lt;/em&gt;).&lt;/li&gt;
&lt;li&gt;&lt;code&gt;ipv6_listen&lt;/code&gt; - Whether the &lt;code&gt;cpsrvd&lt;/code&gt; daemon and other cPanel &amp;amp; WHM services listen on IPv6.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;local_nameserver_type&lt;/code&gt; - The DNS nameserver&amp;#39;s type.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;logout_redirect_url&lt;/code&gt; - The logout redirection URL.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;mailbox_storage_format&lt;/code&gt; - The mailbox storage format for new accounts.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;mail_server&lt;/code&gt; - The mailserver type.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;minimum_password_strength&lt;/code&gt; - The minimum strength for cPanel account passwords. &lt;/li&gt;
&lt;li&gt;&lt;code&gt;minimum_password_strength_mysql&lt;/code&gt; - The minimum strength for MySQL® or MariaDB® passwords.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;mysql_host&lt;/code&gt; - The MySQL or MariaDB hostname or IP address.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;mysql_version&lt;/code&gt; - The MySQL or MariaDB version.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;php_maximum_execution_time&lt;/code&gt; - The number of seconds that a PHP script can run before the system terminates it.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;php_post_maximum_size&lt;/code&gt; - The maximum size, in megabytes (MB), of a POST request.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;php_system_default_version&lt;/code&gt; - The system&amp;#39;s default version of PHP.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;php_upload_maximum_filesize&lt;/code&gt; - The maximum file size, in megabytes (MB), that a PHP script may upload.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;php_loader&lt;/code&gt; - The PHP loaders through which the system executes internal PHP scripts.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;php_open_basedir_home&lt;/code&gt; - Whether PHP &lt;code&gt;open_basedir&lt;/code&gt; protection is enabled on the server.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;phpmyadmin_disable_search_info_schema&lt;/code&gt; - Whether the user can search for the phpMyAdmin information schema.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;docroots_in_public_html_only&lt;/code&gt; - Whether the system restricts users from creating addon domains and subdomains outside of their &lt;code&gt;public_html&lt;/code&gt; directory.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;require_ssl&lt;/code&gt; - Whether the system requires passwords and other sensitive information use SSL encryption.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;allow_reset_password&lt;/code&gt; - Whether cPanel&amp;#39;s &lt;a href=&quot;https://go.cpanel.net/resetsubaccountpass&quot;&gt;&lt;em&gt;Reset Password&lt;/em&gt;&lt;/a&gt; feature is enabled for the account.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;allow_reset_password_for_subaccounts&lt;/code&gt; - Whether cPanel&amp;#39;s &lt;a href=&quot;https://go.cpanel.net/resetsubaccountpass&quot;&gt;&lt;em&gt;Reset Password&lt;/em&gt;&lt;/a&gt; feature is enabled for subaccounts on the account.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;disable_analog&lt;/code&gt; - Whether users can access the &lt;a href=&quot;https://go.cpanel.net/cpaneldocsAnalogStats&quot;&gt;&lt;em&gt;Analog Stats&lt;/em&gt;&lt;/a&gt; interface (&lt;em&gt;cPanel &amp;gt;&amp;gt; Home &amp;gt;&amp;gt; Metrics &amp;gt;&amp;gt; Analog Stats&lt;/em&gt;).&lt;/li&gt;
&lt;li&gt;&lt;code&gt;skip_apache_clients_optimizer&lt;/code&gt; - Whether the Apache Client Optimizer is enabled.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;disable_awstats&lt;/code&gt; - Whether the &lt;a href=&quot;http://awstats.sourceforge.net/&quot;&gt;AWStats&lt;/a&gt; software is enabled.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;skip_mailbox_warnings_check&lt;/code&gt; - Whether mailbox usage warnings are enabled.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;disable_boxtrapper&lt;/code&gt; - Whether &lt;a href=&quot;https://go.cpanel.net/cpaneldocsBoxTrapper&quot;&gt;&lt;em&gt;BoxTrapper&lt;/em&gt;&lt;/a&gt; is enabled.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;skip_bandwidth_limit_check&lt;/code&gt; - Whether the system automatically suspends HTTP service for accounts that exceed their bandwidth limit.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;disable_mailman&lt;/code&gt; - Whether Mailman mailing lists are enabled.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;disable_roundcube&lt;/code&gt; - Whether &lt;a href=&quot;https://roundcube.net/&quot;&gt;Roundcube webmail&lt;/a&gt; is enabled.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;disable_spamassassin&lt;/code&gt; - Whether the Apache SpamAssassin™ spam filter is enabled.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;disable_spambox&lt;/code&gt; - Whether Apache SpamAssassin&amp;#39;s spam box feature is enabled.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;disable_webalizer&lt;/code&gt; - Whether the &lt;a href=&quot;https://docs.cpanel.net/cpanel/metrics/webalizer/&quot;&gt;Webalizer&lt;/a&gt; statistics program is enabled.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;ssl_default_key_type&lt;/code&gt; - The default SSL/TLS encryption algorithm used by the system.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;use_information_schema&lt;/code&gt; - Whether the system uses the MySQL® &lt;code&gt;INFORMATION_SCHEMA&lt;/code&gt; view. This view includes disk usage by all MySQL tables in the disk usage totals.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;use_mail_for_mailman_url&lt;/code&gt; - Whether the system prefixes Mailman URLs with the &lt;code&gt;mail&lt;/code&gt; prefix. For example, &lt;code&gt;http://mail.domain.com/mailman&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;is_mod_userdir_enabled&lt;/code&gt; - Whether the &lt;a href=&quot;https://go.cpanel.net/whmdocsApachemod_userdirTweak&quot;&gt;Apache &lt;code&gt;mod_userdir&lt;/code&gt; Tweak&lt;/a&gt; is enabled.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;version&lt;/code&gt; - The system&amp;#39;s Linux® kernel version.&lt;/details&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;If you don&amp;#39;t use this parameter, this function returns &lt;strong&gt;all&lt;/strong&gt; of the server&amp;#39;s configuration settings.&lt;/li&gt;
&lt;li&gt;To retrieve multiple variables, increment this parameter. For example, &lt;code&gt;name-1=variable&lt;/code&gt;, &lt;code&gt;name-2=variable&lt;/code&gt;, &lt;code&gt;name-3=variable&lt;/code&gt;.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The server configuration settings to return.</p>
<details>
<summary>Click to view information about the available server configuration settings.</summary>

<ul>
<li><code>default_theme</code> - The cPanel interface&#39;s default theme.</li>
<li><code>email_filter_storage_directory</code> - The location of the Exim email filter storage directory.</li>
<li><code>allow_park_subdomain_on_hostname</code> - Whether the system allows users to park subdomains of the server&#39;s hostname.</li>
<li><code>allow_remote_domains</code> - Whether the system allows users to create addon domains or aliases that resolve to other servers.</li>
<li><code>allow_unregistered_domains</code> - Whether the system allows users to add domains they didn&#39;t register with a domain name registrar.</li>
<li><code>apache_port</code> - The IP address or IP address with a firewall port number that Apache® uses to listen for requests and serve web pages over an unsecured connection.</li>
<li><code>apache_ssl_port</code> - The port or IP address that Apache uses to listen for requests and serve web pages over a secure connection.</li>
<li><code>api_shell</code> - Whether the user can access cPanel&#39;s <a href="https://go.cpanel.net/cpaneldocsAPIShell"><em>API Shell</em></a> interface (<em>cPanel &gt;&gt; Home &gt;&gt; Advanced &gt;&gt; API Shell</em>).</li>
<li><code>awstats_browser_update</code> - Whether the user can update their <a href="http://awstats.sourceforge.net/">AWStats</a> software.</li>
<li><code>awstats_reverse_dns</code> - Whether the AWStats statistical analysis software interprets visitors&#39; domain names as IP addresses.</li>
<li><code>cpanel_root_directory</code> - The cPanel <code>root</code> directory.</li>
<li><code>database_prefix_required</code> - Whether the account requires database prefixing.</li>
<li><code>display_cpanel_doclinks</code> - Whether the system displays links to cPanel feature documentation in the cPanel interface.</li>
<li><code>dnsadmin_app</code> - The application that processes DNS management requests.</li>
<li><code>empty_trash_days</code> - The minimum age of files that the system will automatically purge from <code>.trash</code> folders in user home directories.</li>
<li><code>enable_file_protect</code> - Whether <a href="https://go.cpanel.net/EasyApache4FileprotectOption">EasyApache 4&#39;s <em>FileProtect</em> option</a> is enabled.</li>
<li><code>file_upload_maximum_bytes</code> - The maximum file size, in megabytes (MB), that a user can upload to a server.</li>
<li><code>file_upload_must_leave_bytes</code> - The minimum filesystem quota that the system requires after a file uploads to a server.</li>
<li><code>file_usage</code> - Whether file usage information displays in the cPanel <em>Home</em> interface&#39;s statistics bar.</li>
<li><code>ftp_server</code> - The FTP server.</li>
<li><code>htaccess_check_recurse</code> - The maximum number of directories deep to look for <code>.htaccess</code> files when you change the PHP handler.</li>
<li><code>invite_sub</code> - Whether cPanel account users can send invitations to new Subaccount users via cPanel&#39;s <a href="https://go.cpanel.net/cpaneldocsUserManager"><em>User Manager</em></a> interface (<em>cPanel &gt;&gt; Home &gt;&gt; Preferences &gt;&gt; User Manager</em>).</li>
<li><code>ipv6_listen</code> - Whether the <code>cpsrvd</code> daemon and other cPanel &amp; WHM services listen on IPv6.</li>
<li><code>local_nameserver_type</code> - The DNS nameserver&#39;s type.</li>
<li><code>logout_redirect_url</code> - The logout redirection URL.</li>
<li><code>mailbox_storage_format</code> - The mailbox storage format for new accounts.</li>
<li><code>mail_server</code> - The mailserver type.</li>
<li><code>minimum_password_strength</code> - The minimum strength for cPanel account passwords. </li>
<li><code>minimum_password_strength_mysql</code> - The minimum strength for MySQL® or MariaDB® passwords.</li>
<li><code>mysql_host</code> - The MySQL or MariaDB hostname or IP address.</li>
<li><code>mysql_version</code> - The MySQL or MariaDB version.</li>
<li><code>php_maximum_execution_time</code> - The number of seconds that a PHP script can run before the system terminates it.</li>
<li><code>php_post_maximum_size</code> - The maximum size, in megabytes (MB), of a POST request.</li>
<li><code>php_system_default_version</code> - The system&#39;s default version of PHP.</li>
<li><code>php_upload_maximum_filesize</code> - The maximum file size, in megabytes (MB), that a PHP script may upload.</li>
<li><code>php_loader</code> - The PHP loaders through which the system executes internal PHP scripts.</li>
<li><code>php_open_basedir_home</code> - Whether PHP <code>open_basedir</code> protection is enabled on the server.</li>
<li><code>phpmyadmin_disable_search_info_schema</code> - Whether the user can search for the phpMyAdmin information schema.</li>
<li><code>docroots_in_public_html_only</code> - Whether the system restricts users from creating addon domains and subdomains outside of their <code>public_html</code> directory.</li>
<li><code>require_ssl</code> - Whether the system requires passwords and other sensitive information use SSL encryption.</li>
<li><code>allow_reset_password</code> - Whether cPanel&#39;s <a href="https://go.cpanel.net/resetsubaccountpass"><em>Reset Password</em></a> feature is enabled for the account.</li>
<li><code>allow_reset_password_for_subaccounts</code> - Whether cPanel&#39;s <a href="https://go.cpanel.net/resetsubaccountpass"><em>Reset Password</em></a> feature is enabled for subaccounts on the account.</li>
<li><code>disable_analog</code> - Whether users can access the <a href="https://go.cpanel.net/cpaneldocsAnalogStats"><em>Analog Stats</em></a> interface (<em>cPanel &gt;&gt; Home &gt;&gt; Metrics &gt;&gt; Analog Stats</em>).</li>
<li><code>skip_apache_clients_optimizer</code> - Whether the Apache Client Optimizer is enabled.</li>
<li><code>disable_awstats</code> - Whether the <a href="http://awstats.sourceforge.net/">AWStats</a> software is enabled.</li>
<li><code>skip_mailbox_warnings_check</code> - Whether mailbox usage warnings are enabled.</li>
<li><code>disable_boxtrapper</code> - Whether <a href="https://go.cpanel.net/cpaneldocsBoxTrapper"><em>BoxTrapper</em></a> is enabled.</li>
<li><code>skip_bandwidth_limit_check</code> - Whether the system automatically suspends HTTP service for accounts that exceed their bandwidth limit.</li>
<li><code>disable_mailman</code> - Whether Mailman mailing lists are enabled.</li>
<li><code>disable_roundcube</code> - Whether <a href="https://roundcube.net/">Roundcube webmail</a> is enabled.</li>
<li><code>disable_spamassassin</code> - Whether the Apache SpamAssassin™ spam filter is enabled.</li>
<li><code>disable_spambox</code> - Whether Apache SpamAssassin&#39;s spam box feature is enabled.</li>
<li><code>disable_webalizer</code> - Whether the <a href="https://docs.cpanel.net/cpanel/metrics/webalizer/">Webalizer</a> statistics program is enabled.</li>
<li><code>ssl_default_key_type</code> - The default SSL/TLS encryption algorithm used by the system.</li>
<li><code>use_information_schema</code> - Whether the system uses the MySQL® <code>INFORMATION_SCHEMA</code> view. This view includes disk usage by all MySQL tables in the disk usage totals.</li>
<li><code>use_mail_for_mailman_url</code> - Whether the system prefixes Mailman URLs with the <code>mail</code> prefix. For example, <code>http://mail.domain.com/mailman</code>.</li>
<li><code>is_mod_userdir_enabled</code> - Whether the <a href="https://go.cpanel.net/whmdocsApachemod_userdirTweak">Apache <code>mod_userdir</code> Tweak</a> is enabled.</li>
<li><code>version</code> - The system&#39;s Linux® kernel version.</details></li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li>If you don&#39;t use this parameter, this function returns <strong>all</strong> of the server&#39;s configuration settings.</li>
<li>To retrieve multiple variables, increment this parameter. For example, <code>name-1=variable</code>, <code>name-2=variable</code>, <code>name-3=variable</code>.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Variables/get_server_information</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Variables/get_server_information</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ad3ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ad3ba:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ad3ba:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ad3ba:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2ad3ba:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ad3ba:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2ad3ba:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ad3ba:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ad3ba:0" aria-labelledby="tab:R2ad3ba:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Variables <span class="token punctuation">\</span>
  get_server_information
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ad3ba:1" aria-labelledby="tab:R2ad3ba:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ad3ba:2" aria-labelledby="tab:R2ad3ba:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ad3ba:3" aria-labelledby="tab:R2ad3ba:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ed3ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ed3ba:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ed3ba:0" aria-labelledby="tab:R2ed3ba:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_server_information&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Variables&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"allow_park_subdomain_on_hostname"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allow_remote_domains"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allow_reset_password"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allow_reset_password_for_subaccounts"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"allow_unregistered_domains"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"apache_port"</span>: <span class="token string">&quot;192.0.2.0:80&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"apache_ssl_port"</span>: <span class="token string">&quot;192.0.2.0:443&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"api_shell"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"awstats_browser_update"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"awstats_reverse_dns"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cpanel_root_directory"</span>: <span class="token string">&quot;/usr/local/cpanel&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"database_prefix_required"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"default_theme"</span>: <span class="token string">&quot;jupiter&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"disable_analog"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"disable_awstats"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"disable_boxtrapper"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"disable_mailman"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"disable_roundcube"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"disable_spamassassin"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"disable_spambox"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"disable_webalizer"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"display_cpanel_doclinks"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dnsadmin_app"</span>: <span class="token string">&quot;dnsadmin&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"docroots_in_public_html_only"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email_filter_storage_directory"</span>: <span class="token string">&quot;/etc/vfilters&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"empty_trash_days"</span>: <span class="token string">&quot;disabled&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enable_file_protect"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file_upload_maximum_bytes"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file_upload_must_leave_bytes"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"file_usage"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ftp_server"</span>: <span class="token string">&quot;disabled&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"htaccess_check_recurse"</span>: <span class="token number">2</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"invite_sub"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ipv6_listen"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_mod_userdir_enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"local_nameserver_type"</span>: <span class="token string">&quot;powerdns&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"logout_redirect_url"</span>: <span class="token string">&quot;</span><a href="https://cpanel.net">https://cpanel.net</a><span class="token string">&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mail_server"</span>: <span class="token string">&quot;dovecot&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mailbox_storage_format"</span>: <span class="token string">&quot;maildir&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"minimum_password_strength"</span>: <span class="token number">65</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"minimum_password_strength_mysql"</span>: <span class="token number">65</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_host"</span>: <span class="token string">&quot;localhost&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mysql_version"</span>: <span class="token string">&quot;5.7&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"php_loader"</span>: <span class="token string">&quot;ioncube&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"php_maximum_execution_time"</span>: <span class="token number">90</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"php_open_basedir_home"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"php_post_maximum_size"</span>: <span class="token number">55</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"php_system_default_version"</span>: <span class="token string">&quot;ea-php73&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"php_upload_maximum_filesize"</span>: <span class="token number">50</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phpmyadmin_disable_search_info_schema"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"require_ssl"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"skip_apache_clients_optimizer"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"skip_bandwidth_limit_check"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"skip_mailbox_warnings_check"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ssl_default_key_type"</span>: <span class="token string">&quot;rsa-2048&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"use_information_schema"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"use_mail_for_mailman_url"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">&quot;3.4&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Notifications" data-section-id="tag/Notifications" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Notifications" aria-label="tag/Notifications"></a>Notifications</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;The Notifications module for UAPI.&lt;/p&gt;
"><p>The Notifications module for UAPI.</p>
</div></div></div><div id="tag/Notifications/operation/get_notifications_count" data-section-id="tag/Notifications/operation/get_notifications_count" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_notifications_count" id="operation/get_notifications_count" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Notifications/operation/get_notifications_count" aria-label="tag/Notifications/operation/get_notifications_count"></a>Return server notifications total </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the number of server-wide notifications on an account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the number of server-wide notifications on an account.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Notifications/get_notifications_count</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Notifications/get_notifications_count</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R1575ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R1575ba:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R1575ba:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R1575ba:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R1575ba:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R1575ba:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R1575ba:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R1575ba:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R1575ba:0" aria-labelledby="tab:R1575ba:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Notifications <span class="token punctuation">\</span>
  get_notifications_count
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1575ba:1" aria-labelledby="tab:R1575ba:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1575ba:2" aria-labelledby="tab:R1575ba:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1575ba:3" aria-labelledby="tab:R1575ba:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R1775ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R1775ba:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R1775ba:0" aria-labelledby="tab:R1775ba:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_notifications_count&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Notifications&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Password-Strength" data-section-id="tag/Password-Strength" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Password-Strength" aria-label="tag/Password-Strength"></a>Password Strength</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Server Information / Password Strength&lt;/p&gt;
"><p>Server Information / Password Strength</p>
</div></div></div><div id="tag/Password-Strength/operation/get_required_strength" data-section-id="tag/Password-Strength/operation/get_required_strength" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_required_strength" id="operation/get_required_strength" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Password-Strength/operation/get_required_strength" aria-label="tag/Password-Strength/operation/get_required_strength"></a>Return minimum required password strength </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves an application&amp;#39;s minimum required password strength.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves an application&#39;s minimum required password strength.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="app" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">app</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;cpaddons&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;createacct&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;ftp&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;htaccess&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;mysql&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;passwd&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;pop&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;postgres&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;sshkey&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;webdisk&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;virtual&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">app=webdisk</span></div><div><div html="&lt;p&gt;The application&amp;#39;s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The application&#39;s name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/PasswdStrength/get_required_strength</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/PasswdStrength/get_required_strength</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R1577ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R1577ba:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R1577ba:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R1577ba:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R1577ba:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R1577ba:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R1577ba:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R1577ba:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R1577ba:0" aria-labelledby="tab:R1577ba:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  PasswdStrength <span class="token punctuation">\</span>
  get_required_strength <span class="token punctuation">\</span>
  <span class="token assign-left variable">app</span><span class="token operator">=</span><span class="token string">'webdisk'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1577ba:1" aria-labelledby="tab:R1577ba:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1577ba:2" aria-labelledby="tab:R1577ba:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1577ba:3" aria-labelledby="tab:R1577ba:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R1777ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R1777ba:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R1777ba:0" aria-labelledby="tab:R1777ba:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_required_strength&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;PasswdStrength&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"strength"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/SSH" data-section-id="tag/SSH" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSH" aria-label="tag/SSH"></a>SSH</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;The SSH module for UAPI.&lt;/p&gt;
"><p>The SSH module for UAPI.</p>
</div></div></div><div id="tag/SSH/operation/SSH-get_port" data-section-id="tag/SSH/operation/SSH-get_port" class="sc-dntaoT ceciOs"><div data-section-id="operation/SSH-get_port" id="operation/SSH-get_port" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSH/operation/SSH-get_port" aria-label="tag/SSH/operation/SSH-get_port"></a>Return SSH port </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves the server&amp;#39;s SSH port.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the server&#39;s SSH port.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSH/get_port</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSH/get_port</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R1579ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R1579ba:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R1579ba:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R1579ba:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R1579ba:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R1579ba:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R1579ba:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R1579ba:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R1579ba:0" aria-labelledby="tab:R1579ba:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSH <span class="token punctuation">\</span>
  get_port
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1579ba:1" aria-labelledby="tab:R1579ba:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1579ba:2" aria-labelledby="tab:R1579ba:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1579ba:3" aria-labelledby="tab:R1579ba:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R1779ba:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R1779ba:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R1779ba:0" aria-labelledby="tab:R1779ba:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_port&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSH&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"port"</span>: <span class="token number">22</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/ServiceProxy" data-section-id="tag/ServiceProxy" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/ServiceProxy" aria-label="tag/ServiceProxy"></a>ServiceProxy</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;The ServiceProxy module for UAPI.&lt;/p&gt;
"><p>The ServiceProxy module for UAPI.</p>
</div></div></div><div id="tag/ServiceProxy/operation/serviceproxy-get_service_proxy_backends" data-section-id="tag/ServiceProxy/operation/serviceproxy-get_service_proxy_backends" class="sc-dntaoT ceciOs"><div data-section-id="operation/serviceproxy-get_service_proxy_backends" id="operation/serviceproxy-get_service_proxy_backends" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/ServiceProxy/operation/serviceproxy-get_service_proxy_backends" aria-label="tag/ServiceProxy/operation/serviceproxy-get_service_proxy_backends"></a>Return a cPanel account’s service proxying setup </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function reports a cPanel account&amp;#39;s
&lt;a href=&quot;https://go.cpanel.net/ServiceProxying&quot;&gt;service proxying&lt;/a&gt;
configuration.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function reports a cPanel account&#39;s
<a href="https://go.cpanel.net/ServiceProxying">service proxying</a>
configuration.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/ServiceProxy/get_service_proxy_backends</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/ServiceProxy/get_service_proxy_backends</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riirbq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riirbq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riirbq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riirbq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riirbq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riirbq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riirbq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riirbq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riirbq:0" aria-labelledby="tab:Riirbq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  ServiceProxy <span class="token punctuation">\</span>
  get_service_proxy_backends
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riirbq:1" aria-labelledby="tab:Riirbq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riirbq:2" aria-labelledby="tab:Riirbq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riirbq:3" aria-labelledby="tab:Riirbq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjirbq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjirbq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjirbq:0" aria-labelledby="tab:Rjirbq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_service_proxy_backends&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;ServiceProxy&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"backend"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"service_group"</span>: <span class="token string">&quot;Mail&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/ServiceProxy/operation/serviceproxy-unset_all_service_proxy_backends" data-section-id="tag/ServiceProxy/operation/serviceproxy-unset_all_service_proxy_backends" class="sc-dntaoT ceciOs"><div data-section-id="operation/serviceproxy-unset_all_service_proxy_backends" id="operation/serviceproxy-unset_all_service_proxy_backends" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/ServiceProxy/operation/serviceproxy-unset_all_service_proxy_backends" aria-label="tag/ServiceProxy/operation/serviceproxy-unset_all_service_proxy_backends"></a>Remove cPanel account service proxying </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function removes a cPanel account&amp;#39;s
&lt;a href=&quot;https://go.cpanel.net/ServiceProxying&quot;&gt;service proxying&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;If the &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;Web Server&lt;/a&gt; role is active on
the server, this function rebuilds the cPanel user&amp;#39;s web virtual hosts (vhosts) and restarts
the web server.&lt;/li&gt;
&lt;li&gt;If the system &lt;strong&gt;cannot&lt;/strong&gt; rebuild the cPanel user&amp;#39;s vhosts, the API call will still succeed.
However, the function returns a failure warning in the metadata.&lt;/li&gt;
&lt;li&gt;To set a service proxying for a cPanel account, use the UAPI
&lt;code&gt;set_service_proxy_backends&lt;/code&gt; function.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes a cPanel account&#39;s
<a href="https://go.cpanel.net/ServiceProxying">service proxying</a>.</p>
<p><strong>Note:</strong></p>
<ul>
<li>If the <a href="https://go.cpanel.net/howtouseserverprofiles#roles">Web Server</a> role is active on
the server, this function rebuilds the cPanel user&#39;s web virtual hosts (vhosts) and restarts
the web server.</li>
<li>If the system <strong>cannot</strong> rebuild the cPanel user&#39;s vhosts, the API call will still succeed.
However, the function returns a failure warning in the metadata.</li>
<li>To set a service proxying for a cPanel account, use the UAPI
<code>set_service_proxy_backends</code> function.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/ServiceProxy/unset_all_service_proxy_backends</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/ServiceProxy/unset_all_service_proxy_backends</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rijbbq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rijbbq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rijbbq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijbbq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rijbbq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijbbq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rijbbq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijbbq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rijbbq:0" aria-labelledby="tab:Rijbbq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  ServiceProxy <span class="token punctuation">\</span>
  unset_all_service_proxy_backends
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijbbq:1" aria-labelledby="tab:Rijbbq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijbbq:2" aria-labelledby="tab:Rijbbq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijbbq:3" aria-labelledby="tab:Rijbbq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjjbbq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjjbbq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjjbbq:0" aria-labelledby="tab:Rjjbbq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;unset_all_service_proxy_backends&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;ServiceProxy&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/ServiceProxy/operation/serviceproxy-set_service_proxy_backends" data-section-id="tag/ServiceProxy/operation/serviceproxy-set_service_proxy_backends" class="sc-dntaoT ceciOs"><div data-section-id="operation/serviceproxy-set_service_proxy_backends" id="operation/serviceproxy-set_service_proxy_backends" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/ServiceProxy/operation/serviceproxy-set_service_proxy_backends" aria-label="tag/ServiceProxy/operation/serviceproxy-set_service_proxy_backends"></a>Add cPanel account service proxying </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lets you configure a cPanel account&amp;#39;s
&lt;a href=&quot;https://go.cpanel.net/ServiceProxying&quot;&gt;service proxying&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;If the &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;Web Server&lt;/a&gt; role is active
on the server, this function rebuilds the user&amp;#39;s web virtual hosts (vhosts) and restarts
the web server.&lt;/li&gt;
&lt;li&gt;If the system cannot rebuild the user&amp;#39;s vhosts, the API call will still succeed. However,
the function returns a failure warning in the metadata.&lt;/li&gt;
&lt;li&gt;To remove an account&amp;#39;s service proxying, use the UAPI &lt;code&gt;unset_all_service_proxy_backends&lt;/code&gt;
function.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lets you configure a cPanel account&#39;s
<a href="https://go.cpanel.net/ServiceProxying">service proxying</a>.</p>
<p><strong>Note:</strong></p>
<ul>
<li>If the <a href="https://go.cpanel.net/howtouseserverprofiles#roles">Web Server</a> role is active
on the server, this function rebuilds the user&#39;s web virtual hosts (vhosts) and restarts
the web server.</li>
<li>If the system cannot rebuild the user&#39;s vhosts, the API call will still succeed. However,
the function returns a failure warning in the metadata.</li>
<li>To remove an account&#39;s service proxying, use the UAPI <code>unset_all_service_proxy_backends</code>
function.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="general" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand general"><span class="property-name">general</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or string</span></div> <div><div html="&lt;p&gt;The hostname or IP address to assign as the server that handles
the account&amp;#39;s service proxy requests.&lt;/p&gt;
&lt;p&gt;This parameter defaults to the existing service proxy configuration,
if one exists.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hostname or IP address to assign as the server that handles
the account&#39;s service proxy requests.</p>
<p>This parameter defaults to the existing service proxy configuration,
if one exists.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="service_group" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">service_group</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Value:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;Mail&quot;</span> </div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">service_group=Mail&amp;service-group-1=Mail&amp;service-group-2=Mail</span> - Add multiple service backend groups.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">service_group=Mail</span> - Add a single service backend group.</li></ul><div><div html="&lt;p&gt;The name of a service group for which to assign a proxy backend. The
corresponding &lt;code&gt;service_group_backend&lt;/code&gt; value will be the service group&amp;#39;s
new proxy backend.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;Mail&lt;/code&gt; — The &lt;a href=&quot;https://go.cpanel.net/ServiceProxying#Mail&quot;&gt;Mail service group&lt;/a&gt;.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;This parameter defaults to the existing setting, if one exists.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;When you call this parameter, you &lt;strong&gt;must&lt;/strong&gt; include a corresponding
 &lt;code&gt;service_group_backend&lt;/code&gt; value.&lt;/li&gt;
&lt;li&gt;To add multiple &lt;code&gt;service_group&lt;/code&gt; values, increment the parameter name. For example,
 &lt;code&gt;service_group&lt;/code&gt;, &lt;code&gt;service_group-1&lt;/code&gt;, and &lt;code&gt;service_group-2&lt;/code&gt;.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of a service group for which to assign a proxy backend. The
corresponding <code>service_group_backend</code> value will be the service group&#39;s
new proxy backend.</p>
<ul>
<li><code>Mail</code> — The <a href="https://go.cpanel.net/ServiceProxying#Mail">Mail service group</a>.</li>
</ul>
<p>This parameter defaults to the existing setting, if one exists.</p>
<p><strong>Note:</strong></p>
<ul>
<li>When you call this parameter, you <strong>must</strong> include a corresponding
 <code>service_group_backend</code> value.</li>
<li>To add multiple <code>service_group</code> values, increment the parameter name. For example,
 <code>service_group</code>, <code>service_group-1</code>, and <code>service_group-2</code>.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="service_group_backend" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand service_group_backend"><span class="property-name">service_group_backend</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">service_group_backend=mail.example.com&amp;service_group_backend-1=mail.example1.com&amp;service_group_backend-2=mail.example2.com</span> - Add multiple service group backend servers.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">service_group_backend=mail.example.com</span> - Add a single service group backend server.</li></ul><div><div html="&lt;p&gt;The hostname or IP address of the server to assign as the corresponding
&lt;code&gt;service_group&lt;/code&gt; value&amp;#39;s proxy backend server.&lt;/p&gt;
&lt;p&gt;This parameter defaults to the existing setting, if one exists.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;When you call this parameter, you &lt;strong&gt;must&lt;/strong&gt; include a corresponding &lt;code&gt;service_group&lt;/code&gt;
 value.&lt;/li&gt;
&lt;li&gt;To add multiple &lt;code&gt;service_group_backend&lt;/code&gt; values, increment the parameter name.
 For example, &lt;code&gt;service_group_backend&lt;/code&gt;, &lt;code&gt;service_group_backend-1&lt;/code&gt;,
 and &lt;code&gt;service_group_backend-2&lt;/code&gt;.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The hostname or IP address of the server to assign as the corresponding
<code>service_group</code> value&#39;s proxy backend server.</p>
<p>This parameter defaults to the existing setting, if one exists.</p>
<p><strong>Note:</strong></p>
<ul>
<li>When you call this parameter, you <strong>must</strong> include a corresponding <code>service_group</code>
 value.</li>
<li>To add multiple <code>service_group_backend</code> values, increment the parameter name.
 For example, <code>service_group_backend</code>, <code>service_group_backend-1</code>,
 and <code>service_group_backend-2</code>.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/ServiceProxy/set_service_proxy_backends</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/ServiceProxy/set_service_proxy_backends</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rijrbq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rijrbq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rijrbq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijrbq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rijrbq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijrbq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rijrbq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijrbq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rijrbq:0" aria-labelledby="tab:Rijrbq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  ServiceProxy <span class="token punctuation">\</span>
  set_service_proxy_backends
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijrbq:1" aria-labelledby="tab:Rijrbq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijrbq:2" aria-labelledby="tab:Rijrbq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijrbq:3" aria-labelledby="tab:Rijrbq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjjrbq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjjrbq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjjrbq:0" aria-labelledby="tab:Rjjrbq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_service_proxy_backends&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;ServiceProxy&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Auto-generated-SSL-Certificates" data-section-id="tag/Auto-generated-SSL-Certificates" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Auto-generated-SSL-Certificates" aria-label="tag/Auto-generated-SSL-Certificates"></a>Auto-generated SSL Certificates</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;SSL Certificates / Auto-generated SSL Certificates&lt;/p&gt;
"><p>SSL Certificates / Auto-generated SSL Certificates</p>
</div></div></div><div id="tag/Auto-generated-SSL-Certificates/operation/add_autossl_excluded_domains" data-section-id="tag/Auto-generated-SSL-Certificates/operation/add_autossl_excluded_domains" class="sc-dntaoT ceciOs"><div data-section-id="operation/add_autossl_excluded_domains" id="operation/add_autossl_excluded_domains" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Auto-generated-SSL-Certificates/operation/add_autossl_excluded_domains" aria-label="tag/Auto-generated-SSL-Certificates/operation/add_autossl_excluded_domains"></a>Disable AutoSSL for domains </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function disables AutoSSL for the domains that you specify.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;roles&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables AutoSSL for the domains that you specify.</p>
<p><strong>Important:</strong></p>
<p>When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server <a href="https://go.cpanel.net/serverroles">roles</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domains" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domains</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domains=example.com,example2.com</span></div><div><div html="&lt;p&gt;A comma-separated list of domains for which to disable AutoSSL.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;For browser-based calls, use a URI encoded comma (&lt;code&gt;%2C&lt;/code&gt;).&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A comma-separated list of domains for which to disable AutoSSL.</p>
<p><strong>Note:</strong></p>
<p>For browser-based calls, use a URI encoded comma (<code>%2C</code>).</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/add_autossl_excluded_domains</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/add_autossl_excluded_domains</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kj3ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kj3ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kj3ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj3ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kj3ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj3ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kj3ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj3ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kj3ca:0" aria-labelledby="tab:R4kj3ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  add_autossl_excluded_domains <span class="token punctuation">\</span>
  <span class="token assign-left variable">domains</span><span class="token operator">=</span><span class="token string">'example.com,example2.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj3ca:1" aria-labelledby="tab:R4kj3ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj3ca:2" aria-labelledby="tab:R4kj3ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj3ca:3" aria-labelledby="tab:R4kj3ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sj3ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sj3ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sj3ca:0" aria-labelledby="tab:R4sj3ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;add_autossl_excluded_domains&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Auto-generated-SSL-Certificates/operation/get_autossl_excluded_domains" data-section-id="tag/Auto-generated-SSL-Certificates/operation/get_autossl_excluded_domains" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_autossl_excluded_domains" id="operation/get_autossl_excluded_domains" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Auto-generated-SSL-Certificates/operation/get_autossl_excluded_domains" aria-label="tag/Auto-generated-SSL-Certificates/operation/get_autossl_excluded_domains"></a>Return AutoSSL disabled domains </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the domains with AutoSSL disabled.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the domains with AutoSSL disabled.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/get_autossl_excluded_domains</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/get_autossl_excluded_domains</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kl3ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kl3ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kl3ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl3ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kl3ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl3ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kl3ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl3ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kl3ca:0" aria-labelledby="tab:R4kl3ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  get_autossl_excluded_domains
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl3ca:1" aria-labelledby="tab:R4kl3ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl3ca:2" aria-labelledby="tab:R4kl3ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl3ca:3" aria-labelledby="tab:R4kl3ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sl3ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sl3ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sl3ca:0" aria-labelledby="tab:R4sl3ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_autossl_excluded_domains&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"excluded_domain"</span>: <span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Auto-generated-SSL-Certificates/operation/get_autossl_problems" data-section-id="tag/Auto-generated-SSL-Certificates/operation/get_autossl_problems" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_autossl_problems" id="operation/get_autossl_problems" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Auto-generated-SSL-Certificates/operation/get_autossl_problems" aria-label="tag/Auto-generated-SSL-Certificates/operation/get_autossl_problems"></a>Return domains with AutoSSL problems </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves a list of domains that possess AutoSSL problems.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a list of domains that possess AutoSSL problems.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/get_autossl_problems</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/get_autossl_problems</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kn3ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kn3ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kn3ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn3ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kn3ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn3ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kn3ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn3ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kn3ca:0" aria-labelledby="tab:R4kn3ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  get_autossl_problems
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn3ca:1" aria-labelledby="tab:R4kn3ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn3ca:2" aria-labelledby="tab:R4kn3ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn3ca:3" aria-labelledby="tab:R4kn3ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sn3ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sn3ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sn3ca:0" aria-labelledby="tab:R4sn3ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_autossl_problems&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"problem"</span>: <span class="token string">&quot;example.com contains 400 domains, which exceeds the maximum number (200) of domains allowed for the \&quot;Sectigo\&quot; AutoSSL provider. This system will include those 200 domains on the certificate that appear to be the website's most important. To allow AutoSSL to secure each domain, divide the 400 domains among separate websites. (The websites can all serve the same content from the same document root.)&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"time"</span>: <span class="token string">&quot;2018-06-07T05:30:09Z&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Auto-generated-SSL-Certificates/operation/is_autossl_check_in_progress" data-section-id="tag/Auto-generated-SSL-Certificates/operation/is_autossl_check_in_progress" class="sc-dntaoT ceciOs"><div data-section-id="operation/is_autossl_check_in_progress" id="operation/is_autossl_check_in_progress" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Auto-generated-SSL-Certificates/operation/is_autossl_check_in_progress" aria-label="tag/Auto-generated-SSL-Certificates/operation/is_autossl_check_in_progress"></a>Return whether AutoSSL check in progress </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function verifies whether the &lt;code&gt;autossl_check&lt;/code&gt; task is in progress for the current user.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function verifies whether the <code>autossl_check</code> task is in progress for the current user.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/is_autossl_check_in_progress</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/is_autossl_check_in_progress</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kp3ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kp3ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kp3ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp3ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kp3ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp3ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kp3ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp3ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kp3ca:0" aria-labelledby="tab:R4kp3ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  is_autossl_check_in_progress
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp3ca:1" aria-labelledby="tab:R4kp3ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp3ca:2" aria-labelledby="tab:R4kp3ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp3ca:3" aria-labelledby="tab:R4kp3ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sp3ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sp3ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sp3ca:0" aria-labelledby="tab:R4sp3ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;is_autossl_check_in_progress&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Auto-generated-SSL-Certificates/operation/remove_autossl_excluded_domains" data-section-id="tag/Auto-generated-SSL-Certificates/operation/remove_autossl_excluded_domains" class="sc-dntaoT ceciOs"><div data-section-id="operation/remove_autossl_excluded_domains" id="operation/remove_autossl_excluded_domains" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Auto-generated-SSL-Certificates/operation/remove_autossl_excluded_domains" aria-label="tag/Auto-generated-SSL-Certificates/operation/remove_autossl_excluded_domains"></a>Enable AutoSSL for specifed domains </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function enables AutoSSL for the domains that you specify.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables AutoSSL for the domains that you specify.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domains" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domains</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domains=domains=example1.com,example2.com</span> - Multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domains=example.com</span> - A single domain.</li></ul><div><div html="&lt;p&gt;Enable AutoSSL for this domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Enable AutoSSL for this domain.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/remove_autossl_excluded_domains</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/remove_autossl_excluded_domains</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kr3ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kr3ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kr3ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kr3ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kr3ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kr3ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kr3ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kr3ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kr3ca:0" aria-labelledby="tab:R4kr3ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  remove_autossl_excluded_domains <span class="token punctuation">\</span>
  <span class="token assign-left variable">domains</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kr3ca:1" aria-labelledby="tab:R4kr3ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kr3ca:2" aria-labelledby="tab:R4kr3ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kr3ca:3" aria-labelledby="tab:R4kr3ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sr3ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sr3ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sr3ca:0" aria-labelledby="tab:R4sr3ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;remove_autossl_excluded_domains&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Auto-generated-SSL-Certificates/operation/set_autossl_excluded_domains" data-section-id="tag/Auto-generated-SSL-Certificates/operation/set_autossl_excluded_domains" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_autossl_excluded_domains" id="operation/set_autossl_excluded_domains" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Auto-generated-SSL-Certificates/operation/set_autossl_excluded_domains" aria-label="tag/Auto-generated-SSL-Certificates/operation/set_autossl_excluded_domains"></a>Disable AutoSSL for specifed domains </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function disables AutoSSL for every domain that you specify.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This function &lt;strong&gt;replaces&lt;/strong&gt; the list of any domains that you previously excluded. To add domains to the list of excluded domains, use the UAPI function &lt;code&gt;SSL::add_autossl_excluded_domains&lt;/code&gt;.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Calendar and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables AutoSSL for every domain that you specify.</p>
<p><strong>Warning:</strong></p>
<p>This function <strong>replaces</strong> the list of any domains that you previously excluded. To add domains to the list of excluded domains, use the UAPI function <code>SSL::add_autossl_excluded_domains</code>.</p>
<p><strong>Important:</strong></p>
<p>When you disable the the <a href="https://go.cpanel.net/serverroles">Calendar and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domains" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domains</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domains=example.com,example.net</span></div><div><div html="&lt;p&gt;A comma-separated list of domains for which to disable AutoSSL.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If you do not include this parameter, the function will &lt;strong&gt;enable&lt;/strong&gt; AutoSSL for every domain on the account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A comma-separated list of domains for which to disable AutoSSL.</p>
<p><strong>Note:</strong></p>
<p>If you do not include this parameter, the function will <strong>enable</strong> AutoSSL for every domain on the account.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/set_autossl_excluded_domains</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/set_autossl_excluded_domains</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kt3ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kt3ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kt3ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kt3ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kt3ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kt3ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kt3ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kt3ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kt3ca:0" aria-labelledby="tab:R4kt3ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  set_autossl_excluded_domains
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kt3ca:1" aria-labelledby="tab:R4kt3ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kt3ca:2" aria-labelledby="tab:R4kt3ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kt3ca:3" aria-labelledby="tab:R4kt3ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4st3ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4st3ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4st3ca:0" aria-labelledby="tab:R4st3ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_autossl_excluded_domains&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Auto-generated-SSL-Certificates/operation/start_autossl_check" data-section-id="tag/Auto-generated-SSL-Certificates/operation/start_autossl_check" class="sc-dntaoT ceciOs"><div data-section-id="operation/start_autossl_check" id="operation/start_autossl_check" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Auto-generated-SSL-Certificates/operation/start_autossl_check" aria-label="tag/Auto-generated-SSL-Certificates/operation/start_autossl_check"></a>Start AutoSSL for current user </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function initiates an &lt;a href=&quot;https://go.cpanel.net/whmdocsManageAutoSSL&quot;&gt;AutoSSL&lt;/a&gt; check for the user.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and  Web Server &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;roles&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function initiates an <a href="https://go.cpanel.net/whmdocsManageAutoSSL">AutoSSL</a> check for the user.</p>
<p><strong>Important:</strong></p>
<p>When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and  Web Server <a href="https://go.cpanel.net/serverroles">roles</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/start_autossl_check</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/start_autossl_check</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kv3ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kv3ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kv3ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kv3ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kv3ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kv3ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kv3ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kv3ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kv3ca:0" aria-labelledby="tab:R4kv3ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  start_autossl_check
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kv3ca:1" aria-labelledby="tab:R4kv3ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kv3ca:2" aria-labelledby="tab:R4kv3ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kv3ca:3" aria-labelledby="tab:R4kv3ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sv3ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sv3ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sv3ca:0" aria-labelledby="tab:R4sv3ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;start_autossl_check&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/cPanel-Account-SSL-Management" data-section-id="tag/cPanel-Account-SSL-Management" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-SSL-Management" aria-label="tag/cPanel-Account-SSL-Management"></a>cPanel Account SSL Management</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;SSL Certificates / cPanel Account SSL Management&lt;/p&gt;
"><p>SSL Certificates / cPanel Account SSL Management</p>
</div></div></div><div id="tag/cPanel-Account-SSL-Management/operation/can_ssl_redirect" data-section-id="tag/cPanel-Account-SSL-Management/operation/can_ssl_redirect" class="sc-dntaoT ceciOs"><div data-section-id="operation/can_ssl_redirect" id="operation/can_ssl_redirect" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-SSL-Management/operation/can_ssl_redirect" aria-label="tag/cPanel-Account-SSL-Management/operation/can_ssl_redirect"></a>Return whether domains can redirect to secure URL </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function determines whether the system can automatically redirect domains on a cPanel account to use SSL.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function determines whether the system can automatically redirect domains on a cPanel account to use SSL.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/can_ssl_redirect</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/can_ssl_redirect</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rii35ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rii35ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rii35ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii35ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rii35ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii35ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rii35ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii35ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rii35ca:0" aria-labelledby="tab:Rii35ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  can_ssl_redirect
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii35ca:1" aria-labelledby="tab:Rii35ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii35ca:2" aria-labelledby="tab:Rii35ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii35ca:3" aria-labelledby="tab:Rii35ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rji35ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rji35ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rji35ca:0" aria-labelledby="tab:Rji35ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;can_ssl_redirect&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/cPanel-Account-SSL-Management/operation/delete_ssl" data-section-id="tag/cPanel-Account-SSL-Management/operation/delete_ssl" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete_ssl" id="operation/delete_ssl" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-SSL-Management/operation/delete_ssl" aria-label="tag/cPanel-Account-SSL-Management/operation/delete_ssl"></a>Remove SSL for domain </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function removes SSL from a domain.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This function removes domains from the current certificate to end SSL coverage for those
domains. To delete certificates from SSL storage, use the UAPI function &lt;code&gt;SSL::delete_cert&lt;/code&gt;
instead.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, &lt;strong&gt;and&lt;/strong&gt; Web Server
&lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;roles&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes SSL from a domain.</p>
<p><strong>Note:</strong></p>
<p>This function removes domains from the current certificate to end SSL coverage for those
domains. To delete certificates from SSL storage, use the UAPI function <code>SSL::delete_cert</code>
instead.</p>
<p><strong>Important:</strong></p>
<p>When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, <strong>and</strong> Web Server
<a href="https://go.cpanel.net/serverroles">roles</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The domain name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/delete_ssl</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/delete_ssl</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rii55ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rii55ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rii55ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii55ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rii55ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii55ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rii55ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii55ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rii55ca:0" aria-labelledby="tab:Rii55ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  delete_ssl <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii55ca:1" aria-labelledby="tab:Rii55ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii55ca:2" aria-labelledby="tab:Rii55ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii55ca:3" aria-labelledby="tab:Rii55ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rji55ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rji55ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rji55ca:0" aria-labelledby="tab:Rji55ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;delete_ssl&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;The SSL host was successfully removed.&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/cPanel-Account-SSL-Management/operation/check_shared_cert" data-section-id="tag/cPanel-Account-SSL-Management/operation/check_shared_cert" class="sc-dntaoT ceciOs"><div data-section-id="operation/check_shared_cert" id="operation/check_shared_cert" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-SSL-Management/operation/check_shared_cert" aria-label="tag/cPanel-Account-SSL-Management/operation/check_shared_cert"></a>Return whether shared SSL certificate exists <span type="warning" class="sc-jtQUzJ jmDXKf"> Deprecated </span></h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function checks whether a shared SSL certificate is associated with the account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether a shared SSL certificate is associated with the account.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/check_shared_cert</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/check_shared_cert</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rii75ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rii75ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rii75ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii75ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rii75ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii75ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rii75ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii75ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rii75ca:0" aria-labelledby="tab:Rii75ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  check_shared_cert
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii75ca:1" aria-labelledby="tab:Rii75ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii75ca:2" aria-labelledby="tab:Rii75ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii75ca:3" aria-labelledby="tab:Rii75ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rji75ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rji75ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rji75ca:0" aria-labelledby="tab:Rji75ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;check_shared_cert&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/cPanel-Account-SSL-Management/operation/fetch_best_for_domain" data-section-id="tag/cPanel-Account-SSL-Management/operation/fetch_best_for_domain" class="sc-dntaoT ceciOs"><div data-section-id="operation/fetch_best_for_domain" id="operation/fetch_best_for_domain" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-SSL-Management/operation/fetch_best_for_domain" aria-label="tag/cPanel-Account-SSL-Management/operation/fetch_best_for_domain"></a>Request best SSL certificate </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves the best-available certificate for the domain. The function also
retrieves the certificate&amp;#39;s associated private key and CA bundle, if available.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the best-available certificate for the domain. The function also
retrieves the certificate&#39;s associated private key and CA bundle, if available.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The domain name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/fetch_best_for_domain</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/fetch_best_for_domain</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rii95ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rii95ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rii95ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii95ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rii95ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii95ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rii95ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii95ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rii95ca:0" aria-labelledby="tab:Rii95ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  fetch_best_for_domain <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii95ca:1" aria-labelledby="tab:Rii95ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii95ca:2" aria-labelledby="tab:Rii95ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii95ca:3" aria-labelledby="tab:Rii95ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rji95ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rji95ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rji95ca:0" aria-labelledby="tab:Rji95ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;fetch_best_for_domain&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"cab"</span>: <span class="token string">&quot;-----BEGIN CERTIFICATE-----\nMIID/DCCAuSgZwBBAvIFANEXIaYwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL\nZXhhbXBsZS5jb20wHhcNMjAwNDA2MTY0NDU2WhcNMjEwNDA2MTY0NDU2WjAWMRQw\nEgYDVQQDDAtleGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC\nggEBALuCGWz/aFOr5TPBehISu3LkcGvnNFg9eY8rVXbNFfpBzyzdWrx5IiMtBcDx\nAZXMOU7GSZyFhSB6cjNfCaESXC/gBTa0sZ/b4b4etNUlNHUFAatb9WckQ6AtWbVA\npxu8aw/5AjAKgMbkaNrUY3vzLzin11CyGOFkbAKwVqT13Z3Yyz/xuz7x2+yMwPBh\n9mEP0tXjvCz7NzETFSTysn9Sf+VjUle0upnpl8Q7GK52CDpvwdqE/O6MrTx/XrXm\nYUfeSkZd+nqFm4oxmrf01hOL2IlEit1RupILwVm2/8CK2sAdazTqh4LapA962b9V\nSKm31YbsGT3kQg5EERbjIgiN6M8CAwEAAaOCAU8wggFLMB0GA1UdDgQWBBRhFUQb\nh7YE6tgcpiHke60td96d4zAJBgNVHRMEAjAAMEIGA1UdIwQ7MDmAFGEVRBuHtgTq\n2BymIeR7rS133p3joRqkGDAWMRQwEgYDVQQDDAtleGFtcGxlLmNvbYIFANEXIaYw\nHQYDVR0lBBYwFAYIKwYBBQUHAwEGCCsGAQUFBwMCMIG7BgNVHREEgbMwgbCCC2V4\nYW1wbGUuY29tghBtYWlsLmV4YW1wbGUuY29tgg93d3cuZXhhbXBsZS5jb22CEmNw\nYW5lbC5leGFtcGxlLmNvbYITd2VibWFpbC5leGFtcGxlLmNvbYITd2ViZGlzay5l\neGFtcGxlLmNvbYIWY3Bjb250YWN0cy5leGFtcGxlLmNvbYIXY3BjYWxlbmRhcnMu\nZXhhbXBsZS5jb22CD3dobS5leGFtcGxlLmNvbTANBgkqhkiG9w0BAQsFAAOCAQEA\nT0TaI0ypM3eqtRSddgyoy5+nXi8a9a8xFKrwEAljBua3rNR6fOfedMOg9NFwCmQD\nw96/eZJjq+xMh57yLEGu05OBbyFVsdu2AXVhwHeBaURrGn5p7IjNM+dB+ld+oCnP\nex6iisbsfxwUqa7y2vqTU5XaUiXfccqEz8ofvuTcqNs8bgGn0Tm90XbgGnPVd7zl\nGm4t7Gf2pvMNd2R1prJ07z42bp/z8E2DcFhb/QZnblFOhJ8jPspxYK4G5XmwwYZD\n79NDK47OyG3hTiinxroKMjqIgnLT7ZabDMGHJkcg5xOL/VdYi7ZGHAnBEwA8eadO\ndh3jFPxGGIBJTTmKIScSrm==\n-----END CERTIFICATE-----&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"crt"</span>: <span class="token string">&quot;-----BEGIN CERTIFICATE-----\nMIID/DCCAuSgZwBBAvIFANEXIaYwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL\nZXhhbXBsZS5jb20wHhcNMjAwNDA2MTY0NDU2WhcNMjEwNDA2MTY0NDU2WjAWMRQw\nEgYDVQQDDAtleGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC\nggEBALuCGWz/aFOr5TPBehISu3LkcGvnNFg9eY8rVXbNFfpBzyzdWrx5IiMtBcDx\nAZXMOU7GSZyFhSB6cjNfCaESXC/gBTa0sZ/b4b4etNUlNHUFAatb9WckQ6AtWbVA\npxu8aw/5AjAKgMbkaNrUY3vzLzin11CyGOFkbAKwVqT13Z3Yyz/xuz7x2+yMwPBh\n9mEP0tXjvCz7NzETFSTysn9Sf+VjUle0upnpl8Q7GK52CDpvwdqE/O6MrTx/XrXm\nYUfeSkZd+nqFm4oxmrf01hOL2IlEit1RupILwVm2/8CK2sAdazTqh4LapA962b9V\nSKm31YbsGT3kQg5EERbjIgiN6M8CAwEAAaOCAU8wggFLMB0GA1UdDgQWBBRhFUQb\nh7YE6tgcpiHke60td96d4zAJBgNVHRMEAjAAMEIGA1UdIwQ7MDmAFGEVRBuHtgTq\n2BymIeR7rS133p3joRqkGDAWMRQwEgYDVQQDDAtleGFtcGxlLmNvbYIFANEXIaYw\nHQYDVR0lBBYwFAYIKwYBBQUHAwEGCCsGAQUFBwMCMIG7BgNVHREEgbMwgbCCC2V4\nYW1wbGUuY29tghBtYWlsLmV4YW1wbGUuY29tgg93d3cuZXhhbXBsZS5jb22CEmNw\nYW5lbC5leGFtcGxlLmNvbYITd2VibWFpbC5leGFtcGxlLmNvbYITd2ViZGlzay5l\neGFtcGxlLmNvbYIWY3Bjb250YWN0cy5leGFtcGxlLmNvbYIXY3BjYWxlbmRhcnMu\nZXhhbXBsZS5jb22CD3dobS5leGFtcGxlLmNvbTANBgkqhkiG9w0BAQsFAAOCAQEA\nT0TaI0ypM3eqtRSddgyoy5+nXi8a7a6xFKrwEAljBua3rNR6fOfedMOg9NFwCmQD\nw96/eZJjq+xMh57yLEGu05OBbyFVsdu2AXVhwHeBaURrGn5p7IjNMjdB+ld+oCmU\nex6iisbsfxwUqa7y2vqTU5XaUiXfccqEz8ofvuTcqNs8bgGn0Tm90XbgGnPVd7zl\nGm4t7Gf2pvMNd2R1prJ07z42bp/z8E2DcFhb/RPnblFOhJ8jPspxYK4G5XmwwYZD\n79NDK47OyG3hTiinxroKMjqIgnLT4ZabDMGHJkcg5xOL/VdYi7ZGHAnBEwA8eadO\ndh3jFPxGGIBJTTmKIScSbg==\n-----END CERTIFICATE-----&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"crt_origin"</span>: <span class="token string">&quot;username&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip"</span>: <span class="token string">&quot;192.168.0.1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">&quot;-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBBCKAAQNAu4IZbP0oU6vlM8F6EhK9cuRrs+c1WD24jytPds0V+kH+LN1a\nvHkiIy0FwPABlcw5TrZJnIWFIHpyM18JoRJcM+AFNrSxn9vhvh601SU0dQUBq1v1\nZyRDoC1ZtUCnG7xrD/kCMAqAxuRo2tRje/MvOKfXULIY4WRsArBWpPXdndjLP/G7\nPvHb7IzA8GH2YQ/S1eO8LPs3MRMVJPKyf1J/5WNSV7S6memXxDsYrnYIOm/B2oT8\n7oytPH9eteZhR95KRl36eoWbijGat/TWE4vYiUSK3VG6kgvBWbb/wIrawB1rNOqH\ngtqkD3rZv1VIqbfVhuwZPeRCDkQRFuMiCI3ozwIDAQABAoIBAFADflIS0zQRQCdL\nwol/0NmAPbDt4lpdMUg0161wapZ2CrA8bQHMNxMHnVLuBR0lHrdMyhCusVZgqebe\nAT/ok8oiMFdd2AY9UCFO/R+PVskwr7ut7BRtVyY88/Dye9zMFGumeJaDhNxaj5wB\n0coMxfPJO4pF1XQo5CZplS+jc0RtiNnRmWP/zwwtH+QwT43GXKS3U3QgX1a/7Yzw\nliUFuggsjysNPovM5NzcgzYfVlMg3F9fDnMeve2s/MO6/wCIp1+SHN89DwluDmw0\nII0sJDtBRB1nPqseLV1XwYImdSosKuaUIK225vQy/cXK9S/zcq6+d6P5efCw8nRg\nbCfwd7ECgYEA8Agkx+P7zBAWItnkrNzah6QaWd3VP5bSw6WeHwcWIS1h3ASKSr3u\nT8rp5qDTk92eV/g5Uqr5lr8txnp448wnipeK0LDF4r+uhOsHOY4B4eFiTsRecXKD\nzlcC/ees4UOzbdptqosyAG5ub8UMwEH0zPOCszpnIhZkm004EHxc8zUCgYEAx/t0\nF1DYHm834CYyHfq3XiuB3yNECKMQZ1lgcq8IXaO3EJKnaSF3INogS1lZ6hQR2AW+\ntr+U6LdBRzsxH0ZeHu/lYCZ6ssgV3H6HTLlFVRysufVdlLaeaKAMuEADrUhVgvVA\n8rNM+8WSxrfya+2a/PwyJD9YdHCITcXVdwHHCHMCgYBLhYRtECJNVlJgrMXyTZrE\nSrGvzMgntcCiph1WDdi8n5bGrvcEBTZSDLoDQl7Pi08ixorio8Db2VMBu88FfVqD\nlKKsfrIEYeL7FyeyyCd3dn6D4e0FLM6jwWTDln0iczalPbB7lEgrMpO0vv8ADsCD\nK6rX1ZxZoWoOQwF8zmRAcQKBgQC85weoJpOfXAt5zlq1+ulPKOXKs3NGfVG3bjOp\n4SuT2FvKad19b0EqZSDzR/ylIkQgvHyD/8BXexNMh9tE4aFys8UF6BMq4dnUqCiC\nDtgxJ575IY8+NKq5xcV+HenbO2KbC7RIDZqAkQauc3+o947ZvhhXKQcTJmF6pY+Y\nlLM/hQKBgQCplo1rGsimNitBb2iw2B+jDJoMBLYjWeZWcr8VMwVlN9DXPG19uXKq\nCsbrteMX3VedbeRYk/NITsasRefZq7JDSe9JbsPxj3I+/nzV0EbMXX9cxJL3hkCc\n5QAmE/BMR7yh0odK57o+mcQZtecIEO1BK/qW6Au0otQHPraygGCwkQ==\n-----END RSA PRIVATE KEY-----&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_origin"</span>: <span class="token string">&quot;username&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searched_users"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;username&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"statusmsg"</span>: <span class="token string">&quot;ok&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">&quot;username&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/cPanel-Account-SSL-Management/operation/fetch_cert_info" data-section-id="tag/cPanel-Account-SSL-Management/operation/fetch_cert_info" class="sc-dntaoT ceciOs"><div data-section-id="operation/fetch_cert_info" id="operation/fetch_cert_info" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-SSL-Management/operation/fetch_cert_info" aria-label="tag/cPanel-Account-SSL-Management/operation/fetch_cert_info"></a>Return SSL certificate information </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves all of a certificate&amp;#39;s available information.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;You &lt;strong&gt;must&lt;/strong&gt; call either the &lt;code&gt;friendly_name&lt;/code&gt; or &lt;code&gt;id&lt;/code&gt; parameter.&lt;/li&gt;
&lt;li&gt;When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;roles&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves all of a certificate&#39;s available information.</p>
<p><strong>Important:</strong></p>
<ul>
<li>You <strong>must</strong> call either the <code>friendly_name</code> or <code>id</code> parameter.</li>
<li>When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server <a href="https://go.cpanel.net/serverroles">roles</a>, the system <strong>disables</strong> this function.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="friendly_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">friendly_name</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">friendly_name=TestCert</span></div><div><div html="&lt;p&gt;The certificate&amp;#39;s human readable name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate&#39;s human readable name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">id=example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3</span></div><div><div html="&lt;p&gt;The certificate&amp;#39;s ID.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate&#39;s ID.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/fetch_cert_info</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/fetch_cert_info</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riib5ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riib5ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riib5ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riib5ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riib5ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riib5ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riib5ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riib5ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riib5ca:0" aria-labelledby="tab:Riib5ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  fetch_cert_info <span class="token punctuation">\</span>
  <span class="token assign-left variable">id</span><span class="token operator">=</span><span class="token string">'example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">friendly_name</span><span class="token operator">=</span><span class="token string">'TestCert'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riib5ca:1" aria-labelledby="tab:Riib5ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riib5ca:2" aria-labelledby="tab:Riib5ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riib5ca:3" aria-labelledby="tab:Riib5ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjib5ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjib5ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjib5ca:0" aria-labelledby="tab:Rjib5ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;fetch_cert_info&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"cabundle"</span>: <span class="token string">&quot;-----BEGIN CERTIFICATE-----\nMIIB+DCCArDgBwIBAgIEWXcZhjANBgkzpkiG6w0BAQsFADATMREwDwYDVRRZZAhu\nZXcxLnRsZDAeFw1yMDAyMDcxMzE7MTdaFw0yMTAyMDYxMzE4MTdaMBMxETAPBgEJ\nBAMMCG5ldzEudGxkMIJBInANBgkqhkiG9w0BAQEFAAOKAR3AMIIBCgKCAQEA5n3Z\nUoGCgH48vcbZfrWtnrak4yOZk/UN45gc8bZGmqbzd3qKmGXkm11aW1ID2YKGKYjL\nmKt42HbXitlH6VhQcWviuYg+JIyTXDMLV0GiGpDT0uvde3YV21Ww2i5nzoFxWyVD\n67oize5gvq9gaw5nVj6UyZ0baIB01QeJ5x52xZyuSgiS0ssWlA3rvHx8wG0+1trR\naBwU0cn1cXP3ZMKzKus/yAUH4lMBFf8jgDzEWIwfMI5HmzUjg2kOPJQlBtZ1u0bJ\nGaKffWIMLs9Ux4p+f7FNeT/xJCHCTX7HpYDOyWwq109yHnD178NkywKoUvtx7f93\ntTI821mltPbC1PQUgQIDAQABo4IBIjCCAR4wHQYDVR0OBBYEFLThoqhCEONRK3X1\nFBgZ4gp+ESmJMAkGA1UdEwQCMAAwPgYDVR0jBDcwNYAUtOGiqEIQ41ErdfUUGBni\nCn4RKYmhF6QVMBMxETAPBgNVBAMMCG5ldzEudGxkggRZdxmGMB0GA1UdJQQWMBQG\nCCsGAQUFBwMBBggrBgEFBQcDAjCBkgYDVR0RBIGKMIGHgghuZXcxLnRsZIINbWFp\nbC5uZXcxLnRsZIIMd3d3Lm5ldzEudGxkgg9jcGFuZWwubmV3MS50bGSCEHdlYm1h\naWwubmV3MS50bGSCEHdlYmRpc2submV3MS50bGSCE2NwY29udGFjdHMubmV3MS50\nbGSCFGNwY2FsZW5kYXJzLm5ldzEudGxkMA0GCSqGSIb3DQEBCwUAA4IBAQCT4AQM\nwbwj3JEoQIJeP7RQyVe2/CPheqkSSajca1a3cUytwfRQ/m8DGM3L3WUZCaDEXYpJ\n+nt7k6KetL6Fs03e1W7IDADt68ahiBLIqvxEGZ5uNUYqOiEWgfp3yKEDOjkLLvzU\nGZb8FmNyeDoQ47b0mf0SRktG6W1rTMAg2kSDVoA7YNZStYvRzEliCX8cZqZ2as2d\nou95S+aGFAPJ+WMyYRgFm+ONAnpSbd9BursEcQSfLjKLusJzXrGVG9zZ/CAK2tHy\nXIlFrj88r0q9AZKyFkh6O1XvaZBiI/UEOWS2H3zcnh5ywudze7jTj5eFz5hr0ubX\ndji/LDNHmG+dKCK7\n-----END CERTIFICATE-----&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"certificate"</span>: <span class="token string">&quot;-----BEGIN CERTIFICATE-----\nMIIDyDCCArDgBwIBAgIEWXcZhjANBgkzpkiG6w0BAQsFADATMREwDwYDVQQDDAhu\nZXcxLnRsZDAeFw1yMDAyMDcxMzE5MTdaFw0yMTAyMDYxMzE4MTdaMBMxETAPBgMB\nBAMMCG5ldzEudGxkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA5n3Z\nUoGCgH48vcbZfrWtnrak4yOZk/UN45gc8bZGmqbzd3qKmGXkm11aW1ID2YKGKYjL\nmKt42HbXitlH6VhQcWviuYg+JIyTXDMLV0GiGpDT0uvde3YV21Ww2i5nzoFxWyVD\n67oize5gvq9gaw5nVj6UyZ0baIB01QeJ5x52xZyuSgiS0ssWlA3rvHx8wG0+1trR\naBwU0cn1cXP3ZMKzKus/yAUH4lMBFf8jgDzEWIwfMI5HmzUjg2kOPJQlBtZ1u0bJ\nGaKffWIMLs9Ux4p+f7FNeT/xJCHCTX7HpYDOyWwq109yHnD178NkywKoUvtx7f93\ntTI821mltPbC1PQUgQIDAQABo4IBIjCCAR4wHQYDVR0OBBYEFLThoqhCEONRK3X1\nFBgZ4gp+ESmJMAkGA1UdEwQCMAAwPgYDVR0jBDcwNYAUtOGiqEIQ41ErdfUUGBni\nCn4RKYmhF6QVMBMxETAPBgNVBAMMCG5ldzEudGxkggRZdxmGMB0GA1UdJQQWMBQG\nCCsGAQUFBwMBBggrBgEFBQcDAjCBkgYDVR0RBIGKMIGHgghuZXcxLnRsZIINbWFp\nbC5uZXcxLnRsZIIMd3d3Lm5ldzEudGxkgg9jcGFuZWwubmV3MS50bGSCEHdlYm1h\naWwubmV3MS50bGSCEHdlYmRpc2submV3MS50bGSCE2NwY29udGFjdHMubmV3MS50\nbGSCFGNwY2FsZW5kYXJzLm5ldzEudGxkMA0GCSqGSIb3DQEBCwUAA4IBAQCT4AQM\nwbwj3JEoQIJeP7RQyVe2/CPheqkSSajca1a3cUytwfRQ/m8DGM3L3WUZCaDEXYpJ\n+nt7k6KetL6Fs03e1W7IDADt68ahiBLIqvxEGZ5uNUYqOiEWgfp3yKEDOjkLLvzU\nGZb8FmNyeDoQ47b0mf0SRktG6W1rTMAg2kSDVoA7YNZStYvRzEliCX8cZqZ2as2d\nou95S+aGFAPJ+WMyYRgFm+ONAnpSbd9BursEcQSfLjKLusJzXrGVG9zZ/CAK2tHy\nXIlFrj88r0q9AZKyFkh6O1XvaZBiI/UEOWS2H3zcnh5ywudze7jTj5eFz5hr0ubX\ndji/LDNHmG+dKCK7\n-----END CERTIFICATE-----&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_self_signed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">&quot;-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEA5n3ZUoGCgH48vcbZfrYqnrak7yOZk/UN41gr8bZGmqbzd3qK\nmGXkm11aW1ID2YKGKYjLmKt59HbXitlH6VhQcWviuYr+JIyTXDMLV0GiGpDT0uvd\ne3YV21Ww2i5nzoFxWyVD67oize5gvq9gaw5nVj6UyZ0baIB01QeJ5x52xZyuSgiS\n0ssWlA3rvHx8wG0+1trRaBwU0cn1cXP3ZMKzKus/yAUH4lMBFf8jgDzEWIwfMI5H\nmzUjg2kOPJQlBtZ1u0bJGaKffWIMLs9Ux4p+f7FNeT/xJCHCTX7HpYDOyWwq109y\nHnD178NkywKoUvtx7f93tTI821mltPbC1PQUgQIDAQABAoIBAEteX4/hFYFaxhXw\nTfJnCgzaAHTdkTyWZyJC/UP0rIWpjfdFtMg8mVJMZl1yJhwb2C8AskKL34o44iZf\nAmrFHBjahFrSuC9PYGhHsK+poI47SWixA815QZBlJt1RS1R1c1Gwj9MnHHZmOnBf\n/JFFNnk3IYQDwZCcYJfATVGr3n6jLEGNwaPWFV6SHf0C4tCibSdNkkS1L/u+roHK\n2dlmo84suwiqIYlxRCh0rZcvcx5ieF5Rj9g9t2ReYWCuEOMWuPcCfWoe4VngrmMX\nV4I8NS1wtMR8qONJf4B9vcBA36296x1PZp3QEWU6hCd3TKpInKKxe6tOJA1iZ/H0\nKn0sYSECgYEA/W2zPsHKZDHnLN80MdiRFIPnmBvdNl2kPl244S9YFCHULowxx4YA\nMhz46dkm7VAFJdCTDZvKNZloPRG6N+Ouw2TP/gwnqZzVN2jt7+rpSYWp8s8kAASv\npmjnpGLlAZg8BBD/gafxfjEdyB7QEUF379o+0WTxCJrcE8n8UtTcXj0CgYEA6NSR\nf1bXcfzCzLtkudEfyA9+u5mdENqoqasLfJsLzezeGFAYamQsnEEACWSbJvogHHZk\ng/gKVuSzspLDWpJT96agmUFGKoBozJrOj2TpXfSI9uDaGo0/YJsPhnuPHab0jiO5\nCjpCOAKMXaV9lbALRh4ALGiODDDud2rqzph815UCgYEA2ULKf+qzD+KYRSe1H2aC\nOgw653Q72Pe+bpj6flKQN/IobR9TLbH7SPr9ibzYWmpXf2uoJeqBGCJD8tbXxkIy\n+N/cT/crqYUCZVZXZW8GQDmO0NI0Eq/xxb/5ljwSB6PzD6li4kyQA5cn6QBBcAmo\nQL/hSrI20SGxumVXI8vIgCECgYAUJai9cx9LfsrAeoq5xY3Rev3FcAJ2XeVwYRuq\nWaRI2nFRe0TRl/+AOeOt7GW8lrJGpDwIa2NBp6KhFjAPW1AmwuVsvYg7z0bCRbcQ\nE3RaK/naGxTkbUqJqoFKatC0iSjqT88IQohOXnIU/GgEluoy1A/Bx/5asbVA4iCV\nZf6PjQKBgA0A3Q5lrWwuQlCXDiwsRLKSYEwgt5TFKfbiipB01m89PGd1ylz+Uzyn\niE01Cuar6yN9pJiTJ09Tmq3S2xxavY97KFHyu6R8/jHx4mZi9OMJfxffC+84q6d+\nXVABiqBs1l0ebWCsotdXoYDDQaVrCccxPfCjUCtPmgnarz11uhZo\n-----END RSA PRIVATE KEY-----&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject.commonName_ip"</span>: <span class="token string">&quot;192.168.0.1&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/cPanel-Account-SSL-Management/operation/fetch_certificates_for_fqdns" data-section-id="tag/cPanel-Account-SSL-Management/operation/fetch_certificates_for_fqdns" class="sc-dntaoT ceciOs"><div data-section-id="operation/fetch_certificates_for_fqdns" id="operation/fetch_certificates_for_fqdns" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-SSL-Management/operation/fetch_certificates_for_fqdns" aria-label="tag/cPanel-Account-SSL-Management/operation/fetch_certificates_for_fqdns"></a>Return SSL certificate information for all FQDN </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves the certificate information for all fully qualified domain names (FQDNs) that the account owns.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the certificate information for all fully qualified domain names (FQDNs) that the account owns.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domains" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domains</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domains=domains=example1.com,example2.com</span> - Multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domains=example.com</span> - A single domain.</li></ul><div><div html="&lt;p&gt;A domain or comma-delimited list of domains for which to retrieve information.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A domain or comma-delimited list of domains for which to retrieve information.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/fetch_certificates_for_fqdns</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/fetch_certificates_for_fqdns</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riid5ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riid5ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riid5ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riid5ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riid5ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riid5ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riid5ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riid5ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riid5ca:0" aria-labelledby="tab:Riid5ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  fetch_certificates_for_fqdns <span class="token punctuation">\</span>
  <span class="token assign-left variable">domains</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riid5ca:1" aria-labelledby="tab:Riid5ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riid5ca:2" aria-labelledby="tab:Riid5ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riid5ca:3" aria-labelledby="tab:Riid5ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjid5ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjid5ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjid5ca:0" aria-labelledby="tab:Rjid5ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;fetch_certificates_for_fqdns&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"cab"</span>: <span class="token string">&quot;-----BEGIN CERTIFICATE-----\nMIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD\nVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv\nb3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV\nUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU\ncnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyv\nRLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4M\nypqfpX/1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/5\n1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz\ndcZfHeFhVYAA1IFLezEPI2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl\nIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4/5ODFlitppK+ULdjG+BqXH/9Apy\nbW1EDp3zdHSo1TRJ6V6e6bR64eVaH4QwnNOfpSXY\n-----END CERTIFICATE-----&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token number">1496950287</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"crt"</span>: <span class="token string">&quot;-----BEGIN CERTIFICATE-----\nMIIDcTCCAlmgAwIBAgIFAU+BNVgwDQYJKoZIhvcNAQEFBQAwUTESMBAGA1UEAwwJ\nc2lza28udGxkMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGY1BhbmVsMQswCQYDVQQI\nDAJUWDEQMA4GA1UEBwwHSG91c3RvbjAeFw0xNDEwMDYyMjI2MTlaFw0xNTEwMDYy\nMjI2MTlaMFExEjAQBgNVBAMMCXNpc2tvLnRsZDELMAkGA1UEBhMCVVMxDzANBgNV\nBAoMBmNQYW5lbDELMAkGA1UECAwCVFgxEDAOBgNVBAcMB0hvdXN0b24wggEiMA0G\nCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9zx6zGiHdmWA0dKtoXmJiWXpZ9E3P\nXx3YHsjFEWW7e5pH0vZ+jVMzDmm5nsJ7RXrAkZO1IvpIpVLvoQfiJOWVvkD+o9fW\nvoK1tWJS72FSgPju+58mA2ieBuc87A790Pzuv1P3NR3zFLAjUR99zkHR1fpri/da\nM3PBWO8ET48FWkyU1kOeZaUlF67/+wrEiNgg+t1qhKOCAB61PdNVkLaSGHimksuC\n+Czk8Kq9nuS0E0TCnDtjjEyJ455FUcaCfczlTb8xkB/F9ORe74yTzD+vlk0tFMG6\nPLj/ajIwWqwO0qmQ8wX3NRxkWgGz5kVO1wrVJarKQ5EYQ3/mgvit0v6dAgMBAAGj\nUDBOMB0GA1UdDgQWBBRw+wKBo34+bgexjAa3EMDsgSCd7zAfBgNVHSMEGDAWgBRw\n+wKBo34+bgexjAa3EMDsgSCd7zAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUA\nA4IBAQCHRXIs53opzKM2rM8Qe8lcw524WK6hqy2EWrZHp78N7rU7/6DQ/I3hv3Wh\ncDDIO04I2/Xhe88MLBaLoM367Ya+vy7CaLr14aLi/SfQszMA0ALBvMao+Fis0iVw\nFYq/NLgSXw+fgnpFskt8v8iQZ+4Kaal8U8e9sVgu8m0RgO7rzym1eRiIKpsKd1rh\n/SD7LbSN7M7TRL3QqF7ltw9sQhAAsQcRaBBF21pdWrqhiGZ+Eioo3hhgwNavH2ag\nqz78ddHwrFpHFwrEeUk1OfpPb76MYIce7xIy/4oQNdg6fOq4l/FrajBv+WkzDVPa\nKm6r7YmwfLN/YMZBHXSR58oOGP9W\n-----END CERTIFICATE-----&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain_is_configured"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example.servername.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;example.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;mail.example.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;www.example.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;www.example.servername.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_curve_name"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_public"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"friendly_name"</span>: <span class="token string">&quot;Cert for example.servername.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;example_servername_com_ce52d_6e643_2813308004_119580f9b01960cjones72bc519206bc&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_self_signed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer.commonName"</span>: <span class="token string">&quot;example.servername.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer.organizationName"</span>: <span class="token string">&quot;Organization&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer_text"</span>: <span class="token string">&quot;stateOrProvinceName\\nTX\\nlocalityName\\nHouston\\ncountryName\\nUS\\ncommonName\\nexample.com\\norganizationName\\ncPanel&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">&quot;-----BEGIN RSA PRIVATE KEY-----\nMIIJJwIBAAKCAgEA4yilqsoCdEpiNOyLcPJ4FLT7vgwaLdOBeJLTMUeV2uZM4v65/tiZe7H0soDp1C55SCr3uEIEa7Lq7RUZ+F5p67BgRR19rmerKGxfN7N5Vu97pfTwW1f+lVsxUF/56lVeoAmm4okU98xJHiGGlI8ZHGJbUMYfLPy0OrA+gNwMHqMVOv1BSgpbEWCILMvnvtp0rwPutjnPVX2Dj40ia40L4Wqvp+0Yg7mZyhIOl+q6VZVIdXZslR4ZywfRBYt3ieFBDYMyNw9wN3Xy44fCpHc77+ho84W3BqrGaWSSDyf6UkZGD5mfohGf2JSp+c8J6H7hsxo7pta3K1diVXFOSfnaA+k56zW445XruwYs/SN/zvGetGi6uqhMAcVRQcYCmLCixcC6RkcUx3exxgR4q3gthDnFvWC4+NuTh8/K0BcxcuCEhRug/MfVfO3+f7RJFSJPFb9m9Lf4HHBSVkDP5WtG4XiBKCe++9Wuvxbd4QxS7YrnSopNKxkuHKswH8ONpADMYDqfLODMhNrslHNHu95Nv7AlQr8weLqMGWMp7GFqzXcl39RnVkF4Bxd3bAAsMN8/JvanMKCPjTTDrfzVFZcmHXPYOljYDdY1xfIstYVtbyFkUHZP2RPPBaPUAt90lzrKGVF8a2vdIKRiey5SZ5qu9c/mGri3oz7Lkk7qkNPAqDMCAwEAAQKCAgA3f9raG3j2CKZt381Bzzvfc0h+al6LC736Q4Ut6RuH2/S1ER9IUItPWW87nZuDp8ciBr13W0nRNmmHezxZHlgqqXEb8dSfI90Bh1jMNyFSSDihl3KSHrGotBscVBavViREXZdUicGBuXuxtkYno96yvKUq2v0K9MLkA+OBgEHFynqJaw7klBsj573dlAQO8TjI+eD8zKsHbB8Ul5rtRAy/Cl3YXWk75cDZSggevc7A0jRd3o0w8aXDoSlEfYq7OTm3n3JJWZBFPKAXTzgTDr6qItJhjS4IxXsq7RNyeIYES/8aGKKT6lJvjALrcdYt47IpHCOu447lG/h+f6xtDophLGZoAirO7lJFRVfLJh76sLF12bpXJKbbmMN+aut0nM+MLEw8A5K9OV24jJ/3+afj//5789asIyvNaQFPOX23SdLX0QbA5QWvJt2tWvvpS3ubcIJaBEMTK8asEBC68eUW0BBKJaSiYNzecUFYCBjQlxKsIrYuWZoW6fMyRel+cnqMdiH7r2p6RmgF5c9myDwq3E47jE+VrOy8uhw7EMQvT8+YSKaIbgtFZcUSU02BDRB7gWNa842m6nGs5tj5xFNQ6Wt410vilTwL+6zCQqJaKmcdE3woiIgSdrw5MssAHHjqo7QJthZfbpUAUTc6jGPNO13U1ediIRAGdQW5ALqTwQKCAQEA884bmFFZLTewHIv1PJFfNxVZfk3C7LhWE2JcI/5P/YrN4ZA8G08OYhgxqa5XnsHHQPwMM85i1HeOoPwqgTMIyLDX/Sf88+eW3ef4V2M1Y4op0ahWFEwbwXKGxOhncElObN7dfZUwVlxCReaiw2XQAGRqtQC0f+9dZysqPJr+Rz6poTiOtm7DcpW/WiGfBPvVhzBENyqouL9V3vCWYPJSLtCexECoGoPSpHKgUkwbh3+ra8SfG6FOIBj4PpMB82R7oPDjIyXF1VDfb0EwYQlKxyZoP9+NPT2MhZv/hF/Mbm/5LolVHx92hO9q6yxS6nvaFmEPr9fY1EOTWzzPOA+VyQKCAQEA7oVioaTqxENt+wHITZq100iYUpm4X1N1eENTp97QyQbQOVR/t8iGLUdvOZdIxBSTS3JFQ8TNcGDPPc+o319QGdZABNnKwFGY3Ss+5QgVeX6n0WKdxCRelUOUB174aBeXcJCKplh6xBUrLfSZxvZQQb7fv0Mb+2eKUBKTymvES1kpYdn1T0vCCHA3bVpaHuqliCoDSX3RmQICZlfSgCGBbAkmU8RuxDd9yR9l7O9MXUmLsqlsw6hvbUt+7Y13YlDtyX8gbCwEEYsoALOotY1xNfXnyZKTAXhrg+xsQLrURYZUoZiCJyK/mHCWRTPVkt89wq4IexbJ9hqlRjzpmlr8GwKCAQBxRSCs855q06SOnrehHCkQfmrFs3sMX9gdyWTllBG1yfc9BLXoOiKEkJkCLG2o5H6eQnuo1go0jBdH0+ArhnpeQ0sV4q4y4zXEgzFt6Dm1tUsYjQzxASskBQF4GkF0eZpmGmTtI5MBjHt93llgTr0EcaLh1SIHDj5m4DcPUTMyBnro3E3xlCRZ6Biu10/6EMZzuIj42Gjq7HoIyd4TzIFCHsqkgyWWrAgBPwAdPB7OJRKPTxpcy+RwJSmwaLxPSC/n5gKhIbt4D8q+9Zp0esyzGbT1d/c2rJHMwV1FMvzXkk5CwKs7enKl8FXMTRt4tXHtU8rl93JVq8+aY/YiJZuBAoIBAERG2lz7IFjeFHVtpTDRwIqilTfP2P8wnMe4PhInrgxdbu16SrUJKZ98e1I5BBNc8G0AYONtSoGItMo0z1phpkQ/GERLM8aplOB6qJ5XGg6VOuStHgwvfQOtPIp/nQvu9OK7/XRwj3Phu2KESiCyEXdAdDwDsdbdZLJXHwcqoh4Pf9EK2zW/seNIfBVJb9K5yHiZzicTZRQvhxBUw2T6MloCpH4GFM8GM3OHEV4pgeqSSvLxnLjFVmAq5EKL5Ei4cdjkExvj3aZH90N8KicOPgH8SkVhN8OL/Prein5c/LaKJV+8kEUzpTS1xc45cEGCteMsfjD97QINzpG0jgopUVECggEADIaKsx8NUQT3hm0wHRanEFJnQH5HzxaQjWbsjm2uz0KROPNIK1X5L8kypsb+EzlJtvWUqxPaOaTv4DZVpFaVzk8/2PPGsYR3mUjqMqNFYMrNwYZAXvJ/huzDPqq6+w2Pn9jcAifHNw3S8UR650v8gl7BU4fVBvhamG8JelvwLqeGWoikST9NBXVqG5IKBpUkUiFOMUNmRih9ooKvhy7GosoK8MWbmhWo1v8TTSXSagACUhAoIzb6mMN/VFC5WDbFx5AEB/G9tq/zmTqQkuo39dvgl30wyZGRNwc1aFf1Kxeven10/JN9ipp0mTa7NYSdn0RAe9ZRp5cCkgmktqmB0g==\n-----END RSA PRIVATE KEY-----&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">&quot;rsaEncryption&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">&quot;ce52db786fd2776f69057ed8ee0d8ab267a2f328a66a3afd8\n76017a99d061ec5d24d646f80ec258c696cb742e2bcd2fef920177144d9126a4\n779c1a21ca5589ff06e673556116903493100dfba385a62d11aeec57f47e5b20\nad8d1142fbe93f003fb62403cdcc0012ccd407009ac21639623bc52a5d6d3814\nff9c45a7c246799f0229b4854af2aeddfa755ab13814132424f5b1680f2c357e\n1476af7422bd5863102cfc5982b3ddad7fecdeae5c1cb73789008be9ce2f24fe\n27c9202b3bca6524ba29a30972f14cbf06f0a1b7998c2361ed90221f40829faf\n644adc7b8da6f948d8745ffbe8e5b6f0c8e7ea9ef2bc26413f90666ef1200407\neab7c3b71c6e643&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus_length"</span>: <span class="token number">2048</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"not_after"</span>: <span class="token number">1528486286</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"not_before"</span>: <span class="token number">1496950286</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"serial"</span>: <span class="token string">&quot;01e57e4d92&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"signature_algorithm"</span>: <span class="token string">&quot;sha256WithRSAEncryption&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject.commonName"</span>: <span class="token string">&quot;example.servername.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject_text"</span>: <span class="token string">&quot;stateOrProvinceName\\nTX\\nlocalityName\\nHouston\\ncountryName\\nUS\\ncommonName\\nexample.com\\norganizationName\\ncPanel&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"validation_type"</span>: <span class="token string">&quot;dv&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"verify_error"</span>: <span class="token string">&quot;DEPTH_ZERO_SELF_SIGNED_CERT&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/cPanel-Account-SSL-Management/operation/find_certificates_for_key" data-section-id="tag/cPanel-Account-SSL-Management/operation/find_certificates_for_key" class="sc-dntaoT ceciOs"><div data-section-id="operation/find_certificates_for_key" id="operation/find_certificates_for_key" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-SSL-Management/operation/find_certificates_for_key" aria-label="tag/cPanel-Account-SSL-Management/operation/find_certificates_for_key"></a>Return SSL certificate for private key </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves SSL certificates for a private key.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you call this function, you &lt;strong&gt;must&lt;/strong&gt; include either the &lt;code&gt;id&lt;/code&gt;
&lt;strong&gt;or&lt;/strong&gt; the &lt;code&gt;friendly_name&lt;/code&gt; parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves SSL certificates for a private key.</p>
<p><strong>Note:</strong></p>
<p>When you call this function, you <strong>must</strong> include either the <code>id</code>
<strong>or</strong> the <code>friendly_name</code> parameter.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="friendly_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">friendly_name</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">friendly_name=TestKey</span></div><div><div html="&lt;p&gt;The key&amp;#39;s friendly name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key&#39;s friendly name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">id</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">id=example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3</span></div><div><div html="&lt;p&gt;The key&amp;#39;s ID.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key&#39;s ID.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/find_certificates_for_key</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/find_certificates_for_key</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riif5ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riif5ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riif5ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riif5ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riif5ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riif5ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riif5ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riif5ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riif5ca:0" aria-labelledby="tab:Riif5ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  find_certificates_for_key
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riif5ca:1" aria-labelledby="tab:Riif5ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riif5ca:2" aria-labelledby="tab:Riif5ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riif5ca:3" aria-labelledby="tab:Riif5ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjif5ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjif5ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjif5ca:0" aria-labelledby="tab:Rjif5ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;find_certificates_for_key&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token number">1538308800</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_curve_name"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_public"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"friendly_name"</span>: <span class="token string">&quot;TestCert&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;example_com_a74f7_9dddf_1446659822_eae1ff43c4ec1991e195877c55755eff&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_self_signed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer.commonName"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer.organizationName"</span>: <span class="token string">&quot;The Example Organization&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer_text"</span>: <span class="token string">&quot;countryName\nUS\ncommonName\u001bxample.com\nlocalityName\nHouston\norganizationName\ncPanel\nstateOrProvinceName\ntx&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">&quot;rsaEncryption&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">&quot;a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus_length"</span>: <span class="token number">2048</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"not_after"</span>: <span class="token number">1569844800</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"not_before"</span>: <span class="token number">1538308800</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"signature_algorithm"</span>: <span class="token string">&quot;sha256WithRSAEncryption&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject.commonName"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject_text"</span>: <span class="token string">&quot;countryName\nUS\ncommonName\u001bxample.com\nlocalityName\nHouston\norganizationName\ncPanel\nstateOrProvinceName\ntx&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"validation_type"</span>: <span class="token string">&quot;dv&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/cPanel-Account-SSL-Management/operation/fetch_key_and_cabundle_for_certificate" data-section-id="tag/cPanel-Account-SSL-Management/operation/fetch_key_and_cabundle_for_certificate" class="sc-dntaoT ceciOs"><div data-section-id="operation/fetch_key_and_cabundle_for_certificate" id="operation/fetch_key_and_cabundle_for_certificate" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-SSL-Management/operation/fetch_key_and_cabundle_for_certificate" aria-label="tag/cPanel-Account-SSL-Management/operation/fetch_key_and_cabundle_for_certificate"></a>Return private key and CA bundle </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function extracts the private key and CA bundle information from a certificate.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;Due to the limited field length of &lt;code&gt;HTTP GET&lt;/code&gt; method calls, you &lt;strong&gt;must&lt;/strong&gt; use the &lt;code&gt;HTTP POST&lt;/code&gt; method. For this reason, you &lt;strong&gt;cannot&lt;/strong&gt; use a cPanel or Webmail session URL to call this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function extracts the private key and CA bundle information from a certificate.</p>
<p><strong>Note:</strong></p>
<p>Due to the limited field length of <code>HTTP GET</code> method calls, you <strong>must</strong> use the <code>HTTP POST</code> method. For this reason, you <strong>cannot</strong> use a cPanel or Webmail session URL to call this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="certificate" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">certificate</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;pem-certificate&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">certificate=-----BEGIN CERTIFICATE-----MIIDcTCCAlmgAwIBAgIFAU+BNVgwDQYJKoZIhvcNAQEFBQAwUTESMBAGA1UEAwwJc2lza28udGxkMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGY1BhbmVsMQswCQYDVQQIDAJUWDEQMA4GA1UEBwwHSG91c3RvbjAeFw0xNDEwMDYyMjI2MTlaFw0xNTEwMDYyMjI2MTlaMFExEjAQBgNVBAMMCXNpc2tvLnRsZDELMAkGA1UEBhMCVVMxDzANBgNVBAoMBmNQYW5lbDELMAkGA1UECAwCVFgxEDAOBgNVBAcMB0hvdXN0b24wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9zx6zGiHdmWA0dKtoXmJiWXpZ9E3PXx3YHsjFEWW7e5pH0vZ+jVMzDmm5nsJ7RXrAkZO1IvpIpVLvoQfiJOWVvkD+o9fWvoK1tWJS72FSgPju+58mA2ieBuc87A790Pzuv1P3NR3zFLAjUR99zkHR1fpri/daM3PBWO8ET48FWkyU1kOeZaUlF67/+wrEiNgg+t1qhKOCAB61PdNVkLaSGHimksuC+Czk8Kq9nuS0E0TCnDtjjEyJ455FUcaCfczlTb8xkB/F9ORe74yTzD+vlk0tFMG6PLj/ajIwWqwO0qmQ8wX3NRxkWgGz5kVO1wrVJarKQ5EYQ3/mgvit0v6dAgMBAAGjUDBOMB0GA1UdDgQWBBRw+wKBo34+bgexjAa3EMDsgSCd7zAfBgNVHSMEGDAWgBRw+wKBo34+bgexjAa3EMDsgSCd7zAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUAA4IBAQCHRXIs53opzKM2rM8Qe8lcw524WK6hqy2EWrZHp78N7rU7/6DQ/I3hv3WhcDDIO04I2/Xhe88MLBaLoM367Ya+vy7CaLr14aLi/SfQszMA0ALBvMao+Fis0iVwFYq/NLgSXw+fgnpFskt8v8iQZ+4Kaal8U8e9sVgu8m0RgO7rzym1eRiIKpsKd1rh/SD7LbSN7M7TRL3QqF7ltw9sQhAAsQcRaBBF21pdWrqhiGZ+Eioo3hhgwNavH2agqz78ddHwrFpHFwrEeUk1OfpPb76MYIce7xIy/4oQNdg6fOq4l/FrajBv+WkzDVPaKm6r7YmwfLN/YMZBHXSR58oOGP9W-----END CERTIFICATE-----</span></div><div><div html="&lt;p&gt;An SSL certificate.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An SSL certificate.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-dpBQxM eJAAZj">Request Body schema: <span class="sc-dhCplO khtVmz">multipart/form-data</span></h5><div html="&lt;p&gt;The certificate&amp;#39;s contents.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>The certificate&#39;s contents.</p>
</div><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="certificate" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">certificate</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;pem-certificate&gt; </span></div> <div><div html="&lt;p&gt;The certificate file.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate file.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="post" class="sc-txhaY dCeVuA http-verb post">post</span><span class="sc-etPtWW iqHzp">/SSL/fetch_key_and_cabundle_for_certificate</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/fetch_key_and_cabundle_for_certificate</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riih5ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riih5ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riih5ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riih5ca:1" data-rttab="true">HTTP Request (Wire Format)</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riih5ca:0" aria-labelledby="tab:Riih5ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--input</span><span class="token operator">=</span>json <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  fetch_key_and_cabundle_for_certificate
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riih5ca:1" aria-labelledby="tab:Riih5ca:1"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjih5ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjih5ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjih5ca:0" aria-labelledby="tab:Rjih5ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;fetch_key_and_cabundle_for_certificate&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"cab"</span>: <span class="token string">&quot;-----BEGIN CERTIFICATE-----MIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYDVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJvb3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJVUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJUcnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyvRLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4MypqfpX/1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/51KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKzdcZfHeFhVYAA1IFLezEPI2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWlIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4/5ODFlitppK+ULdjG+BqXH/9ApybW1EDp3zdHSo1TRJ6V6e6bR64eVaH4QwnNOfpSXY-----END CERTIFICATE-----&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"crt"</span>: <span class="token string">&quot;-----BEGIN CERTIFICATE-----MIIDcTCCAlmgAwIBAgIFAU+BNVgwDQYJKoZIhvcNAQEFBQAwUTESMBAGA1UEAwwJc2lza28udGxkMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGY1BhbmVsMQswCQYDVQQIDAJUWDEQMA4GA1UEBwwHSG91c3RvbjAeFw0xNDEwMDYyMjI2MTlaFw0xNTEwMDYyMjI2MTlaMFExEjAQBgNVBAMMCXNpc2tvLnRsZDELMAkGA1UEBhMCVVMxDzANBgNVBAoMBmNQYW5lbDELMAkGA1UECAwCVFgxEDAOBgNVBAcMB0hvdXN0b24wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9zx6zGiHdmWA0dKtoXmJiWXpZ9E3PXx3YHsjFEWW7e5pH0vZ+jVMzDmm5nsJ7RXrAkZO1IvpIpVLvoQfiJOWVvkD+o9fWvoK1tWJS72FSgPju+58mA2ieBuc87A790Pzuv1P3NR3zFLAjUR99zkHR1fpri/daM3PBWO8ET48FWkyU1kOeZaUlF67/+wrEiNgg+t1qhKOCAB61PdNVkLaSGHimksuC+Czk8Kq9nuS0E0TCnDtjjEyJ455FUcaCfczlTb8xkB/F9ORe74yTzD+vlk0tFMG6PLj/ajIwWqwO0qmQ8wX3NRxkWgGz5kVO1wrVJarKQ5EYQ3/mgvit0v6dAgMBAAGjUDBOMB0GA1UdDgQWBBRw+wKBo34+bgexjAa3EMDsgSCd7zAfBgNVHSMEGDAWgBRw+wKBo34+bgexjAa3EMDsgSCd7zAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUAA4IBAQCHRXIs53opzKM2rM8Qe8lcw524WK6hqy2EWrZHp78N7rU7/6DQ/I3hv3WhcDDIO04I2/Xhe88MLBaLoM367Ya+vy7CaLr14aLi/SfQszMA0ALBvMao+Fis0iVwFYq/NLgSXw+fgnpFskt8v8iQZ+4Kaal8U8e9sVgu8m0RgO7rzym1eRiIKpsKd1rh/SD7LbSN7M7TRL3QqF7ltw9sQhAAsQcRaBBF21pdWrqhiGZ+Eioo3hhgwNavH2agqz78ddHwrFpHFwrEeUk1OfpPb76MYIce7xIy/4oQNdg6fOq4l/FrajBv+WkzDVPaKm6r7YmwfLN/YMZBHXSR58oOGP9W-----END CERTIFICATE-----&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"crt_origin"</span>: <span class="token string">&quot;username&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip"</span>: <span class="token string">&quot;192.168.0.1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">&quot;-----BEGIN RSA PRIVATE KEY-----MIIJJwIBAAKCAgEA4yilqsoCdEpiNOyLcPJ4FLT7vgwaLdOBeJLTMUeV2uZM4v65/tiZe7H0soDp1C55SCr3uEIEa7Lq7RUZ+F5p67BgRR19rmerKGxfN7N5Vu97pfTwW1f+lVsxUF/56lVeoAmm4okU98xJHiGGlI8ZHGJbUMYfLPy0OrA+gNwMHqMVOv1BSgpbEWCILMvnvtp0rwPutjnPVX2Dj40ia40L4Wqvp+0Yg7mZyhIOl+q6VZVIdXZslR4ZywfRBYt3ieFBDYMyNw9wN3Xy44fCpHc77+ho84W3BqrGaWSSDyf6UkZGD5mfohGf2JSp+c8J6H7hsxo7pta3K1diVXFOSfnaA+k56zW445XruwYs/SN/zvGetGi6uqhMAcVRQcYCmLCixcC6RkcUx3exxgR4q3gthDnFvWC4+NuTh8/K0BcxcuCEhRug/MfVfO3+f7RJFSJPFb9m9Lf4HHBSVkDP5WtG4XiBKCe++9Wuvxbd4QxS7YrnSoKxkuHKswH8ONpADMYDqfLODMhNrslHNHu95Nv7AlQr8weLqMGWMp7GFqzXcl39RnVkF4Bxd3bAAsMN8/JvanMKCPjTTDrfzVFZcmHXPYOljYDdY1xfIstYVtbyFkUHZP2RPPBaPUAt90lzrKGVF8a2vdIKRiey5SZ5qu9c/mGri3oz7Lkk7qkNPAqDMCAwEAAQKCAgA3f9raG3j2CKZt381Bzzvfc0h+al6LC736Q4Ut6RuH2/S1ER9IUItPWW87nZuDp8ciBr13W0nRNmmHezxZHlgqqXEb8dSfI90Bh1jMNyFSSDihl3KSHrGotBscVBavViREXZdUicGBuXuxtkYno96yvKUq2v0K9MLkA+OBgEHFynqJaw7klBsj573dlAQO8TjI+eD8zKsHbB8Ul5rtRAy/Cl3YXWk75cDZSggevc7A0jRd3o0w8aXDoSlEfYq7OTm3n3JJWZBFPKAXTzgTDr6qItJhjS4IxXsq7RNyeIYES/8aGKKT6lJvjALrcdYt47IpHCOu447lG/h+f6xtDophLGZoAirO7lJFRVfLJh76sLF12bpXJKbbmMN+aut0nM+MLEw8A5K9OV24jJ/3+afj//5789asIyvNaQFPOX23SdLX0QbA5QWvJt2tWvvpS3ubcIJaBEMTK8asEBC68eUW0BBKJaSiYNzecUFYCBjQlxKsIrYuWZoW6fMyRel+cnqMdiH7r2p6RmgF5c9myDwq3E47jE+VrOy8uhw7EMQvT8+YSKaIbgtFZcUSU02BDRB7gWNa842m6nGs5tj5xFNQ6Wt410vilTwL+6zCQqJaKmcdE3woiIgSdrw5MssAHHjqo7QJthZfbpUAUTc6jGPNO13U1ediIRAGdQW5ALqTwQKCAQEA884bmFFZLTewHIv1PJFfNxVZfk3C7LhWE2JcI/5P/YrN4ZA8G08OYhgxqa5XnsHHQPwMM85i1HeOoPwqgTMIyLDX/Sf88+eW3ef4V2M1Y4op0ahWFEwbwXKGxOhncElObN7dfZUwVlxCReaiw2XQAGRqtQC0f+9dZysqPJr+Rz6poTiOtm7DcpW/WiGfBPvVhzBENyqouL9V3vCWYPJSLtCexECoGoPSpHKgUkwbh3+ra8SfG6FOIBj4PpMB82R7oPDjIyXF1VDfb0EwYQlKxyZoP9+NPT2MhZv/hF/Mbm/5LolVHx92hO9q6yxS6nvaFmEPr9fY1EOTWzzPOA+VyQKCAQEA7oVioaTqxENt+wHITZq100iYUpm4X1N1eENTp97QyQbQOVR/t8iGLUdvOZdIxBSTS3JFQ8TNcGDPPc+o319QGdZABNnKwFGY3Ss+5QgVeX6n0WKdxCRelUOUB174aBeXcJCKplh6xBUrLfSZxvZQQb7fv0Mb+2eKUBKTymvES1kpYdn1T0vCCHA3bVpaHuqliCoDSX3RmQICZlfSgCGBbAkmU8RuxDd9yR9l7O9MXUmLsqlsw6hvbUt+7Y13YlDtyX8gbCwEEYsoALOotY1xNfXnyZKTAXhrg+xsQLrURYZUoZiCJyK/mHCWRTPVkt89wq4IexbJ9hqlRjzpmlr8GwKCAQBxRSCs855q06SOnrehHCkQfmrFs3sMX9gdyWTllBG1yfc9BLXoOiKEkJkCLG2o5H6eQnuo1go0jBdH0+ArhnpeQ0sV4q4y4zXEgzFt6Dm1tUsYjQzxASskBQF4GkF0eZpmGmTtI5MBjHt93llgTr0EcaLh1SIHDj5m4DcPUTMyBnro3E3xlCRZ6Biu10/6EMZzuIj42Gjq7HoIyd4TzIFCHsqkgyWWrAgBPwAdPB7OJRKPTxpcy+RwJSmwaLxPSC/n5gKhIbt4D8q+9Zp0esyzGbT1d/c2rJHMwV1FMvzXkk5CwKs7enKl8FXMTRt4tXHtU8rl93JVq8+aY/YiJZuBAoIBAERG2lz7IFjeFHVtpTDRwIqilTfP2P8wnMe4PhInrgxdbu16SrUJKZ98e1I5BBNc8G0AYONtSoGItMo0z1phpkQ/GERLM8aplOB6qJ5XGg6VOuStHgwvfQOtPIp/nQvu9OK7/XRwj3Phu2KESiCyEXdAdDwDsdbdZLJXHwcqoh4Pf9EK2zW/seNIfBVJb9K5yHiZzicTZRQvhxBUw2T6MloCpH4GFM8GM3OHEV4pgeqSSvLxnLjFVmAq5EKL5Ei4cdjkExvj3aZH90N8KicOPgH8SkVhN8OL/Prein5c/LaKJV+8kEUzpTS1xc45cEGCteMsfjD97QINzpG0jgopUVECggEADIaKsx8NUQT3hm0wHRanEFJnQH5HzxaQjWbsjm2uz0KROPNIK1X5L8kypsb+EzlJtvWUqxPaOaTv4DZVpFaVzk8/2PPGsYR3mUjqMqNFYMrNwYZAXvJ/huzDPqq6+w2Pn9jcAifHNw3S8UR650v8gl7BU4fVBvhamG8JelvwLqeGWoikST9NBXVqG5IKBpUkUiFOMUNmRih9ooKvhy7GosoK8MWbmhWo1v8TTSXSagACUhAoIzb6mMN/VFC5WDbFx5AEB/G9tq/zmTqQkuo39dvgl30wyZGRNwc1aFf1Kxeven10/JN9ipp0mTa7NYSdn0RAe9ZRp5cCkgmktqmB0g==-----END RSA PRIVATE KEY-----&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_origin"</span>: <span class="token string">&quot;username&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searched_users"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;username&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"statusmsg"</span>: <span class="token string">&quot;ok&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">&quot;username&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/cPanel-Account-SSL-Management/operation/find_csrs_for_key" data-section-id="tag/cPanel-Account-SSL-Management/operation/find_csrs_for_key" class="sc-dntaoT ceciOs"><div data-section-id="operation/find_csrs_for_key" id="operation/find_csrs_for_key" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-SSL-Management/operation/find_csrs_for_key" aria-label="tag/cPanel-Account-SSL-Management/operation/find_csrs_for_key"></a>Return private key&#x27;s certificate signing requests </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves certificate signing requests (CSR) for
a private key.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you call this function, you &lt;strong&gt;must&lt;/strong&gt; include either the &lt;code&gt;id&lt;/code&gt;
or the &lt;code&gt;friendly_name&lt;/code&gt; parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves certificate signing requests (CSR) for
a private key.</p>
<p><strong>Note:</strong></p>
<p>When you call this function, you <strong>must</strong> include either the <code>id</code>
or the <code>friendly_name</code> parameter.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="friendly_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">friendly_name</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">friendly_name=TestKey</span></div><div><div html="&lt;p&gt;The key&amp;#39;s friendly name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key&#39;s friendly name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">id</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">id=example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3</span></div><div><div html="&lt;p&gt;The key&amp;#39;s ID.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key&#39;s ID.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/find_csrs_for_key</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/find_csrs_for_key</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riij5ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riij5ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riij5ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riij5ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riij5ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riij5ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riij5ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riij5ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riij5ca:0" aria-labelledby="tab:Riij5ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  find_csrs_for_key
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riij5ca:1" aria-labelledby="tab:Riij5ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riij5ca:2" aria-labelledby="tab:Riij5ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riij5ca:3" aria-labelledby="tab:Riij5ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjij5ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjij5ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjij5ca:0" aria-labelledby="tab:Rjij5ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;find_csrs_for_key&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"commonName"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token number">1538265600</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_curve_name"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_public"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"friendly_name"</span>: <span class="token string">&quot;TestCSR&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;example_com_a74f7_9dddf_2c5d1615e85db817d6b640f65335fb62&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">&quot;rsaEncryption&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">&quot;a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/cPanel-Account-SSL-Management/operation/get_cabundle" data-section-id="tag/cPanel-Account-SSL-Management/operation/get_cabundle" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_cabundle" id="operation/get_cabundle" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-SSL-Management/operation/get_cabundle" aria-label="tag/cPanel-Account-SSL-Management/operation/get_cabundle"></a>Return certificate&#x27;s CA bundle and hostname </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves a certificate&amp;#39;s Certificate Authority (CA) bundle and hostname.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;roles&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a certificate&#39;s Certificate Authority (CA) bundle and hostname.</p>
<p><strong>Important:</strong></p>
<p>When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server <a href="https://go.cpanel.net/serverroles">roles</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="cert" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">cert</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;pem-certificate&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">cert=-----BEGIN CERTIFICATE-----\r\nMIIDcTCCAlmgAwIBAgIFAU+BNVgwDQYJKoZIhvcNAQEFBQAwUTESMBAGA1UEAwwJ\r\nc2lza28udGxkMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGY1BhbmVsMQswCQYDVQQI\r\nDAJUWDEQMA4GA1UEBwwHSG91c3RvbjAeFw0xNDEwMDYyMjI2MTlaFw0xNTEwMDYy\r\nMjI2MTlaMFExEjAQBgNVBAMMCXNpc2tvLnRsZDELMAkGA1UEBhMCVVMxDzANBgNV\r\nBAoMBmNQYW5lbDELMAkGA1UECAwCVFgxEDAOBgNVBAcMB0hvdXN0b24wggEiMA0G\r\nCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9zx6zGiHdmWA0dKtoXmJiWXpZ9E3P\r\nXx3YHsjFEWW7e5pH0vZ+jVMzDmm5nsJ7RXrAkZO1IvpIpVLvoQfiJOWVvkD+o9fW\r\nvoK1tWJS72FSgPju+58mA2ieBuc87A790Pzuv1P3NR3zFLAjUR99zkHR1fpri/da\r\nM3PBWO8ET48FWkyU1kOeZaUlF67/+wrEiNgg+t1qhKOCAB61PdNVkLaSGHimksuC\r\n+Czk8Kq9nuS0E0TCnDtjjEyJ455FUcaCfczlTb8xkB/F9ORe74yTzD+vlk0tFMG6\r\nPLj/ajIwWqwO0qmQ8wX3NRxkWgGz5kVO1wrVJarKQ5EYQ3/mgvit0v6dAgMBAAGj\r\nUDBOMB0GA1UdDgQWBBRw+wKBo34+bgexjAa3EMDsgSCd7zAfBgNVHSMEGDAWgBRw\r\n+wKBo34+bgexjAa3EMDsgSCd7zAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUA\r\nA4IBAQCHRXIs53opzKM2rM8Qe8lcw524WK6hqy2EWrZHp78N7rU7/6DQ/I3hv3Wh\r\ncDDIO04I2/Xhe88MLBaLoM367Ya+vy7CaLr14aLi/SfQszMA0ALBvMao+Fis0iVw\r\nFYq/NLgSXw+fgnpFskt8v8iQZ+4Kaal8U8e9sVgu8m0RgO7rzym1eRiIKpsKd1rh\r\n/SD7LbSN7M7TRL3QqF7ltw9sQhAAsQcRaBBF21pdWrqhiGZ+Eioo3hhgwNavH2ag\r\nqz78ddHwrFpHFwrEeUk1OfpPb76MYIce7xIy/4oQNdg6fOq4l/FrajBv+WkzDVPa\r\nKm6r7YmwfLN/YMZBHXSR58oOGP9W\r\n-----END CERTIFICATE-----</span></div><div><div html="&lt;p&gt;The certificate&amp;#39;s text.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate&#39;s text.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/get_cabundle</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/get_cabundle</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riil5ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riil5ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riil5ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riil5ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riil5ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riil5ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riil5ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riil5ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riil5ca:0" aria-labelledby="tab:Riil5ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token parameter variable">--user</span><span class="token operator">=</span>username SSL get_cabundle <span class="token assign-left variable">cert</span><span class="token operator">=</span><span class="token string">'-----BEGIN CERTIFICATE-----\r\nMIIDcTCCAlmgAwIBAgIFAU+BNVgwDQYJKoZIhvcNAQEFBQAwUTESMBAGA1UEAwwJ\r\nc2lza28udGxkMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGY1BhbmVsMQswCQYDVQQI\r\nDAJUWDEQMA4GA1UEBwwHSG91c3RvbjAeFw0xNDEwMDYyMjI2MTlaFw0xNTEwMDYy\r\nMjI2MTlaMFExEjAQBgNVBAMMCXNpc2tvLnRsZDELMAkGA1UEBhMCVVMxDzANBgNV\r\nBAoMBmNQYW5lbDELMAkGA1UECAwCVFgxEDAOBgNVBAcMB0hvdXN0b24wggEiMA0G\r\nCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9zx6zGiHdmWA0dKtoXmJiWXpZ9E3P\r\nXx3YHsjFEWW7e5pH0vZ+jVMzDmm5nsJ7RXrAkZO1IvpIpVLvoQfiJOWVvkD+o9fW\r\nvoK1tWJS72FSgPju+58mA2ieBuc87A790Pzuv1P3NR3zFLAjUR99zkHR1fpri/da\r\nM3PBWO8ET48FWkyU1kOeZaUlF67/+wrEiNgg+t1qhKOCAB61PdNVkLaSGHimksuC\r\n+Czk8Kq9nuS0E0TCnDtjjEyJ455FUcaCfczlTb8xkB/F9ORe74yTzD+vlk0tFMG6\r\nPLj/ajIwWqwO0qmQ8wX3NRxkWgGz5kVO1wrVJarKQ5EYQ3/mgvit0v6dAgMBAAGj\r\nUDBOMB0GA1UdDgQWBBRw+wKBo34+bgexjAa3EMDsgSCd7zAfBgNVHSMEGDAWgBRw\r\n+wKBo34+bgexjAa3EMDsgSCd7zAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUA\r\nA4IBAQCHRXIs53opzKM2rM8Qe8lcw524WK6hqy2EWrZHp78N7rU7/6DQ/I3hv3Wh\r\ncDDIO04I2/Xhe88MLBaLoM367Ya+vy7CaLr14aLi/SfQszMA0ALBvMao+Fis0iVw\r\nFYq/NLgSXw+fgnpFskt8v8iQZ+4Kaal8U8e9sVgu8m0RgO7rzym1eRiIKpsKd1rh\r\n/SD7LbSN7M7TRL3QqF7ltw9sQhAAsQcRaBBF21pdWrqhiGZ+Eioo3hhgwNavH2ag\r\nqz78ddHwrFpHFwrEeUk1OfpPb76MYIce7xIy/4oQNdg6fOq4l/FrajBv+WkzDVPa\r\nKm6r7YmwfLN/YMZBHXSR58oOGP9W\r\n-----END CERTIFICATE-----'</span></pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riil5ca:1" aria-labelledby="tab:Riil5ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riil5ca:2" aria-labelledby="tab:Riil5ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riil5ca:3" aria-labelledby="tab:Riil5ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjil5ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjil5ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjil5ca:0" aria-labelledby="tab:Rjil5ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_cabundle&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"bundle"</span>: <span class="token string">&quot;VeriSign Trial Secure Server CA - G2&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cab"</span>: <span class="token string">&quot;-----BEGIN CERTIFICATE----- MIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD VQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv b3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV UzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU cnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyv RLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4M ypqfpX/1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/5 1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz dcZfHeFhVYAA1IFLezEPI2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl IjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4/5ODFlitppK+ULdjG+BqXH/9Apy bW1EDp3zdHSo1TRJ6V6e6bR64eVaH4QwnNOfpSXY -----END CERTIFICATE-----&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/cPanel-Account-SSL-Management/operation/get_cn_name" data-section-id="tag/cPanel-Account-SSL-Management/operation/get_cn_name" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_cn_name" id="operation/get_cn_name" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-SSL-Management/operation/get_cn_name" aria-label="tag/cPanel-Account-SSL-Management/operation/get_cn_name"></a>Request best SSL domain for service </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves the most secure domain for a service.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the most secure domain for a service.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="add_mail_subdomain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">add_mail_subdomain</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">add_mail_subdomain=0</span></div><div><div html="&lt;p&gt;Whether to append &lt;code&gt;mail&lt;/code&gt; to the &lt;code&gt;domain&lt;/code&gt; value to find the best match.&lt;/p&gt;
&lt;p&gt;For example, if you specify the domain &lt;code&gt;example.com&lt;/code&gt; and call this parameter, the
function only searches the &lt;code&gt;mail.example.com&lt;/code&gt; service domains.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Append &lt;code&gt;mail&lt;/code&gt; to the &lt;code&gt;domain&lt;/code&gt; value during the search.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Match on the specified &lt;code&gt;domain&lt;/code&gt; value &lt;strong&gt;only&lt;/strong&gt;.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to append <code>mail</code> to the <code>domain</code> value to find the best match.</p>
<p>For example, if you specify the domain <code>example.com</code> and call this parameter, the
function only searches the <code>mail.example.com</code> service domains.</p>
<ul>
<li><code>1</code> — Append <code>mail</code> to the <code>domain</code> value during the search.</li>
<li><code>0</code> — Match on the specified <code>domain</code> value <strong>only</strong>.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand domain"><span class="property-name">domain</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string or string or string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;A domain name, cPanel username, or email address.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A domain name, cPanel username, or email address.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="service" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">service</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;cpanel&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;imap&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;pop3&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;smtp&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">service=cpanel</span></div><div><div html="&lt;p&gt;The service&amp;#39;s name.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;cpanel&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;imap&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;pop3&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;smtp&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The service&#39;s name.</p>
<ul>
<li><code>cpanel</code></li>
<li><code>imap</code></li>
<li><code>pop3</code></li>
<li><code>smtp</code></li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/get_cn_name</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/get_cn_name</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riin5ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riin5ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riin5ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riin5ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riin5ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riin5ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riin5ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riin5ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riin5ca:0" aria-labelledby="tab:Riin5ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  get_cn_name <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">service</span><span class="token operator">=</span><span class="token string">'cpanel'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riin5ca:1" aria-labelledby="tab:Riin5ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riin5ca:2" aria-labelledby="tab:Riin5ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riin5ca:3" aria-labelledby="tab:Riin5ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjin5ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjin5ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjin5ca:0" aria-labelledby="tab:Rjin5ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_cn_name&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"cert_match_method"</span>: <span class="token string">&quot;hostname&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cert_valid_not_after"</span>: <span class="token number">1394288638</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_currently_valid"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_self_signed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_wild_card"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ssldomain"</span>: <span class="token string">&quot;hostname.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ssldomain_matches_cert"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/cPanel-Account-SSL-Management/operation/installed_host" data-section-id="tag/cPanel-Account-SSL-Management/operation/installed_host" class="sc-dntaoT ceciOs"><div data-section-id="operation/installed_host" id="operation/installed_host" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-SSL-Management/operation/installed_host" aria-label="tag/cPanel-Account-SSL-Management/operation/installed_host"></a>Return SSL certificate&#x27;s info for dedicated IP </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves information about a certificate that is installed on a domain&amp;#39;s dedicated IP address.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;If you do &lt;strong&gt;not&lt;/strong&gt; possess a dedicated IP address, this function will &lt;strong&gt;fail&lt;/strong&gt;. For non-dedicated IP addresses, use the &lt;code&gt;SSL::installed_hosts&lt;/code&gt; function.&lt;/li&gt;
&lt;li&gt;When you disable the &lt;em&gt;Calendars and Contacts&lt;/em&gt;, &lt;em&gt;Receive Mail&lt;/em&gt;, &lt;em&gt;Web Disk&lt;/em&gt; , &lt;em&gt;Webmail&lt;/em&gt; , &lt;strong&gt;and&lt;/strong&gt;  &lt;em&gt;Web Server&lt;/em&gt; &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;roles&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves information about a certificate that is installed on a domain&#39;s dedicated IP address.</p>
<p><strong>Important:</strong></p>
<ul>
<li>If you do <strong>not</strong> possess a dedicated IP address, this function will <strong>fail</strong>. For non-dedicated IP addresses, use the <code>SSL::installed_hosts</code> function.</li>
<li>When you disable the <em>Calendars and Contacts</em>, <em>Receive Mail</em>, <em>Web Disk</em> , <em>Webmail</em> , <strong>and</strong>  <em>Web Server</em> <a href="https://go.cpanel.net/howtouseserverprofiles#roles">roles</a>, the system <strong>disables</strong> this function.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The domain name.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;The parameter defaults to the account&amp;#39;s main domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain name.</p>
<p><strong>Note:</strong></p>
<p>The parameter defaults to the account&#39;s main domain.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="verify_certificate" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">verify_certificate</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">verify_certificate=1</span></div><div><div html="&lt;p&gt;Verify the certificate.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Verify the certificate.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Do &lt;strong&gt;not&lt;/strong&gt; verify the certificate.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Verify the certificate.</p>
<ul>
<li><code>1</code> — Verify the certificate.</li>
<li><code>0</code> — Do <strong>not</strong> verify the certificate.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/installed_host</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/installed_host</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riip5ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riip5ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riip5ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riip5ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riip5ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riip5ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riip5ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riip5ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riip5ca:0" aria-labelledby="tab:Riip5ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  installed_host
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riip5ca:1" aria-labelledby="tab:Riip5ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riip5ca:2" aria-labelledby="tab:Riip5ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riip5ca:3" aria-labelledby="tab:Riip5ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjip5ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjip5ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjip5ca:0" aria-labelledby="tab:Rjip5ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;installed_host&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"certificate"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_curve_name"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_public"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_self_signed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer.commonName"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer.organizationName"</span>: <span class="token string">&quot;Organization&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer_text"</span>: <span class="token string">&quot;commonName\nexample.com\ncountryName\nUS\nemailAddress\nusername@example.com\norganizationName\nExample\nstateOrProvinceName\nTexas\nlocalityName\nHouston&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">&quot;rsaEncryption&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">&quot;a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus_length"</span>: <span class="token number">2048</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"not_after"</span>: <span class="token number">1397169490</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"not_before"</span>: <span class="token number">1365633490</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"signature_algorithm"</span>: <span class="token string">&quot;sha256WithRSAEncryption&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject.commonName"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject_text"</span>: <span class="token string">&quot;commonName\nexample.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"validation_type"</span>: <span class="token string">&quot;dv&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"verify_error"</span>: <span class="token string">&quot;&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"host"</span>: <span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/cPanel-Account-SSL-Management/operation/installed_hosts" data-section-id="tag/cPanel-Account-SSL-Management/operation/installed_hosts" class="sc-dntaoT ceciOs"><div data-section-id="operation/installed_hosts" id="operation/installed_hosts" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-SSL-Management/operation/installed_hosts" aria-label="tag/cPanel-Account-SSL-Management/operation/installed_hosts"></a>Return domains with SSL certificate information </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves a list of the account&amp;#39;s websites, their domains, and certificate information.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  For a dedicated IP address, use the UAPI &lt;code&gt;SSL::installed_host&lt;/code&gt; function.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; When you disable the &lt;em&gt;CalendarContact&lt;/em&gt; , &lt;em&gt;MailReceive&lt;/em&gt; , &lt;em&gt;WebDisk&lt;/em&gt; , &lt;em&gt;Webmail&lt;/em&gt; , and  &lt;em&gt;WebServer&lt;/em&gt; &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;roles&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a list of the account&#39;s websites, their domains, and certificate information.</p>
<p><strong>Important:</strong></p>
<p>  For a dedicated IP address, use the UAPI <code>SSL::installed_host</code> function.</p>
<p><strong>Important:</strong></p>
<p> When you disable the <em>CalendarContact</em> , <em>MailReceive</em> , <em>WebDisk</em> , <em>Webmail</em> , and  <em>WebServer</em> <a href="https://go.cpanel.net/serverroles">roles</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/installed_hosts</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/installed_hosts</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riir5ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riir5ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riir5ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riir5ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riir5ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riir5ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riir5ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riir5ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riir5ca:0" aria-labelledby="tab:Riir5ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  installed_hosts
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riir5ca:1" aria-labelledby="tab:Riir5ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riir5ca:2" aria-labelledby="tab:Riir5ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riir5ca:3" aria-labelledby="tab:Riir5ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjir5ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjir5ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjir5ca:0" aria-labelledby="tab:Rjir5ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;installed_hosts&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"certificate"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"auto_ssl_provider"</span>: <span class="token string">&quot;cPanel&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"auto_ssl_provider_display_name"</span>: <span class="token string">&quot;Sectigo&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_curve_name"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_public"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;example_com_a74f7_9dddf_1446659822_eae1ff43c4ec1991e195877c55755eff&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_autossl"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_self_signed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer.commonName"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer.organizationName"</span>: <span class="token string">&quot;The Example Organization&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer_text"</span>: <span class="token string">&quot;example.com\ncountryName\nUS\nemailAddress\nusername@example.com\norganizationName\nExample\nstateOrProvinceName\nTexas\nlocalityName\nHouston&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">&quot;rsaEncryption&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">&quot;a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus_length"</span>: <span class="token number">2048</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"not_after"</span>: <span class="token number">1446659822</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"not_before"</span>: <span class="token number">1415123822</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"signature_algorithm"</span>: <span class="token string">&quot;sha256WithRSAEncryption&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject.commonName"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject_text"</span>: <span class="token string">&quot;commonName\nexample.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"validation_type"</span>: <span class="token string">&quot;dv&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"certificate_text"</span>: <span class="token string">&quot;-----BEGIN CERTIFICATE-----\nMIIDcTCCAlmgAwIBAgIFAU+BNVgwDQYJKoZIhvcNAQEFBQAwUTESMBAGA1UEAwwJ\nc2lza28udGxkMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGY1BhbmVsMQswCQYDVQQI\nDAJUWDEQMA4GA1UEBwwHSG91c3RvbjAeFw0xNDEwMDYyMjI2MTlaFw0xNTEwMDYy\nMjI2MTlaMFExEjAQBgNVBAMMCXNpc2tvLnRsZDELMAkGA1UEBhMCVVMxDzANBgNV\nBAoMBmNQYW5lbDELMAkGA1UECAwCVFgxEDAOBgNVBAcMB0hvdXN0b24wggEiMA0G\nCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9zx6zGiHdmWA0dKtoXmJiWXpZ9E3P\nXx3YHsjFEWW7e5pH0vZ+jVMzDmm5nsJ7RXrAkZO1IvpIpVLvoQfiJOWVvkD+o9fW\nvoK1tWJS72FSgPju+58mA2ieBuc87A790Pzuv1P3NR3zFLAjUR99zkHR1fpri/da\nM3PBWO8ET48FWkyU1kOeZaUlF67/+wrEiNgg+t1qhKOCAB61PdNVkLaSGHimksuC\n+Czk8Kq9nuS0E0TCnDtjjEyJ455FUcaCfczlTb8xkB/F9ORe74yTzD+vlk0tFMG6\nPLj/ajIwWqwO0qmQ8wX3NRxkWgGz5kVO1wrVJarKQ5EYQ3/mgvit0v6dAgMBAAGj\nUDBOMB0GA1UdDgQWBBRw+wKBo34+bgexjAa3EMDsgSCd7zAfBgNVHSMEGDAWgBRw\n+wKBo34+bgexjAa3EMDsgSCd7zAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUA\nA4IBAQCHRXIs53opzKM2rM8Qe8lcw524WK6hqy2EWrZHp78N7rU7/6DQ/I3hv3Wh\ncDDIO04I2/Xhe88MLBaLoM367Ya+vy7CaLr14aLi/SfQszMA0ALBvMao+Fis0iVw\nFYq/NLgSXw+fgnpFskt8v8iQZ+4Kaal8U8e9sVgu8m0RgO7rzym1eRiIKpsKd1rh\n/SD7LbSN7M7TRL3QqF7ltw9sQhAAsQcRaBBF21pdWrqhiGZ+Eioo3hhgwNavH2ag\nqz78ddHwrFpHFwrEeUk1OfpPb76MYIce7xIy/4oQNdg6fOq4l/FrajBv+WkzDVPa\nKm6r7YmwfLN/YMZBHXSR58oOGP9W\n-----END CERTIFICATE-----&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"docroot"</span>: <span class="token string">&quot;/home/username/public_html&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"fqdns"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;www.example.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip"</span>: <span class="token string">&quot;192.168.0.1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_primary_on_ip"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mail_sni_status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"needs_sni"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"servername"</span>: <span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/cPanel-Account-SSL-Management/operation/list_certs" data-section-id="tag/cPanel-Account-SSL-Management/operation/list_certs" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_certs" id="operation/list_certs" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-SSL-Management/operation/list_certs" aria-label="tag/cPanel-Account-SSL-Management/operation/list_certs"></a>Return all SSL certificates </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists an account&amp;#39;s certificates.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail,
and Web Server &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;roles&lt;/a&gt;,
the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists an account&#39;s certificates.</p>
<p><strong>Important:</strong></p>
<p>When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail,
and Web Server <a href="https://go.cpanel.net/howtouseserverprofiles#roles">roles</a>,
the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/list_certs</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/list_certs</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riit5ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riit5ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riit5ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riit5ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riit5ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riit5ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riit5ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riit5ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riit5ca:0" aria-labelledby="tab:Riit5ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  list_certs
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riit5ca:1" aria-labelledby="tab:Riit5ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riit5ca:2" aria-labelledby="tab:Riit5ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riit5ca:3" aria-labelledby="tab:Riit5ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjit5ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjit5ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjit5ca:0" aria-labelledby="tab:Rjit5ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_certs&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token number">1569884400</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain_is_configured"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_curve_name"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_public"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"friendly_name"</span>: <span class="token string">&quot;TestCert&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_self_signed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer.commonName"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer.organizationName"</span>: <span class="token string">&quot;Organization&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer_text"</span>: <span class="token string">&quot;countryName\nUS\nstateOrProvinceName\nTX\nlocalityName\nHouston\norganizationName\nWebPros International, LLC\ncommonName\nWebPros International, LLC Certification Authority&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">&quot;rsaEncryption&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">&quot;a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus_length"</span>: <span class="token number">2048</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"not_after"</span>: <span class="token number">1601467200</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"not_before"</span>: <span class="token number">1569844800</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"serial"</span>: <span class="token string">&quot;45462cd0d6537b20cf2f3eb8aec07140&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"signature_algorithm"</span>: <span class="token string">&quot;sha256WithRSAEncryption&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject.commonName"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject_text"</span>: <span class="token string">&quot;commonName\nwww.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"validation_type"</span>: <span class="token string">&quot;dv&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/cPanel-Account-SSL-Management/operation/list_keys" data-section-id="tag/cPanel-Account-SSL-Management/operation/list_keys" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_keys" id="operation/list_keys" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-SSL-Management/operation/list_keys" aria-label="tag/cPanel-Account-SSL-Management/operation/list_keys"></a>Return all private keys </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists an account&amp;#39;s private keys.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail,
and Web Server &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;roles&lt;/a&gt;,
the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists an account&#39;s private keys.</p>
<p><strong>Important:</strong></p>
<p>When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail,
and Web Server <a href="https://go.cpanel.net/howtouseserverprofiles#roles">roles</a>,
the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/list_keys</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/list_keys</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiv5ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiv5ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiv5ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiv5ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riiv5ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiv5ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riiv5ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiv5ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiv5ca:0" aria-labelledby="tab:Riiv5ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  list_keys
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiv5ca:1" aria-labelledby="tab:Riiv5ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiv5ca:2" aria-labelledby="tab:Riiv5ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiv5ca:3" aria-labelledby="tab:Riiv5ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjiv5ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiv5ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiv5ca:0" aria-labelledby="tab:Rjiv5ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_keys&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token number">1569844800</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_curve_name"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_public"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"friendly_name"</span>: <span class="token string">&quot;TestKey&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;b116e_473f5_ad6b3bd9517fb157830d0e37a03bc596&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">&quot;rsaEncryption&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">&quot;a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus_length"</span>: <span class="token number">2048</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/cPanel-Account-SSL-Management/operation/list_ssl_items" data-section-id="tag/cPanel-Account-SSL-Management/operation/list_ssl_items" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_ssl_items" id="operation/list_ssl_items" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-SSL-Management/operation/list_ssl_items" aria-label="tag/cPanel-Account-SSL-Management/operation/list_ssl_items"></a>Return SSL-related items </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists SSL-related items on a domain.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.com/serverroles&quot;&gt;Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists SSL-related items on a domain.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.com/serverroles">Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domains" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domains</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domains=domains=example1.com|example2.com</span> - Multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domains=example.com</span> - A single domain.</li></ul><div><div html="&lt;p&gt;The domain name or names.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain name or names.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="item" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">item</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;key&quot;</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">item=item=key|csr</span> - Multiple item types.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">item=key</span> - A single item type.</li></ul><div><div html="&lt;p&gt;The SSL item type or types.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;key&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;csr&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;crt&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The SSL item type or types.</p>
<ul>
<li><code>key</code></li>
<li><code>csr</code></li>
<li><code>crt</code></li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/list_ssl_items</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/list_ssl_items</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rij15ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rij15ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rij15ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij15ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rij15ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij15ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rij15ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij15ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rij15ca:0" aria-labelledby="tab:Rij15ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  list_ssl_items
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij15ca:1" aria-labelledby="tab:Rij15ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij15ca:2" aria-labelledby="tab:Rij15ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij15ca:3" aria-labelledby="tab:Rij15ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjj15ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj15ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj15ca:0" aria-labelledby="tab:Rjj15ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_ssl_items&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"host"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;example_com_a74f7_9dddf_1446659822_eae1ff43c4ec1991e195877c55755eff&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;key&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/cPanel-Account-SSL-Management/operation/list_csrs" data-section-id="tag/cPanel-Account-SSL-Management/operation/list_csrs" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_csrs" id="operation/list_csrs" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-SSL-Management/operation/list_csrs" aria-label="tag/cPanel-Account-SSL-Management/operation/list_csrs"></a>Return all certificate signing requests </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists an account&amp;#39;s certificate signing requests (CSR).&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the Calendars and Contacts, Receive Mail, Web Disk,
Webmail, and Web Server
&lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;roles&lt;/a&gt;,
the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists an account&#39;s certificate signing requests (CSR).</p>
<p><strong>Important:</strong></p>
<p>When you disable the Calendars and Contacts, Receive Mail, Web Disk,
Webmail, and Web Server
<a href="https://go.cpanel.net/howtouseserverprofiles#roles">roles</a>,
the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/list_csrs</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/list_csrs</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rij35ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rij35ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rij35ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij35ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rij35ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij35ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rij35ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij35ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rij35ca:0" aria-labelledby="tab:Rij35ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  list_csrs
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij35ca:1" aria-labelledby="tab:Rij35ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij35ca:2" aria-labelledby="tab:Rij35ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij35ca:3" aria-labelledby="tab:Rij35ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjj35ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj35ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj35ca:0" aria-labelledby="tab:Rjj35ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_csrs&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"commonName"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token number">1538265600</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_curve_name"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_public"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"friendly_name"</span>: <span class="token string">&quot;TestCSR&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">&quot;rsaEncryption&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">&quot;a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/cPanel-Account-SSL-Management/operation/rebuildssldb" data-section-id="tag/cPanel-Account-SSL-Management/operation/rebuildssldb" class="sc-dntaoT ceciOs"><div data-section-id="operation/rebuildssldb" id="operation/rebuildssldb" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-SSL-Management/operation/rebuildssldb" aria-label="tag/cPanel-Account-SSL-Management/operation/rebuildssldb"></a>Start SSL database rebuild </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function rebuilds the account&amp;#39;s SSL database.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function rebuilds the account&#39;s SSL database.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/rebuildssldb</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/rebuildssldb</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rij55ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rij55ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rij55ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij55ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rij55ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij55ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rij55ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij55ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rij55ca:0" aria-labelledby="tab:Rij55ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  rebuildssldb
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij55ca:1" aria-labelledby="tab:Rij55ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij55ca:2" aria-labelledby="tab:Rij55ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij55ca:3" aria-labelledby="tab:Rij55ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjj55ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj55ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj55ca:0" aria-labelledby="tab:Rjj55ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;rebuildssldb&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/cPanel-Account-SSL-Management/operation/toggle_ssl_redirect_for_domains" data-section-id="tag/cPanel-Account-SSL-Management/operation/toggle_ssl_redirect_for_domains" class="sc-dntaoT ceciOs"><div data-section-id="operation/toggle_ssl_redirect_for_domains" id="operation/toggle_ssl_redirect_for_domains" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-SSL-Management/operation/toggle_ssl_redirect_for_domains" aria-label="tag/cPanel-Account-SSL-Management/operation/toggle_ssl_redirect_for_domains"></a>Enable or disable secure redirects </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function enables or disables secure redirects (HTTPS) for the cPanel account&amp;#39;s domains that you specify.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To call this function, one of the following conditions &lt;strong&gt;must&lt;/strong&gt; exist:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;AutoSSL &lt;strong&gt;must&lt;/strong&gt; exist on the domains for which you enable secure redirects.&lt;/li&gt;
&lt;li&gt;A valid SSL certificate &lt;strong&gt;must&lt;/strong&gt; exist for each domain for which you wish to enable secure redirects.&lt;/li&gt;
&lt;li&gt;You &lt;strong&gt;must&lt;/strong&gt; own the domains for which you wish to enable secure redirects.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables or disables secure redirects (HTTPS) for the cPanel account&#39;s domains that you specify.</p>
<p><strong>Important:</strong></p>
<p>To call this function, one of the following conditions <strong>must</strong> exist:</p>
<ul>
<li>AutoSSL <strong>must</strong> exist on the domains for which you enable secure redirects.</li>
<li>A valid SSL certificate <strong>must</strong> exist for each domain for which you wish to enable secure redirects.</li>
<li>You <strong>must</strong> own the domains for which you wish to enable secure redirects.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domains" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domains</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domains=main.example,addon.example,addon.main.example</span></div><div><div html="&lt;p&gt;A comma-separated list of the cPanel account&amp;#39;s domains for which to enable or disable secure redirects.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To enable or disable redirects for addon domains, you &lt;strong&gt;must&lt;/strong&gt; pass the addon domain &lt;strong&gt;and&lt;/strong&gt; its subdomain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A comma-separated list of the cPanel account&#39;s domains for which to enable or disable secure redirects.</p>
<p><strong>Important:</strong></p>
<p>To enable or disable redirects for addon domains, you <strong>must</strong> pass the addon domain <strong>and</strong> its subdomain.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="state" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">state</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">state=1</span></div><div><div html="&lt;p&gt;Whether to enable or disable redirects for the specified domains.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Enable.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Disable.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to enable or disable redirects for the specified domains.</p>
<ul>
<li><code>1</code> — Enable.</li>
<li><code>0</code> — Disable.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/toggle_ssl_redirect_for_domains</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/toggle_ssl_redirect_for_domains</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rij75ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rij75ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rij75ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij75ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rij75ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij75ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rij75ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij75ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rij75ca:0" aria-labelledby="tab:Rij75ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  toggle_ssl_redirect_for_domains <span class="token punctuation">\</span>
  <span class="token assign-left variable">domains</span><span class="token operator">=</span><span class="token string">'main.example,addon.example,addon.main.example'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">state</span><span class="token operator">=</span><span class="token string">'1'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij75ca:1" aria-labelledby="tab:Rij75ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij75ca:2" aria-labelledby="tab:Rij75ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij75ca:3" aria-labelledby="tab:Rij75ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjj75ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj75ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj75ca:0" aria-labelledby="tab:Rjj75ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;toggle_ssl_redirect_for_domains&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;main.example&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;addon.example&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;addon.main.example&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/cPanel-Account-SSL-Management/operation/SSL::set_default_key_type" data-section-id="tag/cPanel-Account-SSL-Management/operation/SSL::set_default_key_type" class="sc-dntaoT ceciOs"><div data-section-id="operation/SSL::set_default_key_type" id="operation/SSL::set_default_key_type" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/cPanel-Account-SSL-Management/operation/SSL::set_default_key_type" aria-label="tag/cPanel-Account-SSL-Management/operation/SSL::set_default_key_type"></a>Update SSL TLS key type </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function sets a user’s preferred SSL/TLS key type.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets a user’s preferred SSL/TLS key type.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="type" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">type</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;system&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;rsa-2048&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;rsa-4096&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;ecdsa-prime256v1&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;ecdsa-secp384r1&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">type=ecdsa-prime256v1</span></div><div><div html="&lt;p&gt;The key type to set.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;system&lt;/code&gt; — Use the system’s &lt;code&gt;ssl_default_key_type&lt;/code&gt; value.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;rsa-2048&lt;/code&gt; — 2,048-bit RSA.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;rsa-4096&lt;/code&gt; — 4,096-bit RSA.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;ecdsa-prime256v1&lt;/code&gt; — ECDSA prime256v1 (“P-256”).&lt;/li&gt;
&lt;li&gt;&lt;code&gt;ecdsa-secp384r1&lt;/code&gt; — ECDSA secp384r1 (“P-384”).&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key type to set.</p>
<ul>
<li><code>system</code> — Use the system’s <code>ssl_default_key_type</code> value.</li>
<li><code>rsa-2048</code> — 2,048-bit RSA.</li>
<li><code>rsa-4096</code> — 4,096-bit RSA.</li>
<li><code>ecdsa-prime256v1</code> — ECDSA prime256v1 (“P-256”).</li>
<li><code>ecdsa-secp384r1</code> — ECDSA secp384r1 (“P-384”).</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/set_default_key_type</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/set_default_key_type</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rij95ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rij95ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rij95ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij95ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rij95ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij95ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rij95ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij95ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rij95ca:0" aria-labelledby="tab:Rij95ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  set_default_key_type <span class="token punctuation">\</span>
  <span class="token assign-left variable">type</span><span class="token operator">=</span><span class="token string">'ecdsa-prime256v1'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij95ca:1" aria-labelledby="tab:Rij95ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij95ca:2" aria-labelledby="tab:Rij95ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij95ca:3" aria-labelledby="tab:Rij95ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjj95ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj95ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj95ca:0" aria-labelledby="tab:Rjj95ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_default_key_type&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/SNI-Email-Settings" data-section-id="tag/SNI-Email-Settings" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SNI-Email-Settings" aria-label="tag/SNI-Email-Settings"></a>SNI Email Settings</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;SSL Certificates / SNI Email Settings&lt;/p&gt;
"><p>SSL Certificates / SNI Email Settings</p>
</div></div></div><div id="tag/SNI-Email-Settings/operation/enable_mail_sni" data-section-id="tag/SNI-Email-Settings/operation/enable_mail_sni" class="sc-dntaoT ceciOs"><div data-section-id="operation/enable_mail_sni" id="operation/enable_mail_sni" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SNI-Email-Settings/operation/enable_mail_sni" aria-label="tag/SNI-Email-Settings/operation/enable_mail_sni"></a>Enable SNI mail services for domain </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function enables SNI mail services on the specified domains.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;Mail SNI is &lt;strong&gt;always&lt;/strong&gt; enabled.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;Mail SNI is &lt;strong&gt;not&lt;/strong&gt; compatible with Webmail and will &lt;strong&gt;not&lt;/strong&gt; function for any Webmail connection. Webmail connections use the cPanel service SSL certificate.&lt;/li&gt;
&lt;li&gt;Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled.&lt;/li&gt;
&lt;li&gt;Functions that disable Mail SNI fail and make no changes.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;em&gt;Calendars and Contacts&lt;/em&gt;, &lt;em&gt;Mail Receive&lt;/em&gt;, &lt;em&gt;Web Disk&lt;/em&gt;, &lt;em&gt;Webmail&lt;/em&gt;, &lt;strong&gt;and&lt;/strong&gt; &lt;em&gt;Web Server&lt;/em&gt; &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;roles&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables SNI mail services on the specified domains.</p>
<p><strong>Warning:</strong></p>
<p>Mail SNI is <strong>always</strong> enabled.</p>
<ul>
<li>Mail SNI is <strong>not</strong> compatible with Webmail and will <strong>not</strong> function for any Webmail connection. Webmail connections use the cPanel service SSL certificate.</li>
<li>Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled.</li>
<li>Functions that disable Mail SNI fail and make no changes.</li>
</ul>
<p><strong>Important:</strong></p>
<p>  When you disable the <em>Calendars and Contacts</em>, <em>Mail Receive</em>, <em>Web Disk</em>, <em>Webmail</em>, <strong>and</strong> <em>Web Server</em> <a href="https://go.cpanel.net/howtouseserverprofiles#roles">roles</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domains" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domains</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domains=example.com|example1.com|example2.com</span></div><div><div html="&lt;p&gt;A pipe-delimited list of the account&amp;#39;s domains.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A pipe-delimited list of the account&#39;s domains.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/enable_mail_sni</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/enable_mail_sni</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kj7ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kj7ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kj7ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj7ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kj7ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj7ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kj7ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj7ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kj7ca:0" aria-labelledby="tab:R4kj7ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  enable_mail_sni <span class="token punctuation">\</span>
  <span class="token assign-left variable">domains</span><span class="token operator">=</span><span class="token string">'example.com|example1.com|example2.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj7ca:1" aria-labelledby="tab:R4kj7ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj7ca:2" aria-labelledby="tab:R4kj7ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj7ca:3" aria-labelledby="tab:R4kj7ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sj7ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sj7ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sj7ca:0" aria-labelledby="tab:R4sj7ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;enable_mail_sni&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"failed_domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"example2.com"</span>: <span class="token string">&quot;Sorry, example.com is not one of the domains on your account.&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updated_domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"example.com"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"example1.com"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;cPanel &amp; WHM always enables mail SNI from now on.&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/SNI-Email-Settings/operation/disable_mail_sni" data-section-id="tag/SNI-Email-Settings/operation/disable_mail_sni" class="sc-dntaoT ceciOs"><div data-section-id="operation/disable_mail_sni" id="operation/disable_mail_sni" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SNI-Email-Settings/operation/disable_mail_sni" aria-label="tag/SNI-Email-Settings/operation/disable_mail_sni"></a>Disable SNI mail services for domain </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function disables SNI mail services on the specified domains.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  Mail SNI is &lt;strong&gt;always&lt;/strong&gt; enabled.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;After you change the SNI status, you &lt;strong&gt;must&lt;/strong&gt; run UAPI&amp;#39;s &lt;code&gt;rebuild_mail_sni_config&lt;/code&gt; function.&lt;/li&gt;
&lt;li&gt;Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled.&lt;/li&gt;
&lt;li&gt;Functions that disable Mail SNI fail and make no changes.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables SNI mail services on the specified domains.</p>
<p><strong>Note:</strong></p>
<p>  Mail SNI is <strong>always</strong> enabled.</p>
<ul>
<li>After you change the SNI status, you <strong>must</strong> run UAPI&#39;s <code>rebuild_mail_sni_config</code> function.</li>
<li>Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled.</li>
<li>Functions that disable Mail SNI fail and make no changes.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domains" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domains</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domains=example.com|example1.com|example2.com</span></div><div><div html="&lt;p&gt;A pipe-delimited list of the account&amp;#39;s domains.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A pipe-delimited list of the account&#39;s domains.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/disable_mail_sni</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/disable_mail_sni</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kl7ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kl7ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kl7ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl7ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kl7ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl7ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kl7ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl7ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kl7ca:0" aria-labelledby="tab:R4kl7ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  disable_mail_sni <span class="token punctuation">\</span>
  <span class="token assign-left variable">domains</span><span class="token operator">=</span><span class="token string">'example.com|example1.com|example2.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl7ca:1" aria-labelledby="tab:R4kl7ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl7ca:2" aria-labelledby="tab:R4kl7ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl7ca:3" aria-labelledby="tab:R4kl7ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sl7ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sl7ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sl7ca:0" aria-labelledby="tab:R4sl7ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;disable_mail_sni&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"failed_domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"example2.com"</span>: <span class="token string">&quot;Sorry, example2.com is not one of the domains on your account.&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updated_domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"example.com"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"example1.com"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/SNI-Email-Settings/operation/is_mail_sni_supported" data-section-id="tag/SNI-Email-Settings/operation/is_mail_sni_supported" class="sc-dntaoT ceciOs"><div data-section-id="operation/is_mail_sni_supported" id="operation/is_mail_sni_supported" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SNI-Email-Settings/operation/is_mail_sni_supported" aria-label="tag/SNI-Email-Settings/operation/is_mail_sni_supported"></a>Return whether mail SNI is enabled </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function checks whether the sslinstall feature is enabled.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;Mail SNI is always enabled.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;Mail SNI is &lt;strong&gt;not&lt;/strong&gt; compatible with Webmail and will &lt;strong&gt;not&lt;/strong&gt; function for any Webmail connection. Webmail connections use the cPanel service SSL certificate.&lt;/li&gt;
&lt;li&gt;Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled.&lt;/li&gt;
&lt;li&gt;Functions that disable Mail SNI will fail and make no changes.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether the sslinstall feature is enabled.</p>
<p><strong>Warning:</strong></p>
<p>Mail SNI is always enabled.</p>
<ul>
<li>Mail SNI is <strong>not</strong> compatible with Webmail and will <strong>not</strong> function for any Webmail connection. Webmail connections use the cPanel service SSL certificate.</li>
<li>Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled.</li>
<li>Functions that disable Mail SNI will fail and make no changes.</li>
</ul>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/is_mail_sni_supported</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/is_mail_sni_supported</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kn7ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kn7ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kn7ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn7ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kn7ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn7ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kn7ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn7ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kn7ca:0" aria-labelledby="tab:R4kn7ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  is_mail_sni_supported
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn7ca:1" aria-labelledby="tab:R4kn7ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn7ca:2" aria-labelledby="tab:R4kn7ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn7ca:3" aria-labelledby="tab:R4kn7ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sn7ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sn7ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sn7ca:0" aria-labelledby="tab:R4sn7ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;is_mail_sni_supported&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/SNI-Email-Settings/operation/is_sni_supported" data-section-id="tag/SNI-Email-Settings/operation/is_sni_supported" class="sc-dntaoT ceciOs"><div data-section-id="operation/is_sni_supported" id="operation/is_sni_supported" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SNI-Email-Settings/operation/is_sni_supported" aria-label="tag/SNI-Email-Settings/operation/is_sni_supported"></a>Return whether Apache web server supports mail SNI </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function checks whether the Apache web server supports SNI.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether the Apache web server supports SNI.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/is_sni_supported</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/is_sni_supported</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kp7ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kp7ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kp7ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp7ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kp7ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp7ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kp7ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp7ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kp7ca:0" aria-labelledby="tab:R4kp7ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  is_sni_supported
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp7ca:1" aria-labelledby="tab:R4kp7ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp7ca:2" aria-labelledby="tab:R4kp7ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp7ca:3" aria-labelledby="tab:R4kp7ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sp7ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sp7ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sp7ca:0" aria-labelledby="tab:R4sp7ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;is_sni_supported&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/SNI-Email-Settings/operation/mail_sni_status" data-section-id="tag/SNI-Email-Settings/operation/mail_sni_status" class="sc-dntaoT ceciOs"><div data-section-id="operation/mail_sni_status" id="operation/mail_sni_status" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SNI-Email-Settings/operation/mail_sni_status" aria-label="tag/SNI-Email-Settings/operation/mail_sni_status"></a>Return status of domain&#x27;s SNI mail services </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves the status of the domain&amp;#39;s SNI mail services.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;Mail SNI is &lt;strong&gt;not&lt;/strong&gt; compatible with Webmail and will not function for any Webmail connection. Webmail connections use the cPanel service SSL certificate.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;Mail SNI is always enabled.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled.&lt;/li&gt;
&lt;li&gt;Functions that disable Mail SNI fail and make no changes.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the status of the domain&#39;s SNI mail services.</p>
<p><strong>Warning:</strong></p>
<p>Mail SNI is <strong>not</strong> compatible with Webmail and will not function for any Webmail connection. Webmail connections use the cPanel service SSL certificate.</p>
<p><strong>Note:</strong></p>
<p>Mail SNI is always enabled.</p>
<ul>
<li>Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled.</li>
<li>Functions that disable Mail SNI fail and make no changes.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The account&amp;#39;s domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The account&#39;s domain.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/mail_sni_status</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/mail_sni_status</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kr7ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kr7ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kr7ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kr7ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kr7ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kr7ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kr7ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kr7ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kr7ca:0" aria-labelledby="tab:R4kr7ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  mail_sni_status <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kr7ca:1" aria-labelledby="tab:R4kr7ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kr7ca:2" aria-labelledby="tab:R4kr7ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kr7ca:3" aria-labelledby="tab:R4kr7ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sr7ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sr7ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sr7ca:0" aria-labelledby="tab:R4sr7ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;mail_sni_status&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/SNI-Email-Settings/operation/rebuild_mail_sni_config" data-section-id="tag/SNI-Email-Settings/operation/rebuild_mail_sni_config" class="sc-dntaoT ceciOs"><div data-section-id="operation/rebuild_mail_sni_config" id="operation/rebuild_mail_sni_config" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SNI-Email-Settings/operation/rebuild_mail_sni_config" aria-label="tag/SNI-Email-Settings/operation/rebuild_mail_sni_config"></a>Start SNI configuration files rebuild </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function rebuilds the SNI configuration files.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;You &lt;strong&gt;must&lt;/strong&gt; run this function after you change the SNI status through the UAPI&amp;#39;s &lt;code&gt;enable_mail_sni&lt;/code&gt; or &lt;code&gt;disable_mail_sni&lt;/code&gt; functions.&lt;/li&gt;
&lt;li&gt;Mail SNI is &lt;strong&gt;always&lt;/strong&gt; enabled.&lt;ul&gt;
&lt;li&gt;Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled. Functions that disable Mail SNI fail and make no changes.&lt;/li&gt;
&lt;li&gt;Functions that disable Mail SNI will fail and make no changes.&lt;/li&gt;
&lt;/ul&gt;
&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; When you disable the &lt;em&gt;Calendars and Contacts&lt;/em&gt;, &lt;em&gt;Receive Mail&lt;/em&gt;, &lt;em&gt;Web Disk&lt;/em&gt;, &lt;em&gt;Webmail&lt;/em&gt;, &lt;strong&gt;and&lt;/strong&gt;  &lt;em&gt;Web Server&lt;/em&gt; &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;roles&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function rebuilds the SNI configuration files.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You <strong>must</strong> run this function after you change the SNI status through the UAPI&#39;s <code>enable_mail_sni</code> or <code>disable_mail_sni</code> functions.</li>
<li>Mail SNI is <strong>always</strong> enabled.<ul>
<li>Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled. Functions that disable Mail SNI fail and make no changes.</li>
<li>Functions that disable Mail SNI will fail and make no changes.</li>
</ul>
</li>
</ul>
<p><strong>Important:</strong></p>
<p> When you disable the <em>Calendars and Contacts</em>, <em>Receive Mail</em>, <em>Web Disk</em>, <em>Webmail</em>, <strong>and</strong>  <em>Web Server</em> <a href="https://go.cpanel.net/serverroles">roles</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="reload_dovecot" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">reload_dovecot</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">reload_dovecot=1</span></div><div><div html="&lt;p&gt;Whether to reload the Dovecot service after the system rebuilds
the configuration files.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Reload Dovecot.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Do &lt;strong&gt;not&lt;/strong&gt; reload Dovecot.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to reload the Dovecot service after the system rebuilds
the configuration files.</p>
<ul>
<li><code>1</code> - Reload Dovecot.</li>
<li><code>0</code> - Do <strong>not</strong> reload Dovecot.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/rebuild_mail_sni_config</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/rebuild_mail_sni_config</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kt7ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kt7ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kt7ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kt7ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kt7ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kt7ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kt7ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kt7ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kt7ca:0" aria-labelledby="tab:R4kt7ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  rebuild_mail_sni_config
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kt7ca:1" aria-labelledby="tab:R4kt7ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kt7ca:2" aria-labelledby="tab:R4kt7ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kt7ca:3" aria-labelledby="tab:R4kt7ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4st7ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4st7ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4st7ca:0" aria-labelledby="tab:R4st7ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;rebuild_mail_sni_config&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"success"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/SSL-Certificate-Management" data-section-id="tag/SSL-Certificate-Management" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSL-Certificate-Management" aria-label="tag/SSL-Certificate-Management"></a>SSL Certificate Management</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;SSL Certificates / SSL Certificate Management&lt;/p&gt;
"><p>SSL Certificates / SSL Certificate Management</p>
</div></div></div><div id="tag/SSL-Certificate-Management/operation/install_ssl" data-section-id="tag/SSL-Certificate-Management/operation/install_ssl" class="sc-dntaoT ceciOs"><div data-section-id="operation/install_ssl" id="operation/install_ssl" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSL-Certificate-Management/operation/install_ssl" aria-label="tag/SSL-Certificate-Management/operation/install_ssl"></a>Install SSL certificate </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function installs an SSL certificate.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;Due to their inherent complexities, SSL-related functions often present problems for third-party developers. For the additional steps required to successfully call this function, read our &lt;a href=&quot;https://go.cpanel.net/tutorial-call-uapis-ssl-install-ssl-function-in-custom-code&quot;&gt;Call UAPI&amp;#39;s SSL::install_ssl Function in Custom Code&lt;/a&gt; documentation.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;em&gt;Calendars and Contacts&lt;/em&gt;, &lt;em&gt;Receive Mail&lt;/em&gt;, &lt;em&gt;Web Disk&lt;/em&gt;, &lt;em&gt;Webmail&lt;/em&gt;, and &lt;em&gt;Web Server&lt;/em&gt; &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;roles&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function installs an SSL certificate.</p>
<p><strong>Note:</strong></p>
<p>Due to their inherent complexities, SSL-related functions often present problems for third-party developers. For the additional steps required to successfully call this function, read our <a href="https://go.cpanel.net/tutorial-call-uapis-ssl-install-ssl-function-in-custom-code">Call UAPI&#39;s SSL::install_ssl Function in Custom Code</a> documentation.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <em>Calendars and Contacts</em>, <em>Receive Mail</em>, <em>Web Disk</em>, <em>Webmail</em>, and <em>Web Server</em> <a href="https://go.cpanel.net/serverroles">roles</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="cabundle" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">cabundle</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;pem-certificate&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">cabundle=-----BEGIN%20CERTIFICATE-----%0AMIIB%2BjCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD%0AVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv%0Ab3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV%0AUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU%0AcnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k%2B625h8cXyv%0ARLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz%2BiCWaEVh43KRuH6X4M%0AypqfpX%2F1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt%2F5%0A1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz%0AdcZfHeFhVYAA1IFLezEPI2PnPfMD%2BfQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl%0AIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4%2F5ODFlitppK%2BULdjG%2BBqXH%2F9Apy%0AbW1EDp3zdHSo1TRJ6V6e6bR64eVaH4QwnNOfpSXY%0A-----END%20CERTIFICATE-----</span></div><div><div html="&lt;p&gt;The Certificate Authority (CA) bundle data, if the certificate requires it.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;p&gt;You &lt;strong&gt;must&lt;/strong&gt; URI-encode this value.&lt;/p&gt;
&lt;/li&gt;
&lt;li&gt;&lt;p&gt;You can use a Perl command to URI-encode your SSL certificate for this parameter.
For example, you can use the following string, where &lt;code&gt;CABUNDLE.FILE&lt;/code&gt; is the SSL certificate file:&lt;/p&gt;
&lt;p&gt;&lt;code&gt;$(perl -MURI::Escape -ne &amp;#39;print uri_escape($_);&amp;#39; CABUNDLE.FILE)&lt;/code&gt;&lt;/p&gt;
&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Certificate Authority (CA) bundle data, if the certificate requires it.</p>
<p><strong>Note:</strong></p>
<ul>
<li><p>You <strong>must</strong> URI-encode this value.</p>
</li>
<li><p>You can use a Perl command to URI-encode your SSL certificate for this parameter.
For example, you can use the following string, where <code>CABUNDLE.FILE</code> is the SSL certificate file:</p>
<p><code>$(perl -MURI::Escape -ne &#39;print uri_escape($_);&#39; CABUNDLE.FILE)</code></p>
</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="cert" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">cert</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;pem-certificate&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">cert=-----BEGIN%20CERTIFICATE-----%0AMIIEEzCCAvugAwIBAgIJALF%2FjFpw6p1bMA0GCSqGSIb3DQEBBQUAMIGfMRYwFAYD%0AVQQDEw10ZXN0c2ltb24uY29tMRYwFAYDVQQLEw1Eb2N1bWVudGF0aW9uMQswCQYD%0AVQQGEwJVUzEoMCYGCSqGSIb3DQEJARYZbGF1cmVuY2Uuc2ltb25AY3BhbmVsLm5l%0AdDEUMBIGA1UEChMLY1BhbmVsIEluYy4xDjAMBgNVBAgTBVRleGFzMRAwDgYDVQQH%0AEwdIb3VzdG9uMB4XDTEzMDUxNzE2MTMwN1oXDTE0MDUxNzE2MTMwN1owgZ8xFjAU%0ABgNVBAMTDXRlc3RzaW1vbi5jb20xFjAUBgNVBAsTDURvY3VtZW50YXRpb24xCzAJ%0ABgNVBAYTAlVTMSgwJgYJKoZIhvcNAQkBFhlsYXVyZW5jZS5zaW1vbkBjcGFuZWwu%0AbmV0MRQwEgYDVQQKEwtjUGFuZWwgSW5jLjEOMAwGA1UECBMFVGV4YXMxEDAOBgNV%0ABAcTB0hvdXN0b24wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDRO0AP%0AN5XtjDqkEyJ6ctfYqUtt9yUXyRuCETFjW6opNLSmZSHeF6L2aZka646lhj02CFyl%0AkzsNSxysN66tY%2BWZcTmvgPisJdQFpFvjroJZgDjYRV0QqokKdRy%2F5BU0%2BtHXoYpj%0A9JOQlbvEWxiGR3R80sL1ma4AfSE6Gv8M%2FPULTadan51eHaikXqjOXdPJQKuWP3g9%0AFnIuf38WRYwzGrre88qsZrpsMrADX5dotHWgqAf7Tap6xfA4CUAgQo9tldariuVi%0ABz%2BsRJ%2FSjgxnhw1HYWGttBuBZFhMpdHpPnTJ7DIFMd%2FFN5gG%2Ftah30SapWpo35Ux%0A3BpJcdUjtazy82K5AgMBAAGjUDBOMB0GA1UdDgQWBBQAlv7%2FtALOYb7zAXbYG2%2B9%0AAMI3xjAfBgNVHSMEGDAWgBQAlv7%2FtALOYb7zAXbYG2%2B9AMI3xjAMBgNVHRMEBTAD%0AAQH%2FMA0GCSqGSIb3DQEBBQUAA4IBAQCxzpe71Hc7Es0dqIN7bhIFYIIgcr6wxM6a%0Aa9d%2BQG%2BQPH0x0KAqV8EgUbZysvyxEF0bPxW3ZAr1Is1wk80PMuU3bToFFVbFFIIr%0AHRNfKLGvxiMXnZA1c6L4N0lowvXHgZxTTUXtDFLXyrcwrLsvUErEV7rbizuxqfPw%0AcaRtXn4uc%2Bt6HYuW7yWesBauCWnJNiKbjN%2FF%2BuCTurN3QMAeWf3ZJtsfkAgk8dyq%0AR%2F83a3kDtSPrpt%2BjX%2BqdjKEpRtQ5Qpm6XT2gCOQPgnfiUtOCH419pp922P%2FAAGc%2B%0AZUhYoWcRWKw%2Fy6gI7Ru%2B%2B9%2B8%2BwkadL9EbKMZxhVwD5qVm4ZlWK2a%5Cr%5Cn%0A-----END%20CERTIFICATE-----</span></div><div><div html="&lt;p&gt;The certificate to install.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;p&gt;You &lt;strong&gt;must&lt;/strong&gt; URI-encode this value.&lt;/p&gt;
&lt;/li&gt;
&lt;li&gt;&lt;p&gt;You can use a Perl command to URI-encode your SSL certificate for this parameter.
For example, you can use the following string, where &lt;code&gt;CERT.FILE&lt;/code&gt; is the SSL certificate file:&lt;/p&gt;
&lt;p&gt;&lt;code&gt;$(perl -MURI::Escape -ne &amp;#39;print uri_escape($_);&amp;#39; CERT.FILE)&lt;/code&gt;&lt;/p&gt;
&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate to install.</p>
<p><strong>Note:</strong></p>
<ul>
<li><p>You <strong>must</strong> URI-encode this value.</p>
</li>
<li><p>You can use a Perl command to URI-encode your SSL certificate for this parameter.
For example, you can use the following string, where <code>CERT.FILE</code> is the SSL certificate file:</p>
<p><code>$(perl -MURI::Escape -ne &#39;print uri_escape($_);&#39; CERT.FILE)</code></p>
</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The domain name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="key" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">key</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;pem-private-key&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key=-----BEGIN%20RSA%20PRIVATE%20KEY-----%0AMIIEpAIBAAKCAQEA4AVM6J4Qg3DIFWr%2FeJ5GRmIATYsJIepKbrDy70sq%2BudcO8R8%0Axxak0oMZ%2F9mUdpjSNK%2FfLVTuCO0kxTfQ9VUWJllX7ThD6Zh9ZvlC%2Fnf%2FOEZLm3Zb%0ABgu8rbC8E9wuDOkKbJLnINgdhtowIydLK2MJ%2B%2Bq62bFV89jkHWTMcKyyqHENo3h%0Ac%2Blkpd9vnp8rZTinaVb7nX26uQqAFZYRo%2BWU0G%2FNPsq40QVSMoqPxyEz4qXo0hvu%0AIlCXmzFZq%2F6fCVPEKPLhQgMmpdBkMz4dVOazREfqXdjMD2%2BQXSNiA1AwWr8l0r4r%0AtzlxEYDJIR41yXp0xMl3KoolxMyvLBqZy32niQIDAQABAoIBAQCmbGmhWmPsMeoC%0At1WJFxQgD4goE0U6k%2BKt7vjbOt14Pk6v%2FB2yjaju1wSGpO59WLS4%2FXrwI2se6IXr%0Amba7u3VUEgWXLriNHoLy7%2FSMNTs%2BZEKhAMG36eNe3tVdT7busTag31r6sEMGGwCs%0AIwpU%2Bazosk0oylWLEX%2Fm%2FuHWEs1eaIEWWWtgHB%2BKZrrP7Rr9RYfVQ144DxmOxS3C%0Aa9%2BmST62WqAVPR6POWGEfZqnZl%2FePWZPcQYbFrhwnnefNoYBl%2FbnLZBo8rbNWxAq%0AOEOuKfkrBzglKG%2F39WKPw8rj4JIVzY0yOuFCW6xCDWRkOrhU8Ol%2F3FvwDa3uJpkp%0AmgPr4TgxAoGBAPGPLmxSuOYR97mDAXxrs037F2GCbqWvI6m7%2FezWe9yn%2BbMpjSIW%0Afsgtq4FsyqzPueEkDdQWi3xh6nu2WI%2F1Tl875opGAqEIJMqss%2Fu11tnva5wzu1cC%0AL6H85A5%2BHMOBvP3sm6CObKcVw92h7kxynVIUJJWhjfeZMN8gBFFpKIVFAoGBAO1p%0AtXBmXLC%2FYKKvtHI3M16%2FZopvM8ZqU2HcAHaw214Refw9JJ%2Fe3%2FxTNfSerVTyCAQO%0A1AdWTzJKBN8jmSYv1Mk1D3RpQPNR7wVzi46KR081AU41uMpqIGVOwHtyVnW%2FZfLr%0Ac1DLIK8Cx8aHfoxffwzoMO5SEQSooeZfOLhsfDN1AoGBAKQTUEINsj%2B75psgbAr6%0AELGgItJ9yPBLVRr%2BcUzEpx9LDWVvjMihpP4NX1gq8EOPWT%2BewLHVmmsjCyV6xw8J%0AXXF8e2xif3in0m3D%2FwCzE7u2T06rKM3B017hKnrZmGoHnrqPU2osM4sOUpshWX6d%0Av1Q4EF1%2BfbK3YCW%2BVpCBsB9NAoGAQo%2BuhNLODee56iKkzpjXWCsFTq6ar3hD5F3P%0A63buKdNwhd2GlSPhXFbf%2B7M5GWW6BZk6rMvv7EOAVice2uvyFm8%2F4%2F1WbmF8R%2BT7%0ALX1rPLO5p%2Fm701QpvP11TabiwqRkqtSEQhSRF0AKTojSW%2FyyHCZFAawUhV%2FZ9EKi%0AHmKb97kCgYAyzmFc2it0HqnsOnRybop603nqMtWGTQO4cxa93HUDpYajuK2K3Dfr%0AxUj6lG3z%2FoKJGGE2JqgZ6LBAhNJtJWJu2ox3pKGE63QjLJnVwb8y1NFYpe%2FcrbLe%0APuBwIR0L7drXxfv7O5btY7h6QI2d1%2FUIAQPAWbxLoTM%2BndQ%2FuPEdfA%3D%3D%0A-----END%20RSA%20PRIVATE%20KEY-----</span></div><div><div html="&lt;p&gt;The certificate&amp;#39;s key.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;p&gt;You &lt;strong&gt;must&lt;/strong&gt; URI-encode this value.&lt;/p&gt;
&lt;/li&gt;
&lt;li&gt;&lt;p&gt;You can use a Perl command to URI-encode your SSL certificate for this parameter.
For example, you can use the following string, where &lt;code&gt;KEY.FILE&lt;/code&gt; is the SSL certificate file:&lt;/p&gt;
&lt;p&gt;&lt;code&gt;$(perl -MURI::Escape -ne &amp;#39;print uri_escape($_);&amp;#39; KEY.FILE)&lt;/code&gt;&lt;/p&gt;
&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate&#39;s key.</p>
<p><strong>Note:</strong></p>
<ul>
<li><p>You <strong>must</strong> URI-encode this value.</p>
</li>
<li><p>You can use a Perl command to URI-encode your SSL certificate for this parameter.
For example, you can use the following string, where <code>KEY.FILE</code> is the SSL certificate file:</p>
<p><code>$(perl -MURI::Escape -ne &#39;print uri_escape($_);&#39; KEY.FILE)</code></p>
</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/install_ssl</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/install_ssl</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rii39ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rii39ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rii39ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii39ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rii39ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii39ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rii39ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii39ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rii39ca:0" aria-labelledby="tab:Rii39ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token parameter variable">--user</span><span class="token operator">=</span>username SSL install_ssl <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span> <span class="token assign-left variable">cert</span><span class="token operator">=</span><span class="token string">'-----BEGIN%20CERTIFICATE-----%0AMIIEEzCCAvugAwIBAgIJALF%2FjFpw6p1bMA0GCSqGSIb3DQEBBQUAMIGfMRYwFAYD%0AVQQDEw10ZXN0c2ltb24uY29tMRYwFAYDVQQLEw1Eb2N1bWVudGF0aW9uMQswCQYD%0AVQQGEwJVUzEoMCYGCSqGSIb3DQEJARYZbGF1cmVuY2Uuc2ltb25AY3BhbmVsLm5l%0AdDEUMBIGA1UEChMLY1BhbmVsIEluYy4xDjAMBgNVBAgTBVRleGFzMRAwDgYDVQQH%0AEwdIb3VzdG9uMB4XDTEzMDUxNzE2MTMwN1oXDTE0MDUxNzE2MTMwN1owgZ8xFjAU%0ABgNVBAMTDXRlc3RzaW1vbi5jb20xFjAUBgNVBAsTDURvY3VtZW50YXRpb24xCzAJ%0ABgNVBAYTAlVTMSgwJgYJKoZIhvcNAQkBFhlsYXVyZW5jZS5zaW1vbkBjcGFuZWwu%0AbmV0MRQwEgYDVQQKEwtjUGFuZWwgSW5jLjEOMAwGA1UECBMFVGV4YXMxEDAOBgNV%0ABAcTB0hvdXN0b24wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDRO0AP%0AN5XtjDqkEyJ6ctfYqUtt9yUXyRuCETFjW6opNLSmZSHeF6L2aZka646lhj02CFyl%0AkzsNSxysN66tY%2BWZcTmvgPisJdQFpFvjroJZgDjYRV0QqokKdRy%2F5BU0%2BtHXoYpj%0A9JOQlbvEWxiGR3R80sL1ma4AfSE6Gv8M%2FPULTadan51eHaikXqjOXdPJQKuWP3g9%0AFnIuf38WRYwzGrre88qsZrpsMrADX5dotHWgqAf7Tap6xfA4CUAgQo9tldariuVi%0ABz%2BsRJ%2FSjgxnhw1HYWGttBuBZFhMpdHpPnTJ7DIFMd%2FFN5gG%2Ftah30SapWpo35Ux%0A3BpJcdUjtazy82K5AgMBAAGjUDBOMB0GA1UdDgQWBBQAlv7%2FtALOYb7zAXbYG2%2B9%0AAMI3xjAfBgNVHSMEGDAWgBQAlv7%2FtALOYb7zAXbYG2%2B9AMI3xjAMBgNVHRMEBTAD%0AAQH%2FMA0GCSqGSIb3DQEBBQUAA4IBAQCxzpe71Hc7Es0dqIN7bhIFYIIgcr6wxM6a%0Aa9d%2BQG%2BQPH0x0KAqV8EgUbZysvyxEF0bPxW3ZAr1Is1wk80PMuU3bToFFVbFFIIr%0AHRNfKLGvxiMXnZA1c6L4N0lowvXHgZxTTUXtDFLXyrcwrLsvUErEV7rbizuxqfPw%0AcaRtXn4uc%2Bt6HYuW7yWesBauCWnJNiKbjN%2FF%2BuCTurN3QMAeWf3ZJtsfkAgk8dyq%0AR%2F83a3kDtSPrpt%2BjX%2BqdjKEpRtQ5Qpm6XT2gCOQPgnfiUtOCH419pp922P%2FAAGc%2B%0AZUhYoWcRWKw%2Fy6gI7Ru%2B%2B9%2B8%2BwkadL9EbKMZxhVwD5qVm4ZlWK2a%5Cr%5Cn%0A-----END%20CERTIFICATE-----'</span> <span class="token assign-left variable">key</span><span class="token operator">=</span><span class="token string">'-----BEGIN%20RSA%20PRIVATE%20KEY-----%0AMIIEpAIBAAKCAQEA4AVM6J4Qg3DIFWr%2FeJ5GRmIATYsJIepKbrDy70sq%2BudcO8R8%0Axxak0oMZ%2F9mUdpjSNK%2FfLVTuCO0kxTfQ9VUWJllX7ThD6Zh9ZvlC%2Fnf%2FOEZLm3Zb%0ABgu8rbC8E9wuDOkKbJLnINgdhtowIydLK2MJ%2B%2Bq62bFV89jkHWTMcKyyqHENo3h%0Ac%2Blkpd9vnp8rZTinaVb7nX26uQqAFZYRo%2BWU0G%2FNPsq40QVSMoqPxyEz4qXo0hvu%0AIlCXmzFZq%2F6fCVPEKPLhQgMmpdBkMz4dVOazREfqXdjMD2%2BQXSNiA1AwWr8l0r4r%0AtzlxEYDJIR41yXp0xMl3KoolxMyvLBqZy32niQIDAQABAoIBAQCmbGmhWmPsMeoC%0At1WJFxQgD4goE0U6k%2BKt7vjbOt14Pk6v%2FB2yjaju1wSGpO59WLS4%2FXrwI2se6IXr%0Amba7u3VUEgWXLriNHoLy7%2FSMNTs%2BZEKhAMG36eNe3tVdT7busTag31r6sEMGGwCs%0AIwpU%2Bazosk0oylWLEX%2Fm%2FuHWEs1eaIEWWWtgHB%2BKZrrP7Rr9RYfVQ144DxmOxS3C%0Aa9%2BmST62WqAVPR6POWGEfZqnZl%2FePWZPcQYbFrhwnnefNoYBl%2FbnLZBo8rbNWxAq%0AOEOuKfkrBzglKG%2F39WKPw8rj4JIVzY0yOuFCW6xCDWRkOrhU8Ol%2F3FvwDa3uJpkp%0AmgPr4TgxAoGBAPGPLmxSuOYR97mDAXxrs037F2GCbqWvI6m7%2FezWe9yn%2BbMpjSIW%0Afsgtq4FsyqzPueEkDdQWi3xh6nu2WI%2F1Tl875opGAqEIJMqss%2Fu11tnva5wzu1cC%0AL6H85A5%2BHMOBvP3sm6CObKcVw92h7kxynVIUJJWhjfeZMN8gBFFpKIVFAoGBAO1p%0AtXBmXLC%2FYKKvtHI3M16%2FZopvM8ZqU2HcAHaw214Refw9JJ%2Fe3%2FxTNfSerVTyCAQO%0A1AdWTzJKBN8jmSYv1Mk1D3RpQPNR7wVzi46KR081AU41uMpqIGVOwHtyVnW%2FZfLr%0Ac1DLIK8Cx8aHfoxffwzoMO5SEQSooeZfOLhsfDN1AoGBAKQTUEINsj%2B75psgbAr6%0AELGgItJ9yPBLVRr%2BcUzEpx9LDWVvjMihpP4NX1gq8EOPWT%2BewLHVmmsjCyV6xw8J%0AXXF8e2xif3in0m3D%2FwCzE7u2T06rKM3B017hKnrZmGoHnrqPU2osM4sOUpshWX6d%0Av1Q4EF1%2BfbK3YCW%2BVpCBsB9NAoGAQo%2BuhNLODee56iKkzpjXWCsFTq6ar3hD5F3P%0A63buKdNwhd2GlSPhXFbf%2B7M5GWW6BZk6rMvv7EOAVice2uvyFm8%2F4%2F1WbmF8R%2BT7%0ALX1rPLO5p%2Fm701QpvP11TabiwqRkqtSEQhSRF0AKTojSW%2FyyHCZFAawUhV%2FZ9EKi%0AHmKb97kCgYAyzmFc2it0HqnsOnRybop603nqMtWGTQO4cxa93HUDpYajuK2K3Dfr%0AxUj6lG3z%2FoKJGGE2JqgZ6LBAhNJtJWJu2ox3pKGE63QjLJnVwb8y1NFYpe%2FcrbLe%0APuBwIR0L7drXxfv7O5btY7h6QI2d1%2FUIAQPAWbxLoTM%2BndQ%2FuPEdfA%3D%3D%0A-----END%20RSA%20PRIVATE%20KEY-----'</span></pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii39ca:1" aria-labelledby="tab:Rii39ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii39ca:2" aria-labelledby="tab:Rii39ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii39ca:3" aria-labelledby="tab:Rii39ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rji39ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rji39ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rji39ca:0" aria-labelledby="tab:Rji39ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;install_ssl&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"action"</span>: <span class="token string">&quot;update&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cert_id"</span>: <span class="token string">&quot;example_com_bbe7e_16e2d_1369007999_1d87a0cdb540f5aae607b10e9a1a82fb&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"extra_certificate_domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;ssl.example.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"html"</span>: <span class="token string">&quot;The SSL certificate is now installed onto the domain \&quot;example.com\&quot; using the IP address \&quot;192.168.0.1\&quot;.\nThe existing virtual host was updated with the new certificate. Apache is restarting in the background.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ip"</span>: <span class="token string">&quot;192.168.0.1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_id"</span>: <span class="token string">&quot;bbe7e_16e2d_df7539f280eb1ecf6c1096190e41ada7&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">&quot;The SSL certificate is now installed onto the domain \&quot;example.com\&quot; using the IP address \&quot;192.168.0.1\&quot;.\nThe existing virtual host was updated with the new certificate.\nApache is restarting in the background.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"statusmsg"</span>: <span class="token string">&quot;The SSL certificate is now installed onto the domain \&quot;example.com\&quot; using the IP address \&quot;192.168.0.1\&quot;.\nThe existing virtual host was updated with the new certificate.\nApache is restarting in the background.\nThe SSL certificate is now installed onto the domain \&quot;example.com\&quot; using the IP address \&quot;192.168.0.1\&quot;.\nThe existing virtual host was updated with the new certificate.\nApache is restarting in the background&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user"</span>: <span class="token string">&quot;example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warning_domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;warning.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"working_domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/SSL-Certificate-Management/operation/delete_csr" data-section-id="tag/SSL-Certificate-Management/operation/delete_csr" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete_csr" id="operation/delete_csr" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSL-Certificate-Management/operation/delete_csr" aria-label="tag/SSL-Certificate-Management/operation/delete_csr"></a>Delete certificate signing request </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function deletes a certificate signing request (CSR).&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;When you call this function, you &lt;strong&gt;must&lt;/strong&gt; include the &lt;code&gt;id&lt;/code&gt; or the &lt;code&gt;friendly_name&lt;/code&gt;
parameter.&lt;/li&gt;
&lt;li&gt;To delete a private key, use the UAPI &lt;code&gt;SSL::delete_key&lt;/code&gt; function instead.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail,
and Web Server &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;roles&lt;/a&gt;,
the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes a certificate signing request (CSR).</p>
<p><strong>Note:</strong></p>
<ul>
<li>When you call this function, you <strong>must</strong> include the <code>id</code> or the <code>friendly_name</code>
parameter.</li>
<li>To delete a private key, use the UAPI <code>SSL::delete_key</code> function instead.</li>
</ul>
<p><strong>Important:</strong></p>
<p>When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail,
and Web Server <a href="https://go.cpanel.net/howtouseserverprofiles#roles">roles</a>,
the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="friendly_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">friendly_name</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">friendly_name=TestCSR</span></div><div><div html="&lt;p&gt;The CSR&amp;#39;s friendly name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The CSR&#39;s friendly name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">id</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">id=example_com_e095f_0ab2f_ebcbe4a571276f48562241411556647f</span></div><div><div html="&lt;p&gt;The CSR&amp;#39;s ID.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The CSR&#39;s ID.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/delete_csr</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/delete_csr</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rii59ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rii59ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rii59ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii59ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rii59ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii59ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rii59ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii59ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rii59ca:0" aria-labelledby="tab:Rii59ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  delete_csr
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii59ca:1" aria-labelledby="tab:Rii59ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii59ca:2" aria-labelledby="tab:Rii59ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii59ca:3" aria-labelledby="tab:Rii59ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rji59ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rji59ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rji59ca:0" aria-labelledby="tab:Rji59ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;delete_csr&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"commonName"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token number">1538308800</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_curve_name"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_public"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"friendly_name"</span>: <span class="token string">&quot;TestCSR&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;example_com_e095f_0ab2f_ebcbe4a571276f48562241411556647f&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">&quot;rsaEncryption&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">&quot;a74f7636fa6ac93ee6836a83a995b55deb5019ea36d7ba3dafb00e38d693acd\nb0c81b2ff777d6b433a420fae523f127f352a68bcc8b8f2d6ee7b70395bafab\nd8237ada8164fdddf8376b30375c35d4d4cbcce7d33d08069c17b409176a368\n9f1ebc97c0b08fe6ae44c19a92ac6d68448e7f1d13f3b360affd4222a51b4f3\n5342de99b5a1fb5548e438f2d824664562a448002eed7fce24dedc7dc3e1ed1\n79973d1dae959b33716eeb410d172708954e00632cbf60a0e26419860c8c0bc\n285d6bfe4b479de0dd189772a5dae676bd2a92acccc1369821be8cffddd8a7e\n6ecc061f8a32a9ae0661e4e946ed8e3827b277138d3a76116567cbd129cbd86\n9ef9dddf&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/SSL-Certificate-Management/operation/delete_key" data-section-id="tag/SSL-Certificate-Management/operation/delete_key" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete_key" id="operation/delete_key" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSL-Certificate-Management/operation/delete_key" aria-label="tag/SSL-Certificate-Management/operation/delete_key"></a>Delete private key </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function deletes a private key.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;When you call this function, you &lt;strong&gt;must&lt;/strong&gt; include the &lt;code&gt;id&lt;/code&gt; or the &lt;code&gt;friendly_name&lt;/code&gt;
parameter.&lt;/li&gt;
&lt;li&gt;To delete a certificate signing request (CSR), use the UAPI &lt;code&gt;SSL::delete_csr&lt;/code&gt;
function instead.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail,
and Web Server &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;roles&lt;/a&gt;,
the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes a private key.</p>
<p><strong>Note:</strong></p>
<ul>
<li>When you call this function, you <strong>must</strong> include the <code>id</code> or the <code>friendly_name</code>
parameter.</li>
<li>To delete a certificate signing request (CSR), use the UAPI <code>SSL::delete_csr</code>
function instead.</li>
</ul>
<p><strong>Important:</strong></p>
<p>When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail,
and Web Server <a href="https://go.cpanel.net/howtouseserverprofiles#roles">roles</a>,
the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="friendly_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">friendly_name</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">friendly_name=TestKey</span></div><div><div html="&lt;p&gt;The private key&amp;#39;s friendly name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The private key&#39;s friendly name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">id</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">id=example_com_e095f_0ab2f_ebcbe4a571276f48562241411556647f</span></div><div><div html="&lt;p&gt;The private key&amp;#39;s ID.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The private key&#39;s ID.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/delete_key</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/delete_key</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rii79ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rii79ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rii79ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii79ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rii79ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii79ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rii79ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii79ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rii79ca:0" aria-labelledby="tab:Rii79ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  delete_key
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii79ca:1" aria-labelledby="tab:Rii79ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii79ca:2" aria-labelledby="tab:Rii79ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii79ca:3" aria-labelledby="tab:Rii79ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rji79ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rji79ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rji79ca:0" aria-labelledby="tab:Rji79ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;delete_key&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token number">1538308800</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_curve_name"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_public"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"friendly_name"</span>: <span class="token string">&quot;TestKey&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">&quot;rsaEncryption&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">&quot;a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus_length"</span>: <span class="token number">2048</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/SSL-Certificate-Management/operation/delete_cert" data-section-id="tag/SSL-Certificate-Management/operation/delete_cert" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete_cert" id="operation/delete_cert" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSL-Certificate-Management/operation/delete_cert" aria-label="tag/SSL-Certificate-Management/operation/delete_cert"></a>Delete SSL certificate </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function deletes an SSL certificate.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;When you call this function, you &lt;strong&gt;must&lt;/strong&gt; include the &lt;code&gt;id&lt;/code&gt; or the &lt;code&gt;friendly_name&lt;/code&gt;
parameter.&lt;/li&gt;
&lt;li&gt;This function &lt;strong&gt;only&lt;/strong&gt; deletes certificates from SSL storage. To end SSL
coverage for a domain, use the UAPI &lt;code&gt;SSL::delete_ssl&lt;/code&gt; function instead.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail,
and Web Server &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;roles&lt;/a&gt;,
the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes an SSL certificate.</p>
<p><strong>Note:</strong></p>
<ul>
<li>When you call this function, you <strong>must</strong> include the <code>id</code> or the <code>friendly_name</code>
parameter.</li>
<li>This function <strong>only</strong> deletes certificates from SSL storage. To end SSL
coverage for a domain, use the UAPI <code>SSL::delete_ssl</code> function instead.</li>
</ul>
<p><strong>Important:</strong></p>
<p>When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail,
and Web Server <a href="https://go.cpanel.net/howtouseserverprofiles#roles">roles</a>,
the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="friendly_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">friendly_name</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">friendly_name=TestCert</span></div><div><div html="&lt;p&gt;The certificate&amp;#39;s friendly name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate&#39;s friendly name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">id</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">id=example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3</span></div><div><div html="&lt;p&gt;The certificate&amp;#39;s ID.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate&#39;s ID.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/delete_cert</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/delete_cert</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rii99ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rii99ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rii99ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii99ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rii99ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii99ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rii99ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rii99ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rii99ca:0" aria-labelledby="tab:Rii99ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  delete_cert
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii99ca:1" aria-labelledby="tab:Rii99ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii99ca:2" aria-labelledby="tab:Rii99ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rii99ca:3" aria-labelledby="tab:Rii99ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rji99ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rji99ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rji99ca:0" aria-labelledby="tab:Rji99ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;delete_cert&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token number">1538308800</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_curve_name"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_public"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"friendly_name"</span>: <span class="token string">&quot;TestCert&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_self_signed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer.commonName"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer.organizationName"</span>: <span class="token string">&quot;Organization&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer_text"</span>: <span class="token string">&quot;countryName\nUS\nstateOrProvinceName\nTX\nlocalityName\nHouston\norganizationName\nOrganization\ncommonName\nexample.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">&quot;rsaEncryption&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">&quot;a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus_length"</span>: <span class="token number">2048</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"not_after"</span>: <span class="token number">1569844800</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"not_before"</span>: <span class="token number">1538308800</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"serial"</span>: <span class="token string">&quot;45462cd0d6537b20cf2f3eb8aec07140&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"signature_algorithm"</span>: <span class="token string">&quot;sha256WithRSAEncryption&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject.commonName"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject_text"</span>: <span class="token string">&quot;commonName\nwww.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"validation_type"</span>: <span class="token string">&quot;dv&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/SSL-Certificate-Management/operation/generate_cert" data-section-id="tag/SSL-Certificate-Management/operation/generate_cert" class="sc-dntaoT ceciOs"><div data-section-id="operation/generate_cert" id="operation/generate_cert" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSL-Certificate-Management/operation/generate_cert" aria-label="tag/SSL-Certificate-Management/operation/generate_cert"></a>Create self-signed SSL certificate </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function generates a self-signed SSL certificate.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail,
and Web Server &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;roles&lt;/a&gt;,
the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function generates a self-signed SSL certificate.</p>
<p><strong>Important:</strong></p>
<p>When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail,
and Web Server <a href="https://go.cpanel.net/howtouseserverprofiles#roles">roles</a>,
the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="countryName" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">countryName</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;ISO-3166-1 (alpha-2)&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">countryName=US</span></div><div><div html="&lt;p&gt;The two-letter country code.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The two-letter country code.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="domains" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domains</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domains=domains=example1.com,example2.com,example3.com</span> - Generate certificates for multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domains=example.com</span> - Generate a certificate for a domain.</li></ul><div><div html="&lt;p&gt;A comma-separated list of domains for which to generate the certificate.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A comma-separated list of domains for which to generate the certificate.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="emailAddress" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">emailAddress</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;&quot;</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">emailAddress=username@example.com</span></div><div><div html="&lt;p&gt;An email address to associate with the certificate.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An email address to associate with the certificate.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="friendly_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">friendly_name</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">friendly_name=TestCert</span></div><div><div html="&lt;p&gt;A friendly name for the new certificate.&lt;/p&gt;
&lt;p&gt;This parameter defaults to the domain&amp;#39;s name for which you generated the
certificate.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A friendly name for the new certificate.</p>
<p>This parameter defaults to the domain&#39;s name for which you generated the
certificate.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="key_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">key_id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key_id=example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3</span></div><div><div html="&lt;p&gt;The key&amp;#39;s ID.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key&#39;s ID.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="localityName" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">localityName</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">localityName=Houston</span></div><div><div html="&lt;p&gt;The certificate&amp;#39;s city or locality name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate&#39;s city or locality name.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="organizationalUnitName" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">organizationalUnitName</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;&quot;</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">organizationalUnitName=Department</span></div><div><div html="&lt;p&gt;The certificate&amp;#39;s organizational unit or department name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate&#39;s organizational unit or department name.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="organizationName" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">organizationName</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">organizationName=Organization</span></div><div><div html="&lt;p&gt;The certificate&amp;#39;s Organization Name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate&#39;s Organization Name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="stateOrProvinceName" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">stateOrProvinceName</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">stateOrProvinceName=TX</span></div><div><div html="&lt;p&gt;The two-letter state or locality abbreviation.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The two-letter state or locality abbreviation.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/generate_cert</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/generate_cert</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riib9ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riib9ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riib9ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riib9ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riib9ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riib9ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riib9ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riib9ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riib9ca:0" aria-labelledby="tab:Riib9ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  generate_cert <span class="token punctuation">\</span>
  <span class="token assign-left variable">domains</span><span class="token operator">=</span><span class="token string">'example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">countryName</span><span class="token operator">=</span><span class="token string">'US'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">stateOrProvinceName</span><span class="token operator">=</span><span class="token string">'TX'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">localityName</span><span class="token operator">=</span><span class="token string">'Houston'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">organizationName</span><span class="token operator">=</span><span class="token string">'Organization'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">key_id</span><span class="token operator">=</span><span class="token string">'example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riib9ca:1" aria-labelledby="tab:Riib9ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riib9ca:2" aria-labelledby="tab:Riib9ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riib9ca:3" aria-labelledby="tab:Riib9ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjib9ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjib9ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjib9ca:0" aria-labelledby="tab:Rjib9ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;generate_cert&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token number">1538308800</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_curve_name"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_public"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"friendly_name"</span>: <span class="token string">&quot;TestCert&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;example_com_a74f7_9dddf_1446659822_eae1ff43c4ec1991e195877c55755eff&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_self_signed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer.commonName"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer.organizationName"</span>: <span class="token string">&quot;Organization&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">&quot;rsaEncryption&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">&quot;a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus_length"</span>: <span class="token number">2048</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"not_after"</span>: <span class="token number">1569844800</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"not_before"</span>: <span class="token number">1538308800</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"serial"</span>: <span class="token string">&quot;01e57e4d92&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"signature_algorithm"</span>: <span class="token string">&quot;sha256WithRSAEncryption&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject.commonName"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"text"</span>: <span class="token string">&quot;-----BEGIN CERTIFICATE-----\nMIIGBzCCA++gAwIBAgIFAeV+TZIwDQYJKoZIhvcNAQELBQAwUjELMAkGA1UECAwC\nVFgxEDAOBgNVBAcMB0hvdXN0b24xCzAJBgNVBAYTAlVTMRMwEQYDVQQDDAptcmZy\nb2cuY29tMQ8wDQYDVQQKDAZjUGFuZWwwHhcNMjAwNjA4MTUyNjA0WhcNMjEwNjA4\nMTUyNjA0WjBSMQswCQYDVQQIDAJUWDEQMA4GA1UEBwwHSG91c3RvbjELMAkGA1UE\nBhMCVVMxEzARBgNVBAMMCm1yZnJvZy5jb20xDzANBgNVBAoMBmNQYW5lbDCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAK/PpzRsms2ZZmA1EG2rNYZaAq2z\nbhUGN6YMpugDwPL9xuqDwf0WUdoBjSBbty7rb5zMCZ+Ty3xHFAo15TLQXqtM0zIo\nh/FRET9rtl6EuXFFFN+eAiV4GgZJVmVMmcgXNGgSjKZHhie5THkGJbwXXRxZryHN\nQIeLlT7DttSwoAh9rEbk6hHKyyoQQ4rSkNXREUZTN3Gk7u7et8iYWl1FBkmJkFDJ\nH4Ys678md7AiXndb4YkOQd2CEgoWXMaMLWJcFkdAmrIYhRmJvyp3BzF9hEkg+qPp\nVEyIL/xVxScdxiFKGWbiHr10UiFt/0+g0gToyUXCmsfo01p0oqrk4qRSZMnUtfdX\nW06vvD64x4Z4M4Jh5WqzVEXEdppzJx09Z7MBK6GLN82pV46x8jp87cBL1LZrpWDinerx+6Vr7YC62itfp6aJ2q6vkxCh4u8T6EjPEcpZAEh5SiQZaOLhAlqgt/lwPpuCW\nQ7LEi/Vg4aG3yb/z8e2BvRK5nnCHd7OOZqg7HJ9UnrzFxeQ8KyvcxP+oYD3h0EvZ\n1zVTbJDLbYuohqbLts3Skuk1hT9HoeWqrmzn2XkoU8LkvzCcRT0oG40BfFr4z7Zz\nsKfG9Z4e06kb1YAPrSqd9w/iI1Ej8cRhBBlowYFq9RjNlkjJCwKlxzynNAJjoQ5W\nU5NJzKjUz6ChHAAtAgMBAAGjgeMwgeAwHQYDVR0OBBYEFFczMNVfcxDsyk27GfjD\nC0Z1Yv+mMAkGA1UdEwQCMAAwfgYDVR0jBHcwdYAUVzMw1V9zEOzKTbsZ+MMLRnVi\n/6ahVqRUMFIxCzAJBgNVBAgMAlRYMRAwDgYDVQQHDAdIb3VzdG9uMQswCQYDVQQG\nEwJVUzETMBEGA1UEAwwKbXJmcm9nLmNvbTEPMA0GA1UECgwGY1BhbmVsggUB5X5N\nkjAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwFQYDVR0RBA4wDIIKbXJm\ncm9nLmNvbTANBgkqhkiG9w0BAQsFAAOCAgEArbNqSdABFWy8NbpDGDAoi2rpw/aM\nWu18iEAHmPg9YekIngNpxZg4b8SB4jrNSSqB0pK8asckxmAcho/pnAx4rOFibftd\nDmGzYxGN9h60JkVToWSn3UQ/0dbqfhfTbGiQvJHTNqB3pQVvWenMFRz9XEcpMDUj\n7UKR8v2xe5Y25yvNPVezYF2/x85awlOoSa00UlKgqh0OU+iuzQZ9T3wtk5uvlc7Z\nIEzBseIn3Kp/WG3P64Rxn95YT6QssKJ+pZ412yKM7vKdcuglNLTv5cx4ffKFN1jm\nanCmPXgYsUdAazmZVSjVuVN7d2+NL+SDVczZCdJ2Vhk5DPqv8ZnHUF7MT+K6vtQd\nJ16+pszCF55t9w5uPqur67/R00dCWLpxvHRRF8J+2Xverhmex5kR6a1nUlbP1oOP\nVq+EmcAL0PP6qdDr8fkjgvNyX7hT+cuiPBbxpY6XfDSlat5+5T2lJ1Ny6GWhBnaR\n35g3EF8ysu3AYQnDwtZrOrEa08lDN3mbrkT3ImSa5oZKgOrlpCZ0dzi8p4wSrboq\n9eZyqikEvuudz+VeQf1WR/6/FsyRq2PEtjgX1atWZiPfatN5f1YVxcElTvuMzyOP\nZXjpUs8MO+CHF1FwtKm52NNItIlnUY7KPpFU8L+oa8O2BMr91wi8NpTR2gd0F+jH\n21NkfEM7YlXzgMw=\n-----END CERTIFICATE-----\n&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"validation_type"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;Certificate generated&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/SSL-Certificate-Management/operation/SSL-generate_key" data-section-id="tag/SSL-Certificate-Management/operation/SSL-generate_key" class="sc-dntaoT ceciOs"><div data-section-id="operation/SSL-generate_key" id="operation/SSL-generate_key" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSL-Certificate-Management/operation/SSL-generate_key" aria-label="tag/SSL-Certificate-Management/operation/SSL-generate_key"></a>Create private key </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function generates a private key.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;You &lt;strong&gt;cannot&lt;/strong&gt; call both the &lt;code&gt;keytype&lt;/code&gt; and &lt;code&gt;keysize&lt;/code&gt; parameters in a single call.&lt;/li&gt;
&lt;li&gt;When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, &lt;strong&gt;and&lt;/strong&gt;
Web Server &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;roles&lt;/a&gt;,
the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function generates a private key.</p>
<p><strong>Important:</strong></p>
<ul>
<li>You <strong>cannot</strong> call both the <code>keytype</code> and <code>keysize</code> parameters in a single call.</li>
<li>When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, <strong>and</strong>
Web Server <a href="https://go.cpanel.net/howtouseserverprofiles#roles">roles</a>,
the system <strong>disables</strong> this function.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="friendly_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">friendly_name</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">friendly_name=TestKey</span></div><div><div html="&lt;p&gt;A friendly name for the new key.&lt;/p&gt;
&lt;p&gt;This parameter defaults to the key&amp;#39;s type, creation date, and creation time.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A friendly name for the new key.</p>
<p>This parameter defaults to the key&#39;s type, creation date, and creation time.</p>
</div></div></div></td></tr><tr class=""><td class="sc-ovuCP sc-eauhAA dEkioI iQpMVv deprecated" kind="field" title="keysize"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">keysize</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span type="warning" class="sc-jtQUzJ jmDXKf"> Deprecated </span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">2048</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">keysize=2048</span></div><div><div html="&lt;p&gt;The key&amp;#39;s modulus size.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;Use the &lt;code&gt;keytype&lt;/code&gt; parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key&#39;s modulus size.</p>
<p><strong>Note:</strong></p>
<p>Use the <code>keytype</code> parameter.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="keytype" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">keytype</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;system&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;rsa-2048&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;rsa-4096&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;ecdsa-prime256v1&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;ecdsa-secp384r1&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">keytype=rsa-2048</span></div><div><div html="&lt;p&gt;The key&amp;#39;s type.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;system&lt;/code&gt; — The system&amp;#39;s default value.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;rsa-2048&lt;/code&gt; — 2,408-bit RSA.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;rsa-4096&lt;/code&gt; — 4,096-bit RSA.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;ecdsa-prime256v1&lt;/code&gt; — ECDSA prime256v1 (&amp;quot;P-256&amp;quot;).&lt;/li&gt;
&lt;li&gt;&lt;code&gt;ecdsa-secp384r1&lt;/code&gt; — ECDSA secp384r1 (&amp;quot;P-384&amp;quot;).&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;This parameter defaults to the user&amp;#39;s
&lt;a href=&quot;https://go.cpanel.net/cpaneldocsSSLTLS#default-ssl-tls-key-type&quot;&gt;default SSL/TLS key type&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If you do &lt;strong&gt;not&lt;/strong&gt; use this parameter, the system defaults to the &lt;code&gt;keysize&lt;/code&gt; parameter&amp;#39;s default value.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key&#39;s type.</p>
<ul>
<li><code>system</code> — The system&#39;s default value.</li>
<li><code>rsa-2048</code> — 2,408-bit RSA.</li>
<li><code>rsa-4096</code> — 4,096-bit RSA.</li>
<li><code>ecdsa-prime256v1</code> — ECDSA prime256v1 (&quot;P-256&quot;).</li>
<li><code>ecdsa-secp384r1</code> — ECDSA secp384r1 (&quot;P-384&quot;).</li>
</ul>
<p>This parameter defaults to the user&#39;s
<a href="https://go.cpanel.net/cpaneldocsSSLTLS#default-ssl-tls-key-type">default SSL/TLS key type</a>.</p>
<p><strong>Note:</strong></p>
<p>If you do <strong>not</strong> use this parameter, the system defaults to the <code>keysize</code> parameter&#39;s default value.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/generate_key</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/generate_key</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riid9ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riid9ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riid9ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riid9ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riid9ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riid9ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riid9ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riid9ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riid9ca:0" aria-labelledby="tab:Riid9ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  generate_key
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riid9ca:1" aria-labelledby="tab:Riid9ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riid9ca:2" aria-labelledby="tab:Riid9ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riid9ca:3" aria-labelledby="tab:Riid9ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjid9ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjid9ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjid9ca:0" aria-labelledby="tab:Rjid9ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;generate_key&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token number">1601467200</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_curve_name"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_public"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"friendly_name"</span>: <span class="token string">&quot;TestKey&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;example_com_a74f7_9dddf_1446659822_eae1ff43c4ec1991e195877c55755eff&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">&quot;rsaEncryption&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">&quot;a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus_length"</span>: <span class="token number">2048</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"text"</span>: <span class="token string">&quot;-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAyeiHvMuJuVk8ZEY6wMzUS1g0eWaHaIWmIRe+Qrn6SwiRrm1p\npsJCiGPPPQGOSg4FzrMXqE0zsi/Tk3hUO/EEsi7CcZe8cUanjlUeXhiwrb86FCMF\nOb9siRHQvlss7VCg8ZGXXTWZgf5yD3A1xPwdayYwF2Tc7GkNcZGUAI58geuYaq+U\nGiLczRGZep1IQ0b1cZnqDvGMx6AS6hiDqLISjnmXYY2OhG6Uyp+SuinjYzLPJ6eO\nN/7i9qqbcGmt0ssddmhR897+bTEom5SlSuyi03KZ9Rn4ZmNJgOsup9MclSBGxBys\nb6MuuM3N0/tF5QuwmDc8H6h2rNBP9vGV7RTTXQIDAQABAoIBAFS/WVoRRLmbjxG3\nuKl8UA9f8oaSVnu0vUpeoOl5Dmm4Kw2/tvzbxPlii3Xb1VGYGS/tVBy8atp74J6h\nfxm5zHLN1afAPMR/F41ShPCSBHapMUOKf4MBqhjOdYOw2Way1RsQNSxWdxxtJIr+\nWlNYTzDOUpk/KMvCPHZS2IBzTidpcFpDQ3pyDXjOoKJJH0EQWPtvxJNGrFqmU29D\n9WBqQemHnDrzg3s7JzQ5cGpbbCE+QX8IckNkslAkyhm771CtqWdeo+c45e6YfGcx\nKuAy1zGSVzQBuitzYoMUOL5olXLEj8fHzXd/cZP4yCyyabcGz2vi6luxF+28l1OL\nG1axyLECgYEA+bD5B+Y/Dp5hZ/uVR1bbvyraQpwbDesS1zgnJ53KOIl926dnWzIt\nUvM46+c9IF+UJrtzwIB6IvjAQioNFrK36bHgNGzNf9WQ54NN172qveaFLdW34z/i\nGR2ix/efm9OC41QREQ/5IKV07TibCwVazVBWascMPkH7FnguTvTCiosCgYEAzwJ+\nGPlIWjK+sqkK5JMUyuH43qAvgVfkZV906JpNRQH0Mob3bC0nXN95EoTwWXk68ULT\no1GHv9XLbj8e+Ok7kpJQZT5vEZnDN+cy3jdTLCvcjU5Q3ToImOTp9isSAFWRTbtk\nyabLNoIIsTR/ZwwPFTZcRiK2d8k7ZhcRKdfGnrcCgYAPZ06FoTukoDqsGoYkB4S4\n72DVmSHGIwlfg5ROylouULUV9ubWZmsLYfvR+cr4k0zlcsz6RDLEs4nQyx1RmCbm\nYNXPBiNLTpaI4b3MoGPHIVB3+mZEu60sFXr0UR9kkpDRi18eKVkaHXrwI3zVGjh2\n0Az0u2DS+mkOAs4AivLxbwKBgQC0XPqbLc+Bb0dCCREJmLD8GCkrZ6wcaQUB4krN\nQ2vhnVM0Fu5K3Yi3XapynUuA2aSmgtA9MxMw7MkjlHGa9DPIgBz2KZDCaBN0iMeE\nX/XivZCbucmxBxhohsLmjh5QFj3U2Vp2bBIQuvlx1EjQ8uvNUqDRJvuOoNFVIPH+\nYBeZPwKBgA//kXfNtNMHOpch699i3rgTzbRFDmGwsr1otzvJsXw7Pr2bM4WIzUJy\nG2SUSUlQRSZK4+BBKT9S0d7TynJD6X/6R7IBotZbfXs1myYxEsKj89/BQmr47x2h\nHjYVCClNoJlsbd5C2yu1R3PikweWGoVaxE3c+AN5knqjwJ0g21Cf\n-----END RSA PRIVATE KEY-----&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/SSL-Certificate-Management/operation/generate_csr" data-section-id="tag/SSL-Certificate-Management/operation/generate_csr" class="sc-dntaoT ceciOs"><div data-section-id="operation/generate_csr" id="operation/generate_csr" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSL-Certificate-Management/operation/generate_csr" aria-label="tag/SSL-Certificate-Management/operation/generate_csr"></a>Create certificate signing request </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function generates a certificate signing request (CSR).&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This function &lt;strong&gt;requires&lt;/strong&gt; a valid key in the account&amp;#39;s &lt;code&gt;ssl&lt;/code&gt; directory.
You can generate a key with UAPI&amp;#39;s &lt;code&gt;SSL::generate_key&lt;/code&gt; function.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail,
and WebServer &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;roles&lt;/a&gt;,
the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function generates a certificate signing request (CSR).</p>
<p><strong>Note:</strong></p>
<p>This function <strong>requires</strong> a valid key in the account&#39;s <code>ssl</code> directory.
You can generate a key with UAPI&#39;s <code>SSL::generate_key</code> function.</p>
<p><strong>Important:</strong></p>
<p>When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail,
and WebServer <a href="https://go.cpanel.net/howtouseserverprofiles#roles">roles</a>,
the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="countryName" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">countryName</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;ISO-3166-1 (alpha-2)&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">countryName=US</span></div><div><div html="&lt;p&gt;The two-letter country code.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The two-letter country code.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="domains" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domains</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domains=domains=example-1.com,example-1.com,example-2.com</span> - Generate a certificate for multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domains=example.com</span> - Generate a certificate for a single domain.</li></ul><div><div html="&lt;p&gt;A comma-separated list of the domains for which to generate the certificate.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A comma-separated list of the domains for which to generate the certificate.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="emailAddress" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">emailAddress</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;email&gt; </span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;&quot;</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">emailAddress=username@example.com</span></div><div><div html="&lt;p&gt;An email address to associate with the certificate.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An email address to associate with the certificate.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="friendly_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">friendly_name</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">friendly_name=TestCert</span></div><div><div html="&lt;p&gt;A friendly name for the new certificate.&lt;/p&gt;
&lt;p&gt;This parameter defaults to the domain name for which you generated the
certificate.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A friendly name for the new certificate.</p>
<p>This parameter defaults to the domain name for which you generated the
certificate.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="key_id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">key_id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key_id=example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3</span></div><div><div html="&lt;p&gt;The key&amp;#39;s ID.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key&#39;s ID.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="localityName" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">localityName</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">localityName=Houston</span></div><div><div html="&lt;p&gt;The certificate&amp;#39;s city or locality name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate&#39;s city or locality name.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="organizationalUnitName" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">organizationalUnitName</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;&quot;</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">organizationalUnitName=Department</span></div><div><div html="&lt;p&gt;The certificate&amp;#39;s organizational unit or department name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate&#39;s organizational unit or department name.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="organizationName" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">organizationName</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">organizationName=Organization</span></div><div><div html="&lt;p&gt;The certificate&amp;#39;s organization.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate&#39;s organization.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="stateOrProvinceName" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">stateOrProvinceName</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">stateOrProvinceName=Texas</span></div><div><div html="&lt;p&gt;The certificate&amp;#39;s state or locality name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate&#39;s state or locality name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/generate_csr</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/generate_csr</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riif9ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riif9ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riif9ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riif9ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riif9ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riif9ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riif9ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riif9ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riif9ca:0" aria-labelledby="tab:Riif9ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  generate_csr <span class="token punctuation">\</span>
  <span class="token assign-left variable">domains</span><span class="token operator">=</span><span class="token string">'example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">countryName</span><span class="token operator">=</span><span class="token string">'US'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">stateOrProvinceName</span><span class="token operator">=</span><span class="token string">'Texas'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">localityName</span><span class="token operator">=</span><span class="token string">'Houston'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">organizationName</span><span class="token operator">=</span><span class="token string">'Organization'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">key_id</span><span class="token operator">=</span><span class="token string">'example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riif9ca:1" aria-labelledby="tab:Riif9ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riif9ca:2" aria-labelledby="tab:Riif9ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riif9ca:3" aria-labelledby="tab:Riif9ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjif9ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjif9ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjif9ca:0" aria-labelledby="tab:Rjif9ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;generate_csr&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"commonName"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token number">1569884400</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_curve_name"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_public"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"friendly_name"</span>: <span class="token string">&quot;TestCSR&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;example_com_a74f7_9dddf_1446659822_eae1ff43c4ec1991e195877c55755eff&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">&quot;rsaEncryption&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">&quot;a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"text"</span>: <span class="token string">&quot;-----BEGIN CERTIFICATE REQUEST-----\nMIIC3TCCAcUCAQAwgZcxFDASBgNVBAMMC2V4YW1wbGUuY29tMRYwFAYDVQQLDA1E\nb2N1bWVudGF0aW9uMQswCQYDVQQGEwJVUzEiMCAGCSqGSIb3DQEJARYTbGF1cmVu\nY2VAY3BhbmVsLm5ldDEUMBIGA1UECgwLY1BhbmVsIEluYy4xDjAMBgNVBAgMBVRl\neGFzMRAwDgYDVQQHDAdIb3VzdG9uMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAp092NvpqyT7mg2qDqZW1XetQGeo217o9r7AOONaTrNsMgbL/d31rQzpC\nD65SPxJ/NSpovMi48tbue3A5W6+r2CN62oFk/d34N2swN1w11NTLzOfTPQgGnBe0\nCRdqNonx68l8Cwj+auRMGakqxtaESOfx0T87Ngr/1CIqUbTzU0LembWh+1VI5Djy\n2CRmRWKkSAAu7X/OJN7cfcPh7ReZc9Ha6VmzNxbutBDRcnCJVOAGMsv2Cg4mQZhg\nyMC8KF1r/ktHneDdGJdypdrmdr0qkqzMwTaYIb6M/93Yp+bswGH4oyqa4GYeTpRu\n2OOCeydxONOnYRZWfL0SnL2Gnvnd3wIDAQABoAAwDQYJKoZIhvcNAQEFBQADggEB\nAFlolzJbcviWcdZUv+PJ7G8cAqFAxa8a3W2a0Y1U0BaMrpDfuOHpQgOtO62rr+i+\nhkrIReuk7Isyl6GoZkX17KhQ1Vo9aW8a8Ur7+0RGDbxRlK9jJWnvSFn6cMMqRSfA\nDXpptxhqBFZJIZMc3pPX9Jqycuu8bxeIvUKeSMe3Jxcl1ZXEXX47FeRZxvd+WXF9\n4Xu4KZXHdzb5tB6jPhzIaN0/3d92N/KhvCcnw3YC2fEGDkpOlZaoa7O72+aq5K3b\nM1htFv9deAHqIHefV41iOrxUCIKIhdPIjvAm774lDHLzPpJVrshO/NpA74LEkny5\nFMwKKx+6Jgx1HSWucn5kWek=\n-----END CERTIFICATE REQUEST-----&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;Certificate Signing Request generated!&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/SSL-Certificate-Management/operation/set_cert_friendly_name" data-section-id="tag/SSL-Certificate-Management/operation/set_cert_friendly_name" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_cert_friendly_name" id="operation/set_cert_friendly_name" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSL-Certificate-Management/operation/set_cert_friendly_name" aria-label="tag/SSL-Certificate-Management/operation/set_cert_friendly_name"></a>Update SSL certificate&#x27;s friendly name </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function changes a certificate&amp;#39;s friendly name.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function changes a certificate&#39;s friendly name.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="friendly_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">friendly_name</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">friendly_name=TestCert</span></div><div><div html="&lt;p&gt;The certificate&amp;#39;s friendly name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate&#39;s friendly name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="new_friendly_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">new_friendly_name</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">new_friendly_name=TestCert2</span></div><div><div html="&lt;p&gt;The certificate&amp;#39;s new friendly name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate&#39;s new friendly name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/set_cert_friendly_name</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/set_cert_friendly_name</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riih9ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riih9ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riih9ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riih9ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riih9ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riih9ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riih9ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riih9ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riih9ca:0" aria-labelledby="tab:Riih9ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  set_cert_friendly_name <span class="token punctuation">\</span>
  <span class="token assign-left variable">friendly_name</span><span class="token operator">=</span><span class="token string">'TestCert'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">new_friendly_name</span><span class="token operator">=</span><span class="token string">'TestCert2'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riih9ca:1" aria-labelledby="tab:Riih9ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riih9ca:2" aria-labelledby="tab:Riih9ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riih9ca:3" aria-labelledby="tab:Riih9ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjih9ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjih9ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjih9ca:0" aria-labelledby="tab:Rjih9ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_cert_friendly_name&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/SSL-Certificate-Management/operation/set_csr_friendly_name" data-section-id="tag/SSL-Certificate-Management/operation/set_csr_friendly_name" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_csr_friendly_name" id="operation/set_csr_friendly_name" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSL-Certificate-Management/operation/set_csr_friendly_name" aria-label="tag/SSL-Certificate-Management/operation/set_csr_friendly_name"></a>Update certificate signing request&#x27;s friendly name </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function changes a certificate signing request&amp;#39;s (CSR) friendly name.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;You &lt;strong&gt;must&lt;/strong&gt; call either the &lt;code&gt;friendly_name&lt;/code&gt; or &lt;code&gt;id&lt;/code&gt; parameter.&lt;/li&gt;
&lt;li&gt;When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;roles&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function changes a certificate signing request&#39;s (CSR) friendly name.</p>
<p><strong>Important:</strong></p>
<ul>
<li>You <strong>must</strong> call either the <code>friendly_name</code> or <code>id</code> parameter.</li>
<li>When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server <a href="https://go.cpanel.net/serverroles">roles</a>, the system <strong>disables</strong> this function.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="friendly_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">friendly_name</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">friendly_name=TestCSR</span></div><div><div html="&lt;p&gt;The CSR&amp;#39;s friendly name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The CSR&#39;s friendly name.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">id=example_com_eda9d_543fb_a3009b4b01a592390866ab3a47c0df18</span></div><div><div html="&lt;p&gt;The CSR&amp;#39;s ID.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To retrieve a CSR&amp;#39;s ID, use the UAPI &lt;code&gt;list_csrs&lt;/code&gt; function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The CSR&#39;s ID.</p>
<p><strong>Note:</strong></p>
<p>To retrieve a CSR&#39;s ID, use the UAPI <code>list_csrs</code> function.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="new_friendly_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">new_friendly_name</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">new_friendly_name=TestCSR2</span></div><div><div html="&lt;p&gt;The CSR&amp;#39;s new friendly name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The CSR&#39;s new friendly name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/set_csr_friendly_name</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/set_csr_friendly_name</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riij9ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riij9ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riij9ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riij9ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riij9ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riij9ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riij9ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riij9ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riij9ca:0" aria-labelledby="tab:Riij9ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  set_csr_friendly_name <span class="token punctuation">\</span>
  <span class="token assign-left variable">friendly_name</span><span class="token operator">=</span><span class="token string">'TestCSR'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">id</span><span class="token operator">=</span><span class="token string">'example_com_eda9d_543fb_a3009b4b01a592390866ab3a47c0df18'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">new_friendly_name</span><span class="token operator">=</span><span class="token string">'TestCSR2'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riij9ca:1" aria-labelledby="tab:Riij9ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riij9ca:2" aria-labelledby="tab:Riij9ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riij9ca:3" aria-labelledby="tab:Riij9ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjij9ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjij9ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjij9ca:0" aria-labelledby="tab:Rjij9ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_csr_friendly_name&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/SSL-Certificate-Management/operation/set_key_friendly_name" data-section-id="tag/SSL-Certificate-Management/operation/set_key_friendly_name" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_key_friendly_name" id="operation/set_key_friendly_name" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSL-Certificate-Management/operation/set_key_friendly_name" aria-label="tag/SSL-Certificate-Management/operation/set_key_friendly_name"></a>Update private key&#x27;s friendly name </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function changes a key&amp;#39;s friendly name.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;You &lt;strong&gt;must&lt;/strong&gt; call either the &lt;code&gt;friendly_name&lt;/code&gt; or &lt;code&gt;id&lt;/code&gt; parameter.&lt;/li&gt;
&lt;li&gt;When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;roles&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function changes a key&#39;s friendly name.</p>
<p><strong>Important:</strong></p>
<ul>
<li>You <strong>must</strong> call either the <code>friendly_name</code> or <code>id</code> parameter.</li>
<li>When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server <a href="https://go.cpanel.net/serverroles">roles</a>, the system <strong>disables</strong> this function.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="friendly_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">friendly_name</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">friendly_name=TestKey</span></div><div><div html="&lt;p&gt;The key&amp;#39;s friendly name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key&#39;s friendly name.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">id=a9b72_63971_2cb6d8897b362cfb1548e047d8428b8d</span></div><div><div html="&lt;p&gt;The key&amp;#39;s ID.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key&#39;s ID.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="new_friendly_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">new_friendly_name</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">new_friendly_name=TestKey2</span></div><div><div html="&lt;p&gt;The key&amp;#39;s new friendly name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key&#39;s new friendly name.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/set_key_friendly_name</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/set_key_friendly_name</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riil9ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riil9ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riil9ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riil9ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riil9ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riil9ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riil9ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riil9ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riil9ca:0" aria-labelledby="tab:Riil9ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  set_key_friendly_name <span class="token punctuation">\</span>
  <span class="token assign-left variable">friendly_name</span><span class="token operator">=</span><span class="token string">'TestKey'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">id</span><span class="token operator">=</span><span class="token string">'a9b72_63971_2cb6d8897b362cfb1548e047d8428b8d'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">new_friendly_name</span><span class="token operator">=</span><span class="token string">'TestKey2'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riil9ca:1" aria-labelledby="tab:Riil9ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riil9ca:2" aria-labelledby="tab:Riil9ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riil9ca:3" aria-labelledby="tab:Riil9ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjil9ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjil9ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjil9ca:0" aria-labelledby="tab:Rjil9ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_key_friendly_name&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/SSL-Certificate-Management/operation/set_primary_ssl" data-section-id="tag/SSL-Certificate-Management/operation/set_primary_ssl" class="sc-dntaoT ceciOs"><div data-section-id="operation/set_primary_ssl" id="operation/set_primary_ssl" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSL-Certificate-Management/operation/set_primary_ssl" aria-label="tag/SSL-Certificate-Management/operation/set_primary_ssl"></a>Update SSL website for dedicated IP address </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function sets a new primary SSL website for a dedicated IP address.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets a new primary SSL website for a dedicated IP address.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="servername" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">servername</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">servername=hostname.example.com</span></div><div><div html="&lt;p&gt;The primary SSL website&amp;#39;s servername.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The primary SSL website&#39;s servername.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/set_primary_ssl</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/set_primary_ssl</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riin9ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riin9ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riin9ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riin9ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riin9ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riin9ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riin9ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riin9ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riin9ca:0" aria-labelledby="tab:Riin9ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  set_primary_ssl <span class="token punctuation">\</span>
  <span class="token assign-left variable">servername</span><span class="token operator">=</span><span class="token string">'hostname.example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riin9ca:1" aria-labelledby="tab:Riin9ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riin9ca:2" aria-labelledby="tab:Riin9ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riin9ca:3" aria-labelledby="tab:Riin9ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjin9ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjin9ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjin9ca:0" aria-labelledby="tab:Rjin9ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_primary_ssl&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/SSL-Certificate-Management/operation/show_cert" data-section-id="tag/SSL-Certificate-Management/operation/show_cert" class="sc-dntaoT ceciOs"><div data-section-id="operation/show_cert" id="operation/show_cert" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSL-Certificate-Management/operation/show_cert" aria-label="tag/SSL-Certificate-Management/operation/show_cert"></a>Export SSL certificate </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves a certificate.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you call this parameter, you &lt;strong&gt;must&lt;/strong&gt; include either the &lt;code&gt;id&lt;/code&gt; or
the &lt;code&gt;friendly_name&lt;/code&gt; parameter.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the Calendars and Contacts, Receive Mail, Web Disk,
Webmail, &lt;strong&gt;and&lt;/strong&gt; Web Server &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;roles&lt;/a&gt;,
the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a certificate.</p>
<p><strong>Note:</strong></p>
<p>When you call this parameter, you <strong>must</strong> include either the <code>id</code> or
the <code>friendly_name</code> parameter.</p>
<p><strong>Important:</strong></p>
<p>When you disable the Calendars and Contacts, Receive Mail, Web Disk,
Webmail, <strong>and</strong> Web Server <a href="https://go.cpanel.net/howtouseserverprofiles#roles">roles</a>,
the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="friendly_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">friendly_name</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">friendly_name=TestCert</span></div><div><div html="&lt;p&gt;The certificate&amp;#39;s friendly name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate&#39;s friendly name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">id</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">id=example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041</span></div><div><div html="&lt;p&gt;The certificate&amp;#39;s ID.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate&#39;s ID.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/show_cert</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/show_cert</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riip9ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riip9ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riip9ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riip9ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riip9ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riip9ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riip9ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riip9ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riip9ca:0" aria-labelledby="tab:Riip9ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  show_cert
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riip9ca:1" aria-labelledby="tab:Riip9ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riip9ca:2" aria-labelledby="tab:Riip9ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riip9ca:3" aria-labelledby="tab:Riip9ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjip9ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjip9ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjip9ca:0" aria-labelledby="tab:Rjip9ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;show_cert&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"cert"</span>: <span class="token string">&quot;-----BEGIN CERTIFICATE-----MIIDcTCCAlmgAwIBAgIFAU+BNVgwDQYJKoZIhvcNAQEFBQAwUTESMBAGA1UEAwwJc2lza28udGxkMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGY1BhbmVsMQswCQYDVQQIDAJUWDEQMA4GA1UEBwwHSG91c3RvbjAeFw0xNDEwMDYyMjI2MTlaFw0xNTEwMDYyMjI2MTlaMFExEjAQBgNVBAMMCXNpc2tvLnRsZDELMAkGA1UEBhMCVVMxDzANBgNVBAoMBmNQYW5lbDELMAkGA1UECAwCVFgxEDAOBgNVBAcMB0hvdXN0b24wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9zx6zGiHdmWA0dKtoXmJiWXpZ9E3PXx3YHsjFEWW7e5pH0vZ+jVMzDmm5nsJ7RXrAkZO1IvpIpVLvoQfiJOWVvkD+o9fWvoK1tWJS72FSgPju+58mA2ieBuc87A790Pzuv1P3NR3zFLAjUR99zkHR1fpri/daM3PBWO8ET48FWkyU1kOeZaUlF67/+wrEiNgg+t1qhKOCAB61PdNVkLaSGHimksuC+Czk8Kq9nuS0E0TCnDtjjEyJ455FUcaCfczlTb8xkB/F9ORe74yTzD+vlk0tFMG6PLj/ajIwWqwO0qmQ8wX3NRxkWgGz5kVO1wrVJarKQ5EYQ3/mgvit0v6dAgMBAAGj\\UDBOMB0GA1UdDgQWBBRw+wKBo34+bgexjAa3EMDsgSCd7zAfBgNVHSMEGDAWgBRw+wKBo34+bgexjAa3EMDsgSCd7zAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUAA4IBAQCHRXIs53opzKM2rM8Qe8lcw524WK6hqy2EWrZHp78N7rU7/6DQ/I3hv3WhcDDIO04I2/Xhe88MLBaLoM367Ya+vy7CaLr14aLi/SfQszMA0ALBvMao+Fis0iVwFYq/NLgSXw+fgnpFskt8v8iQZ+4Kaal8U8e9sVgu8m0RgO7rzym1eRiIKpsKd1rh/SD7LbSN7M7TRL3QqF7ltw9sQhAAsQcRaBBF21pdWrqhiGZ+Eioo3hhgwNavH2agqz78ddHwrFpHFwrEeUk1OfpPb76MYIce7xIy/4oQNdg6fOq4l/FrajBv+WkzDVPaKm6r7YmwfLN/YMZBHXSR58oOGP9W-----END CERTIFICATE-----&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_curve_name"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_public"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"friendly_name"</span>: <span class="token string">&quot;TestCert&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_self_signed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"commonName"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"countryName"</span>: <span class="token string">&quot;US&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"emailAddress"</span>: <span class="token string">&quot;username@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"localityName"</span>: <span class="token string">&quot;Houston&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"organizationName"</span>: <span class="token string">&quot;Organization&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"stateOrProvinceName"</span>: <span class="token string">&quot;Texas&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">&quot;rsaEncryption&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">&quot;a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"not_after"</span>: <span class="token number">1601467200</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"not_before"</span>: <span class="token number">1569844800</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"signature_algorithm"</span>: <span class="token string">&quot;sha256WithRSAEncryption&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"commonName"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"countryName"</span>: <span class="token string">&quot;US&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"emailAddress"</span>: <span class="token string">&quot;username@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"localityName"</span>: <span class="token string">&quot;Houston&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"organizationName"</span>: <span class="token string">&quot;Organization&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"stateOrProvinceName"</span>: <span class="token string">&quot;Texas&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"validation_type"</span>: <span class="token string">&quot;dv&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"text"</span>: <span class="token string">&quot;Certificate:\n Data:\n Version: 3 (0x2)\n Serial Number:\n d1:e8:74:8c:d0:69:d2:55\n Signature Algorithm: sha1WithRSAEncryption\n Issuer: CN = example.com, C = US, emailAddress = username@example.com, O = Example, ST = Texas, L = Houston\n Validity\n Not Before: Apr 10 22:38:10 2013 GMT\n Not After : Apr 10 22:38:10 2014 GMT\n Subject: CN = example.com, C = US, emailAddress = username@example.com, O = Example, ST = Texas, L = Houston\n Subject Public Key Info:\n Public Key Algorithm: rsaEncryption\n Public-Key: (2048 bit)\n Modulus:\n 00:c6:9c:e3:37:1a:fc:e6:1b:e4:29:4d:8e:ee:ec:\n bd:7a:52:12:ef: 34:71:64:77:e0:79:76:6d:ba:f0:\n 77:fd:f0:92:18:b0:84:c3:f7:12:3a:a9:b9:1d:16:\n 6c:a0:10:6d:f0:55:17:35:27:ff:81:a7:46:e6:d4:\n 36:97:34:01:3a:2f:6d:61:9a: 04:20:e3:fd:06:11:\n 8b:a4:5e:4f:6d:0d:93:8e:3b:cc:cb:19:b3:cb:74:\n 7a:54:82:ae:52:9e:46:31:7a:02:44:0b:7b:26:e8:\n 84:aa:91:2b:25:c1:42:0c:cc:5d:c4:d5: c4:cf:df:\n de:4c:7c:22:99:ab:06:79:99:16:1e:a7:49:5b:9b:\n 89:97:18:3c:1e:4b:c6:c5:b5:b2:9d:7d:be:b9:91:\n c6:08:38:7d:dc:81:18:2b:0c:2c:da:29:f4:aa:a2:\n 72:46:d9:c2:68:31:89:51:ab:32:af:7a:8d:9b:a7:\n d8:b8:b5:37:21:03:91:1d:4e:d8:fc:f1:0e:1f:96:\n 17:d6:90:25:c1:3a:1a:76:4c:9e:2b:7e:b9:9c:f5:\n 86:0a:cf:ea: 2f:eb:bc:33:ee:69:49:b9:c2:e6:a0:\n ef:ee:90:19:4a:2a:64:7e:ef:96:46:7e:7d:e2:35:\n ec:d9:cf:34:42:7a:3d:c1:22:b9:68:a2:b3:02:a3:\n 7f:f5\n Exponent: 65537 (0x10001)\n X509v3 extensions:\n X509v3 Subject Key Identifier:\n 6A:A1:EA:62:FB:B2:C4:AC:04:B0:43:DD:56:BE:8A:8D:FA:16:D3:F4\n X509v3 Authority Key Identifier:\n keyid:6A:A1:EA:62:FB:B2:C4:AC:04:B0:43:DD:56:BE:8A:8D:FA:16:D3:F4\n\n X509v3 Basic Constraints:\n CA:TRUE\n Signature Algorithm: sha1WithRSAEncryption\n 3c:1e:f7:3d:20:1b:a2:bd:5c:d6:0f:2a:9e:f3:b0:83:bf:a9:\n a0:90:9b:96:b1:a6:1e:8b:be:7c:f5:72:58:a0:48:3e:68: 43:\n 06:37:63:0a:cb:9c:23:98:c6:9e:f1:73:e8:4b:71:ac:07:fc:\n d0:5c:e1:55:4f:be:a7:75:5a:57:da:a1:c2:46:63:8f:3a:70:\n 4c:42:3c:03:4c:a0:47:a3:fc: ae:15:03:25:a5:78:63:a2:73:\n cd:47:d5:64:7c:d4:f5:85:f7:03:b8:b4:d8:95:75:6a:78:5c:\n e6:c7:69:02:7b:a4:fc:4d:8c:80:7b:c7:1c:71:04:ba:53:71:\n 7a: ce:00:cb:0e:5e:21:89:02:ba:90:02:8e:b5:79:8e:84:50:\n b0:21:63:b0:ac:19:80:c5:1d:a2:95:68:b7:ee:35:10:fa:db:\n f5:bf:b0:16:b1:34:76:f2:d6:ee:07:3b:6d:b6:0c:1d:b4:e5:\n 53:50:23:b8:c4:bf:fe:d6:77:ec:89:68:a0:d8:dd:f4:f5:fa:\n 7d:f6:c4:72:02:b1:e8:87:f7:e1:16:71:80:2e:e7:94:7b:eb:\n c6:a7:07:36:05:6d:34:b4:25:74:e9:c2:2c:9e:3d:bc:97:8e:\n 84:ce:cc:4f:1f:11:67:ad:30:f6:83:3e:be:bb:88:48:10:65:\n f7:4b:2f:80\n&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/SSL-Certificate-Management/operation/show_key" data-section-id="tag/SSL-Certificate-Management/operation/show_key" class="sc-dntaoT ceciOs"><div data-section-id="operation/show_key" id="operation/show_key" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSL-Certificate-Management/operation/show_key" aria-label="tag/SSL-Certificate-Management/operation/show_key"></a>Export private key </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves a private key.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, &lt;strong&gt;and&lt;/strong&gt; Web Server &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;roles&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a private key.</p>
<p><strong>Important:</strong></p>
<p>When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, <strong>and</strong> Web Server <a href="https://go.cpanel.net/serverroles">roles</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="friendly_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">friendly_name</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">friendly_name=TestKey</span></div><div><div html="&lt;p&gt;The key&amp;#39;s friendly name.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You &lt;strong&gt;must&lt;/strong&gt; use either the &lt;code&gt;id&lt;/code&gt; or the &lt;code&gt;friendly_name&lt;/code&gt; parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key&#39;s friendly name.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> use either the <code>id</code> or the <code>friendly_name</code> parameter.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">id</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">id=example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041</span></div><div><div html="&lt;p&gt;The key&amp;#39;s ID.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You &lt;strong&gt;must&lt;/strong&gt; use either the &lt;code&gt;id&lt;/code&gt; or the &lt;code&gt;friendly_name&lt;/code&gt; parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key&#39;s ID.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> use either the <code>id</code> or the <code>friendly_name</code> parameter.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/show_key</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/show_key</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riir9ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riir9ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riir9ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riir9ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riir9ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riir9ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riir9ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riir9ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riir9ca:0" aria-labelledby="tab:Riir9ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  show_key
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riir9ca:1" aria-labelledby="tab:Riir9ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riir9ca:2" aria-labelledby="tab:Riir9ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riir9ca:3" aria-labelledby="tab:Riir9ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjir9ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjir9ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjir9ca:0" aria-labelledby="tab:Rjir9ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;show_key&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token number">1365633415</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_curve_name"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_public"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"friendly_name"</span>: <span class="token string">&quot;TestKey&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">&quot;-----BEGIN RSA PRIVATE KEY-----\nMIIJJwIBAAKCAgEA4yilqsoCdEpiNOyLcPJ4FLT7vgwaLdOBeJLTMUeV2uZM4v65\n/tiZe7H0soDp1C55SCr3uEIEa7Lq7RUZ+F5p67BgRR19rmerKGxfN7N5Vu97pfTw\nW1f+lVsxUF/56lVeoAmm4okU98xJHiGGlI8ZHGJbUMYfLPy0OrA+gNwMHqMVOv1B\nSgpbEWCILMvnvtp0rwPutjnPVX2Dj40ia40L4Wqvp+0Yg7mZyhIOl+q6VZVIdXZs\nlR4ZywfRBYt3ieFBDYMyNw9wN3Xy44fCpHc77+ho84W3BqrGaWSSDyf6UkZGD5mf\nohGf2JSp+c8J6H7hsxo7pta3K1diVXFOSfnaA+k56zW445XruwYs/SN/zvGetGi6\nuqhMAcVRQcYCmLCixcC6RkcUx3exxgR4q3gthDnFvWC4+NuTh8/K0BcxcuCEhRug\n/MfVfO3+f7RJFSJPFb9m9Lf4HHBSVkDP5WtG4XiBKCe++9Wuvxbd4QxS7YrnSopN\nKxkuHKswH8ONpADMYDqfLODMhNrslHNHu95Nv7AlQr8weLqMGWMp7GFqzXcl39Rn\nVkF4Bxd3bAAsMN8/JvanMKCPjTTDrfzVFZcmHXPYOljYDdY1xfIstYVtbyFkUHZP\n2RPPBaPUAt90lzrKGVF8a2vdIKRiey5SZ5qu9c/mGri3oz7Lkk7qkNPAqDMCAwEA\nAQKCAgA3f9raG3j2CKZt381Bzzvfc0h+al6LC736Q4Ut6RuH2/S1ER9IUItPWW87\nnZuDp8ciBr13W0nRNmmHezxZHlgqqXEb8dSfI90Bh1jMNyFSSDihl3KSHrGotBsc\nVBavViREXZdUicGBuXuxtkYno96yvKUq2v0K9MLkA+OBgEHFynqJaw7klBsj573d\nlAQO8TjI+eD8zKsHbB8Ul5rtRAy/Cl3YXWk75cDZSggevc7A0jRd3o0w8aXDoSlE\nfYq7OTm3n3JJWZBFPKAXTzgTDr6qItJhjS4IxXsq7RNyeIYES/8aGKKT6lJvjALr\ncdYt47IpHCOu447lG/h+f6xtDophLGZoAirO7lJFRVfLJh76sLF12bpXJKbbmMN+\naut0nM+MLEw8A5K9OV24jJ/3+afj//5789asIyvNaQFPOX23SdLX0QbA5QWvJt2t\nWvvpS3ubcIJaBEMTK8asEBC68eUW0BBKJaSiYNzecUFYCBjQlxKsIrYuWZoW6fMy\nRel+cnqMdiH7r2p6RmgF5c9myDwq3E47jE+VrOy8uhw7EMQvT8+YSKaIbgtFZcUS\nU02BDRB7gWNa842m6nGs5tj5xFNQ6Wt410vilTwL+6zCQqJaKmcdE3woiIgSdrw5\nMssAHHjqo7QJthZfbpUAUTc6jGPNO13U1ediIRAGdQW5ALqTwQKCAQEA884bmFFZ\nLTewHIv1PJFfNxVZfk3C7LhWE2JcI/5P/YrN4ZA8G08OYhgxqa5XnsHHQPwMM85i\n1HeOoPwqgTMIyLDX/Sf88+eW3ef4V2M1Y4op0ahWFEwbwXKGxOhncElObN7dfZUw\nVlxCReaiw2XQAGRqtQC0f+9dZysqPJr+Rz6poTiOtm7DcpW/WiGfBPvVhzBENyqo\nuL9V3vCWYPJSLtCexECoGoPSpHKgUkwbh3+ra8SfG6FOIBj4PpMB82R7oPDjIyXF\n1VDfb0EwYQlKxyZoP9+NPT2MhZv/hF/Mbm/5LolVHx92hO9q6yxS6nvaFmEPr9fY\n1EOTWzzPOA+VyQKCAQEA7oVioaTqxENt+wHITZq100iYUpm4X1N1eENTp97QyQbQ\nOVR/t8iGLUdvOZdIxBSTS3JFQ8TNcGDPPc+o319QGdZABNnKwFGY3Ss+5QgVeX6n\n0WKdxCRelUOUB174aBeXcJCKplh6xBUrLfSZxvZQQb7fv0Mb+2eKUBKTymvES1kp\nYdn1T0vCCHA3bVpaHuqliCoDSX3RmQICZlfSgCGBbAkmU8RuxDd9yR9l7O9MXUmL\nsqlsw6hvbUt+7Y13YlDtyX8gbCwEEYsoALOotY1xNfXnyZKTAXhrg+xsQLrURYZU\noZiCJyK/mHCWRTPVkt89wq4IexbJ9hqlRjzpmlr8GwKCAQBxRSCs855q06SOnreh\nHCkQfmrFs3sMX9gdyWTllBG1yfc9BLXoOiKEkJkCLG2o5H6eQnuo1go0jBdH0+Ar\nhnpeQ0sV4q4y4zXEgzFt6Dm1tUsYjQzxASskBQF4GkF0eZpmGmTtI5MBjHt93llg\nTr0EcaLh1SIHDj5m4DcPUTMyBnro3E3xlCRZ6Biu10/6EMZzuIj42Gjq7HoIyd4T\nzIFCHsqkgyWWrAgBPwAdPB7OJRKPTxpcy+RwJSmwaLxPSC/n5gKhIbt4D8q+9Zp0\nesyzGbT1d/c2rJHMwV1FMvzXkk5CwKs7enKl8FXMTRt4tXHtU8rl93JVq8+aY/Yi\nJZuBAoIBAERG2lz7IFjeFHVtpTDRwIqilTfP2P8wnMe4PhInrgxdbu16SrUJKZ98\ne1I5BBNc8G0AYONtSoGItMo0z1phpkQ/GERLM8aplOB6qJ5XGg6VOuStHgwvfQOt\nPIp/nQvu9OK7/XRwj3Phu2KESiCyEXdAdDwDsdbdZLJXHwcqoh4Pf9EK2zW/seNI\nfBVJb9K5yHiZzicTZRQvhxBUw2T6MloCpH4GFM8GM3OHEV4pgeqSSvLxnLjFVmAq\n5EKL5Ei4cdjkExvj3aZH90N8KicOPgH8SkVhN8OL/Prein5c/LaKJV+8kEUzpTS1\nxc45cEGCteMsfjD97QINzpG0jgopUVECggEADIaKsx8NUQT3hm0wHRanEFJnQH5H\nzxaQjWbsjm2uz0KROPNIK1X5L8kypsb+EzlJtvWUqxPaOaTv4DZVpFaVzk8/2PPG\nsYR3mUjqMqNFYMrNwYZAXvJ/huzDPqq6+w2Pn9jcAifHNw3S8UR650v8gl7BU4fV\nBvhamG8JelvwLqeGWoikST9NBXVqG5IKBpUkUiFOMUNmRih9ooKvhy7GosoK8MWb\nmhWo1v8TTSXSagACUhAoIzb6mMN/VFC5WDbFx5AEB/G9tq/zmTqQkuo39dvgl30w\nyZGRNwc1aFf1Kxeven10/JN9ipp0mTa7NYSdn0RAe9ZRp5cCkgmktqmB0g==\n-----END RSA PRIVATE KEY-----&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">&quot;rsaEncryption&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">&quot;a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus_length"</span>: <span class="token number">2048</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"text"</span>: <span class="token string">&quot;Private-Key: (2048 bit)\nmodulus:\n 00:b1:16:ee:3e:de:ff:41:3c:f2:cb:b5:c5:0a:3d:\n    c8:0d:64:bc:02:9f:e1:90:c9:7f:da:e8:03:e6:2c:\n 47:9f:e4:ff:5e:0d:95:64:5d:32:c2:b7:c9:01:ae:\n    30:e5:17:da:82:78:f4:15:b9:46:40:eb:8b:99:5c:\n cc:4b:e4:2a:e4:ee:0e:28:29:01:79:ee:d4:90:bc:\n    5d:9e:ab:b0:46:7c:de:4f:df:b2:d7:d1:76:89:88:\n ad:f3:6c:36:f3:a0:07:8c:90:88:19:52:0a:68:a1:\n    4d:c0:26:9e:8d:53:70:91:83:87:f4:8a:d9:b5:0f:\n a7:ed:31:f3:8f:34:d2:ca:e7:d1:31:ea:42:17:5d:\n    4d:48:7d:b3:73:07:72:40:9a:58:55:c8:b3:b6:ff:\n c2:b5:f6:ba:64:bd:3e:06:62:42:cd:44:0b:d2:f1:\n    76:5e:bb:20:55:47:d4:10:86:2d:ec:6b:e7:d2:0e:\n 5d:99:48:ca:4d:66:35:e1:1a:db:1b:96:0a:41:64:\n    aa:c4:1b:1f:9d:90:e3:2e:aa:70:61:f7:77:b6:7b:\n f7:44:22:d8:73:0b:53:84:63:c3:f4:a4:19:e2:07:\n    f6:0b:42:8a:3d:70:cb:92:24:80:44:e7:36:5d:01:\n a2:e0:e5:cd:50:e1:f7:7c:5a:9a:b5:da:c4:0f:c4:\n    73:f5\npublicExponent: 65537 (0x10001)\nprivateExponent:\n 5b:c3:ae:21:16:1c:df:09:5e:27:01:41:e1:54:b2:\n    5d:7e:5d:8e:5e:9a:dc:14:0e:14:b9:35:8c:08:55:\n f5:1d:0c:d7:07:e2:e9:e7:01:6e:b5:1d:8b:a9:5f:\n    dc:d6:c7:7b:e4:81:56:e0:72:ef:21:1f:6d:91:10:\n ac:22:c7:b7:69:44:1c:bb:62:f0:74:39:e1:e6:39:\n    fd:06:aa:89:5c:1b:36:f8:8c:0c:19:96:7b:1e:40:\n 45:6b:45:ee:68:76:80:f8:44:0e:1a:dd:19:ea:bc:\n    07:5d:fb:ba:f0:09:dc:dd:73:8d:dc:85:83:b5:61:\n 27:20:43:3d:69:f9:f0:f9:e1:73:76:29:5a:b0:05:\n    23:65:47:e8:39:f0:21:be:17:84:73:0a:08:15:4e:\n 7b:e2:14:6a:72:c7:d3:13:ff:98:ee:96:c9:40:a3:\n    d3:0d:6c:90:48:25:7c:79:74:bf:be:fa:18:62:4d:\n c9:95:d4:d9:1a:47:59:4b:98:9a:2f:95:94:f4:4e:\n    78:cc:39:ef:9f:f7:6e:eb:db:cb:e5:95:ef:8f:ee:\n 5b:bf:c7:2a:29:e5:76:16:28:53:04:8e:ef:3f:66:\n    6f:34:a1:21:09:d6:da:ac:dd:ad:8c:2e:72:78:87:\n 01:45:f2:fa:3b:b9:23:2d:cf:5f:66:dc:c7:1c:0b:\n    e1\nprime1:\n 00:e9:14:c4:18:92:16:8e:ad:fd:cf:17:f0:8c:f7:\n 55:e0:58:3d:e3:cd:bd:4d:4e:00:64:ee:f0:cf:a5:\n    b0:14:19:85:ea:03:a8:be:18:78:34:3b:04:8c:b8:\n be:9a:ee:fc:0a:3e:6f:d2:8f:8f:fd:31:2d:02:97:\n    6e:bb:18:5b:9c:6a:85:6e:25:95:a4:40:4e:0b:91:\n a1:c3:85:bd:84:0c:d5:72:34:13:12:d9:20:56:52:\n    06:53:aa:06:2d:d0:61:2b:0b:d9:94:c6:d7:62:0f:\n c9:7d:17:cc:81:39:b3:59:e5:ce:77:d5:8a:82:ab:\n    2d:37:8a:51:49:3a:aa:c7:37\nprime2:\n 00:c2:80:b7:b4:85:25:37:30:b4:45:f3:3a:69:cf:\n    c3:86:43:89:db:d4:09:6b:72:54:a6:89:b4:a7:43:\n 3c:dd:da:c6:46:89:93:0a:05:9a:8c:d6:05:5c:6a:\n    4d:34:1e:84:5b:14:28:b7:ef:d2:be:a5:10:9c:5f:\n e7:35:fb:15:e2:9e:4a:60:0a:73:01:f0:55:6c:75:\n    25:8a:9b:b0:32:d3:28:41:11:e2:85:2d:f6:35:76:\n 6c:68:14:ba:02:98:44:82:e1:c6:ca:f7:07:78:ca:\n    ff:1a:60:3a:e1:88:91:55:a1:ae:11:46:29:4b:f0:\n 0f:e0:de:8a:0d:26:91:5c:33\nexponent1:\n    1d:2a:ad:13:4a:0c:aa:94:19:43:b6:02:33:11:ac:\n 5c:63:8e:73:18:46:cd:0a:aa:bf:f6:aa:89:c1:79:\n    14:3a:d1:68:24:47:14:6a:a9:78:17:be:8d:01:7d:\n 50:94:01:54:22:d6:09:6a:4f:a1:66:6a:f4:7d:10:\n    ad:36:f2:17:d3:b8:98:bc:f9:49:d1:86:32:aa:69:\n ac:b6:ea:ad:40:91:e1:35:a5:01:61:cc:4b:20:fe:\n    8b:af:a6:10:4b:98:2d:33:d1:69:6d:ac:7c:27:ef:\n 95:c8:c9:9d:8e:23:e4:66:fe:7c:3e:6b:93:c8:69:\n    e3:1e:5a:e7:a8:00:c0:e7\nexponent2:\n 6d:2e:3b:f0:c5:5c:a2:a2:60:4f:73:bd:32:70:41:\n    dd:38:44:46:75:bb:e3:e8:85:c4:06:40:b6:33:74:\n 13:45:1f:4f:b1:22:2c:da:00:6b:56:28:24:3c:37:\n    a2:2e:0f:35:e1:17:0a:49:41:0f:6b:30:eb:d6:99:\n bf:1f:76:a5:83:1d:54:d4:08:c2:e9:d9:c9:cb:e8:\n    8a:e9:e1:fa:65:b5:8e:f1:2f:2a:7b:26:5d:d4:5f:\n fd:fc:c4:7d:78:63:dc:e4:47:e6:de:cb:fe:ee:54:\n    4c:c5:ff:c7:62:15:d2:ef:b2:fa:57:5c:0f:18:6e:\n 91:57:da:3e:8f:8b:c1:29\ncoefficient:\n    00:bd:71:a9:3c:18:7b:0c:93:ab:d5:bf:f3:be:ea:\n 35:45:86:ce:60:0f:67:b3:2d:ba:5f:cf:9f:b6:1a:\n    13:27:cb:da:e7:ad:f3:c7:c2:06:7c:9e:00:d5:6c:\n 07:74:71:2c:35:39:c9:4b:24:cc:11:fd:60:c2:a2:\n    0b:28:b9:8b:4d:48:c6:0d:f0:39:34:dc:e2:c9:3a:\n b8:c6:64:0a:17:df:c4:f1:3d:fb:18:0b:af:ed:27:\n    3f:98:3b:e1:24:72:fc:5d:af:2c:e3:b6:07:3e:e1:\n 2f:fe:db:44:b0:8b:c3:e5:72:82:e5:a4:4a:3a:37:\n    8f:c4:9f:db:e9:1c:33:6a:f3\n&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/SSL-Certificate-Management/operation/show_csr" data-section-id="tag/SSL-Certificate-Management/operation/show_csr" class="sc-dntaoT ceciOs"><div data-section-id="operation/show_csr" id="operation/show_csr" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSL-Certificate-Management/operation/show_csr" aria-label="tag/SSL-Certificate-Management/operation/show_csr"></a>Export certificate signing request </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves a certificate signing request (CSR).&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail,
and Web Server &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;roles&lt;/a&gt;,
the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you call this function, you &lt;strong&gt;must&lt;/strong&gt; include either the &lt;code&gt;id&lt;/code&gt;
or the &lt;code&gt;friendly_name&lt;/code&gt; parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a certificate signing request (CSR).</p>
<p><strong>Important:</strong></p>
<p>When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail,
and Web Server <a href="https://go.cpanel.net/howtouseserverprofiles#roles">roles</a>,
the system <strong>disables</strong> this function.</p>
<p><strong>Note:</strong></p>
<p>When you call this function, you <strong>must</strong> include either the <code>id</code>
or the <code>friendly_name</code> parameter.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="friendly_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">friendly_name</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">friendly_name=TestCSR</span></div><div><div html="&lt;p&gt;The CSR&amp;#39;s friendly name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The CSR&#39;s friendly name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="id" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">id</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">id=example_com_e095f_0ab2f_ebcbe4a571276f48562241411556647f</span></div><div><div html="&lt;p&gt;The CSR&amp;#39;s ID.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The CSR&#39;s ID.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SSL/show_csr</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/show_csr</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riit9ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riit9ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riit9ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riit9ca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Riit9ca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Riit9ca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Riit9ca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Riit9ca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riit9ca:0" aria-labelledby="tab:Riit9ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  show_csr
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riit9ca:1" aria-labelledby="tab:Riit9ca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riit9ca:2" aria-labelledby="tab:Riit9ca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riit9ca:3" aria-labelledby="tab:Riit9ca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjit9ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjit9ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjit9ca:0" aria-labelledby="tab:Rjit9ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;show_csr&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"csr"</span>: <span class="token string">&quot;-----BEGIN CERTIFICATE REQUEST-----\nMIIC3TCCAcUCAQAwgZcxFDASBgNVBAMMC2V4YW1wbGUuY29tMRYwFAYDVQQLDA1E\nb2N1bWVudGF0aW9uMQswCQYDVQQGEwJVUzEiMCAGCSqGSIb3DQEJARYTbGF1cmVu\nY2VAY3BhbmVsLm5ldDEUMBIGA1UECgwLY1BhbmVsIEluYy4xDjAMBgNVBAgMBVRl\neGFzMRAwDgYDVQQHDAdIb3VzdG9uMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAp092NvpqyT7mg2qDqZW1XetQGeo217o9r7AOONaTrNsMgbL/d31rQzpC\nD65SPxJ/NSpovMi48tbue3A5W6+r2CN62oFk/d34N2swN1w11NTLzOfTPQgGnBe0\nCRdqNonx68l8Cwj+auRMGakqxtaESOfx0T87Ngr/1CIqUbTzU0LembWh+1VI5Djy\n2CRmRWKkSAAu7X/OJN7cfcPh7ReZc9Ha6VmzNxbutBDRcnCJVOAGMsv2Cg4mQZhg\nyMC8KF1r/ktHneDdGJdypdrmdr0qkqzMwTaYIb6M/93Yp+bswGH4oyqa4GYeTpRu\n2OOCeydxONOnYRZWfL0SnL2Gnvnd3wIDAQABoAAwDQYJKoZIhvcNAQEFBQADggEB\nAFlolzJbcviWcdZUv+PJ7G8cAqFAxa8a3W2a0Y1U0BaMrpDfuOHpQgOtO62rr+i+\nhkrIReuk7Isyl6GoZkX17KhQ1Vo9aW8a8Ur7+0RGDbxRlK9jJWnvSFn6cMMqRSfA\nDXpptxhqBFZJIZMc3pPX9Jqycuu8bxeIvUKeSMe3Jxcl1ZXEXX47FeRZxvd+WXF9\n4Xu4KZXHdzb5tB6jPhzIaN0/3d92N/KhvCcnw3YC2fEGDkpOlZaoa7O72+aq5K3b\nM1htFv9deAHqIHefV41iOrxUCIKIhdPIjvAm774lDHLzPpJVrshO/NpA74LEkny5\nFMwKKx+6Jgx1HSWucn5kWek=\n-----END CERTIFICATE REQUEST-----&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"details"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"commonName"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"countryName"</span>: <span class="token string">&quot;US&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token number">1538265600</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"emailAddress"</span>: <span class="token string">&quot;username@example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"friendly_name"</span>: <span class="token string">&quot;TestCSR&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">&quot;rsaEncryption&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"localityName"</span>: <span class="token string">&quot;Houston&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">&quot;a74f7636fa6ac93ee6836a83a995b55deb5019ea36d7ba3dafb00e38d693acdb0c81b2ff777d6b433a420fae523f127f352a68bcc8b8f2d6ee7b70395bafabd8237ada8164fdddf8376b30375c35d4d4cbcce7d33d08069c17b409176a3689f1ebc97c0b08fe6ae44c19a92ac6d68448e7f1d13f3b360affd4222a51b4f35342de99b5a1fb5548e438f2d824664562a448002eed7fce24dedc7dc3e1ed179973d1dae959b33716eeb410d172708954e00632cbf60a0e26419860c8c0bc285d6bfe4b479de0dd189772a5dae676bd2a92acccc1369821be8cffddd8a7e6ecc061f8a32a9ae0661e4e946ed8e3827b277138d3a76116567cbd129cbd869ef9dddf&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"organizationName"</span>: <span class="token string">&quot;Organization&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"organizationalUnitName"</span>: <span class="token string">&quot;Department&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"stateOrProvinceName"</span>: <span class="token string">&quot;Texas&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"text"</span>: <span class="token string">&quot;Certificate Request:\n Data:\n Version: 0 (0x0)\n Subject: CN = example.com, C = US, emailAddress = username@example.com, O = Example, ST = Texas, L = Houston\n Subject Public Key Info:\n Public Key Algorithm: rsaEncryption\n Public-Key: (2048 bit)\n Modulus:\n 00:bf:44:22:cb:13:2b:7f:41:9f:48:85:d6:2c:77:\n 03:cf:84:db:90:5c:5a:ed:e5:9c:cb:d6:9d:4b:fc:\n 67:58:b7:db:71:dd:eb:8e:5a:77:6f:03:5d:96:85:\n 60:dc:91:45:59:85:ff:9e:57:76:a5:b5:cd:dc:48:\n 25:89:3f:8f:17:c1:c2:1e:4d:ec:f0:08:1a:a9:cc:\n 2d:45:34:be:82:77:a5:e4:bb:0b:82:bc:82:51:c3:\n ac:1b:ed:c3:a4:b3:e6:14:4f:ba:9e:39:af:08:ae:\n 3c:2c:15:bd:dc:03:17:93:01:95:4f:c0:2a:0f:3b:\n 46:5f:5e:6f:96:d5:b2:dd:53:22:a9:91:e4:36:8e:\n f2:60:5b:ca:b3:72:e6:be:53:8b:9e:b6:72:26:04:\n 85:37:f4:89:c1:78:91:7d:46:96:71:c4:be:39:f3:\n cc:1d:79:bc:33:61:5c:5f:76:52:4a:7d:d0:60:31:\n 79:96:44:6e:6a:77:72:70:1f:3f:08:24:e6:d1:50:\n c0:6a:86:98:df:56:8b:ae:2f:c1:97:bc:ed:4c:70:\n a1:a6:b2:7e:25:97:8f:95:73:a1:84:71:43:da:33:\n 48:d5:44:17:e1:28:1e:37:93:63:fa:ec:45:17:39:\n e5:ff:62:90:6b:b2:eb:11:5b:32:b2:ce:51:0b:8a:\n 3e:95\n Exponent: 65537 (0x10001)\n Attributes:\n a0:00\n Signature Algorithm: sha1WithRSAEncryption\n 41:bd:99:89:7a:1b:c2:71:90:f7:5a:17:05:c9:77:c8:f0:0e:\n 62:0f:85:0d:fb:16:02:74:34:5f:7a:93:3e:50:8e:cf:f4:6f:\n ee:ab:7b:c9:ef:7c:76:59:dd:85:fd:7d:4e:ac:95:9d:b7:ae:\n 8a:89:fc:1f:5b:ee:ee:6b:cd:9b:4e:2d:2a:fb:1b:32:8f:8f:\n 56:70:d1:42:c1:72:ed:04:4b:27:5a:ee:5a:e1:2b:6e:53:59:\n aa:14:25:87:7f:2b:c3:7a:f5:b2:6c:71:2a:93:62:40:ca:87:\n b4:fe:34:a1:95:77:1e:98:f1:71:5e:14:97:61:73:07:8d:bc:\n 3e:e1:f8:47:f7:00:8b:06:a5:1c:84:a3:88:9a:7b:37:74:5d:\n 34:a6:ae:22:ab:a3:b8:9f:d7:ab:60:9a:70:81:15:13:0f:d9:\n ff:ab:7a:2b:fd:cb:96:04:ad:00:6b:e4:74:4e:59:57:a5:9e:\n 84:c7:74:d8:62:08:37:b3:ee:cc:74:b2:b6:26:e8:c0:37:32:\n 19:dc:1c:ff:97:4a:cc:1c:36:c3:a7:2d:ca:77:53:c4:1d:1c:\n 3c:36:5b:f8:90:46:01:48:49:61:9b:ef:bb:b3:a8:94:0b:3f:\n 50:51:93:29:9f:aa:9a:ab:ae:3d:3c:72:8a:0b:bc:2f:3f:19:\n d7:5d:70:14\n&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/SSL-Certificate-Management/operation/upload_cert" data-section-id="tag/SSL-Certificate-Management/operation/upload_cert" class="sc-dntaoT ceciOs"><div data-section-id="operation/upload_cert" id="operation/upload_cert" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSL-Certificate-Management/operation/upload_cert" aria-label="tag/SSL-Certificate-Management/operation/upload_cert"></a>Import SSL certificate </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function uploads a certificate.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;Due to the limited field length of HTTP GET method calls, you &lt;strong&gt;must&lt;/strong&gt; use the HTTP
POST method. For this reason, you &lt;strong&gt;cannot&lt;/strong&gt; use a cPanel or Webmail session URL to
call this function.&lt;/li&gt;
&lt;li&gt;When you disable the Calendar and Contacts, Receive Mail, Web Disk, Webmail, and
Web Server &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;roles&lt;/a&gt;,
the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function uploads a certificate.</p>
<p><strong>Important:</strong></p>
<ul>
<li>Due to the limited field length of HTTP GET method calls, you <strong>must</strong> use the HTTP
POST method. For this reason, you <strong>cannot</strong> use a cPanel or Webmail session URL to
call this function.</li>
<li>When you disable the Calendar and Contacts, Receive Mail, Web Disk, Webmail, and
Web Server <a href="https://go.cpanel.net/howtouseserverprofiles#roles">roles</a>,
the system <strong>disables</strong> this function.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="crt" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">crt</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;pem-certificate&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">crt=&quot;-----BEGIN CERTIFICATE-----/nMIIDcTCCAlmgAwIBAgIFAU+BNVgwDQYJKoZIhvcNAQEFBQAwUTESMBAGA1UEAwwJc2lza28udGxkMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGY1BhbmVsMQswCQYDVQQIDAJUWDEQMA4GA1UEBwwHSG91c3RvbjAeFw0xNDEwMDYyMjI2MTlaFw0xNTEwMDYyMjI2MTlaMFExEjAQBgNVBAMMCXNpc2tvLnRsZDELMAkGA1UEBhMCVVMxDzANBgNVBAoMBmNQYW5lbDELMAkGA1UECAwCVFgxEDAOBgNVBAcMB0hvdXN0b24wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9zx6zGiHdmWA0dKtoXmJiWXpZ9E3PXx3YHsjFEWW7e5pH0vZ+jVMzDmm5nsJ7RXrAkZO1IvpIpVLvoQfiJOWVvkD+o9fWvoK1tWJS72FSgPju+58mA2ieBuc87A790Pzuv1P3NR3zFLAjUR99zkHR1fpri/daM3PBWO8ET48FWkyU1kOeZaUlF67/+wrEiNgg+t1qhKOCAB61PdNVkLaSGHimksuC+Czk8Kq9nuS0E0TCnDtjjEyJ455FUcaCfczlTb8xkB/F9ORe74yTzD+vlk0tFMG6PLj/ajIwWqwO0qmQ8wX3NRxkWgGz5kVO1wrVJarKQ5EYQ3/mgvit0v6dAgMBAAGjUDBOMB0GA1UdDgQWBBRw+wKBo34+bgexjAa3EMDsgSCd7zAfBgNVHSMEGDAWgBRw+wKBo34+bgexjAa3EMDsgSCd7zAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUAA4IBAQCHRXIs53opzKM2rM8Qe8lcw524WK6hqy2EWrZHp78N7rU7/6DQ/I3hv3WhcDDIO04I2/Xhe88MLBaLoM367Ya+vy7CaLr14aLi/SfQszMA0ALBvMao+Fis0iVwFYq/NLgSXw+fgnpFskt8v8iQZ+4Kaal8U8e9sVgu8m0RgO7rzym1eRiIKpsKd1rh/SD7LbSN7M7TRL3QqF7ltw9sQhAAsQcRaBBF21pdWrqhiGZ+Eioo3hhgwNavH2agqz78ddHwrFpHFwrEeUk1OfpPb76MYIce7xIy/4oQNdg6fOq4l/FrajBv+WkzDVPaKm6r7YmwfLN/YMZBHXSR58oOGP9W/n-----END CERTIFICATE-----&quot;</span></div><div><div html="&lt;p&gt;The certificate&amp;#39;s contents.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate&#39;s contents.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="friendly_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">friendly_name</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">friendly_name=TestCert</span></div><div><div html="&lt;p&gt;The certificate&amp;#39;s friendly name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate&#39;s friendly name.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-dpBQxM eJAAZj">Request Body schema: <span class="sc-dhCplO khtVmz">multipart/form-data</span></h5><div html="&lt;p&gt;The certificate&amp;#39;s contents.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>The certificate&#39;s contents.</p>
</div><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="crt" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">crt</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;pem-certificate&gt; </span></div> <div><div html="&lt;p&gt;The certificate file.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate file.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="friendly_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">friendly_name</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The certificate&amp;#39;s friendly name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The certificate&#39;s friendly name.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="post" class="sc-txhaY dCeVuA http-verb post">post</span><span class="sc-etPtWW iqHzp">/SSL/upload_cert</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/upload_cert</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riiv9ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riiv9ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Riiv9ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Riiv9ca:1" data-rttab="true">HTTP Request (Wire Format)</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riiv9ca:0" aria-labelledby="tab:Riiv9ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--input</span><span class="token operator">=</span>json <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  upload_cert
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Riiv9ca:1" aria-labelledby="tab:Riiv9ca:1"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjiv9ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjiv9ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjiv9ca:0" aria-labelledby="tab:Rjiv9ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;upload_cert&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token number">1569844800</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_curve_name"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_public"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"friendly_name"</span>: <span class="token string">&quot;TestCert&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_self_signed"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer.commonName"</span>: <span class="token string">&quot;VeriSign Trial Secure Server CA - G2&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"issuer.organizationName"</span>: <span class="token string">&quot;VeriSign, Inc.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">&quot;rsaEncryption&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">&quot;a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus_length"</span>: <span class="token number">2048</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"not_after"</span>: <span class="token number">1601467200</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"not_before"</span>: <span class="token number">1569844800</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"signature_algorithm"</span>: <span class="token string">&quot;sha256WithRSAEncryption&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"subject.commonName"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"validation_type"</span>: <span class="token string">&quot;dv&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/SSL-Certificate-Management/operation/upload_key" data-section-id="tag/SSL-Certificate-Management/operation/upload_key" class="sc-dntaoT ceciOs"><div data-section-id="operation/upload_key" id="operation/upload_key" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/SSL-Certificate-Management/operation/upload_key" aria-label="tag/SSL-Certificate-Management/operation/upload_key"></a>Import private key </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function uploads a private key.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;Due to the limited field length of HTTP GET method calls, you &lt;strong&gt;must&lt;/strong&gt; use
the HTTP POST method. For this reason, you &lt;strong&gt;cannot&lt;/strong&gt; use a cPanel or Webmail
session URL to call this function.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail,
&lt;strong&gt;and&lt;/strong&gt; Web Server &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;roles&lt;/a&gt;,
the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function uploads a private key.</p>
<p><strong>Note:</strong></p>
<p>Due to the limited field length of HTTP GET method calls, you <strong>must</strong> use
the HTTP POST method. For this reason, you <strong>cannot</strong> use a cPanel or Webmail
session URL to call this function.</p>
<p><strong>Important:</strong></p>
<p>When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail,
<strong>and</strong> Web Server <a href="https://go.cpanel.net/howtouseserverprofiles#roles">roles</a>,
the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="friendly_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">friendly_name</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">friendly_name=TestKey</span></div><div><div html="&lt;p&gt;The key&amp;#39;s friendly name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key&#39;s friendly name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="key" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">key</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;pem-private-key&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">key=&quot;-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAyeiHvMuJuVk8ZEY6wMzUS1g0eWaHaIWmIRe+Qrn6SwiRrm1p\npsJCiGPPPQGOSg4FzrMXqE0zsi/Tk3hUO/EEsi7CcZe8cUanjlUeXhiwrb86FCMF\nOb9siRHQvlss7VCg8ZGXXTWZgf5yD3A1xPwdayYwF2Tc7GkNcZGUAI58geuYaq+U\nGiLczRGZep1IQ0b1cZnqDvGMx6AS6hiDqLISjnmXYY2OhG6Uyp+SuinjYzLPJ6eO\nN/7i9qqbcGmt0ssddmhR897+bTEom5SlSuyi03KZ9Rn4ZmNJgOsup9MclSBGxBys\nb6MuuM3N0/tF5QuwmDc8H6h2rNBP9vGV7RTTXQIDAQABAoIBAFS/WVoRRLmbjxG3\nuKl8UA9f8oaSVnu0vUpeoOl5Dmm4Kw2/tvzbxPlii3Xb1VGYGS/tVBy8atp74J6h\nfxm5zHLN1afAPMR/F41ShPCSBHapMUOKf4MBqhjOdYOw2Way1RsQNSxWdxxtJIr+\nWlNYTzDOUpk/KMvCPHZS2IBzTidpcFpDQ3pyDXjOoKJJH0EQWPtvxJNGrFqmU29D\n9WBqQemHnDrzg3s7JzQ5cGpbbCE+QX8IckNkslAkyhm771CtqWdeo+c45e6YfGcx\nKuAy1zGSVzQBuitzYoMUOL5olXLEj8fHzXd/cZP4yCyyabcGz2vi6luxF+28l1OL\nG1axyLECgYEA+bD5B+Y/Dp5hZ/uVR1bbvyraQpwbDesS1zgnJ53KOIl926dnWzIt\nUvM46+c9IF+UJrtzwIB6IvjAQioNFrK36bHgNGzNf9WQ54NN172qveaFLdW34z/i\nGR2ix/efm9OC41QREQ/5IKV07TibCwVazVBWascMPkH7FnguTvTCiosCgYEAzwJ+\nGPlIWjK+sqkK5JMUyuH43qAvgVfkZV906JpNRQH0Mob3bC0nXN95EoTwWXk68ULT\no1GHv9XLbj8e+Ok7kpJQZT5vEZnDN+cy3jdTLCvcjU5Q3ToImOTp9isSAFWRTbtk\nyabLNoIIsTR/ZwwPFTZcRiK2d8k7ZhcRKdfGnrcCgYAPZ06FoTukoDqsGoYkB4S4\n72DVmSHGIwlfg5ROylouULUV9ubWZmsLYfvR+cr4k0zlcsz6RDLEs4nQyx1RmCbm\nYNXPBiNLTpaI4b3MoGPHIVB3+mZEu60sFXr0UR9kkpDRi18eKVkaHXrwI3zVGjh2\n0Az0u2DS+mkOAs4AivLxbwKBgQC0XPqbLc+Bb0dCCREJmLD8GCkrZ6wcaQUB4krN\nQ2vhnVM0Fu5K3Yi3XapynUuA2aSmgtA9MxMw7MkjlHGa9DPIgBz2KZDCaBN0iMeE\nX/XivZCbucmxBxhohsLmjh5QFj3U2Vp2bBIQuvlx1EjQ8uvNUqDRJvuOoNFVIPH+\nYBeZPwKBgA//kXfNtNMHOpch699i3rgTzbRFDmGwsr1otzvJsXw7Pr2bM4WIzUJy\nG2SUSUlQRSZK4+BBKT9S0d7TynJD6X/6R7IBotZbfXs1myYxEsKj89/BQmr47x2h\nHjYVCClNoJlsbd5C2yu1R3PikweWGoVaxE3c+AN5knqjwJ0g21Cf\n-----END RSA PRIVATE KEY-----&quot;</span></div><div><div html="&lt;p&gt;The key&amp;#39;s contents.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key&#39;s contents.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-dpBQxM eJAAZj">Request Body schema: <span class="sc-dhCplO khtVmz">multipart/form-data</span></h5><div html="&lt;p&gt;The certificate&amp;#39;s contents.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>The certificate&#39;s contents.</p>
</div><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="crt" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">crt</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;pem-private-key&gt; </span></div> <div><div html="&lt;p&gt;The key&amp;#39;s contents.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key&#39;s contents.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="friendly_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">friendly_name</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The key&amp;#39;s friendly name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The key&#39;s friendly name.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="post" class="sc-txhaY dCeVuA http-verb post">post</span><span class="sc-etPtWW iqHzp">/SSL/upload_key</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SSL/upload_key</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rij19ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rij19ca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rij19ca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rij19ca:1" data-rttab="true">HTTP Request (Wire Format)</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rij19ca:0" aria-labelledby="tab:Rij19ca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--input</span><span class="token operator">=</span>json <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SSL <span class="token punctuation">\</span>
  upload_key
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rij19ca:1" aria-labelledby="tab:Rij19ca:1"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjj19ca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj19ca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj19ca:0" aria-labelledby="tab:Rjj19ca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;upload_key&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SSL&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"created"</span>: <span class="token number">1569844800</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_curve_name"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ecdsa_public"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"friendly_name"</span>: <span class="token string">&quot;TestKey&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;bbe7e_16e2d_df7539f280eb1ecf6c1096190e41ada7&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key_algorithm"</span>: <span class="token string">&quot;rsaEncryption&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus"</span>: <span class="token string">&quot;a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"modulus_length"</span>: <span class="token number">2048</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Verify-Domain-Ownership" data-section-id="tag/Verify-Domain-Ownership" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Verify-Domain-Ownership" aria-label="tag/Verify-Domain-Ownership"></a>Verify Domain Ownership</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;SSL Certificates / Verify Domain Ownership&lt;/p&gt;
"><p>SSL Certificates / Verify Domain Ownership</p>
</div></div></div><div id="tag/Verify-Domain-Ownership/operation/check_domains_via_dns" data-section-id="tag/Verify-Domain-Ownership/operation/check_domains_via_dns" class="sc-dntaoT ceciOs"><div data-section-id="operation/check_domains_via_dns" id="operation/check_domains_via_dns" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Verify-Domain-Ownership/operation/check_domains_via_dns" aria-label="tag/Verify-Domain-Ownership/operation/check_domains_via_dns"></a>Verify domain ownership via DNS </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function checks whether the account&amp;#39;s domains can pass Domain Control Validation (DCV) via a DNS request.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether the account&#39;s domains can pass Domain Control Validation (DCV) via a DNS request.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain-0=example.com&amp;domain-1=example2.com</span> - Check multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> - Check a single domain.</li></ul><div><div html="&lt;p&gt;The domain or domains to check.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; To check multiple domains, increment the parameter name. For example, &lt;code&gt;domain-0&lt;/code&gt;, &lt;code&gt;domain-1&lt;/code&gt;, and &lt;code&gt;domain-2&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain or domains to check.</p>
<p><strong>Note:</strong></p>
<p> To check multiple domains, increment the parameter name. For example, <code>domain-0</code>, <code>domain-1</code>, and <code>domain-2</code>.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="post" class="sc-txhaY dCeVuA http-verb post">post</span><span class="sc-etPtWW iqHzp">/DCV/check_domains_via_dns</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DCV/check_domains_via_dns</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2abbca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abbca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abbca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abbca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2abbca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abbca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2abbca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abbca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abbca:0" aria-labelledby="tab:R2abbca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DCV <span class="token punctuation">\</span>
  check_domains_via_dns <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abbca:1" aria-labelledby="tab:R2abbca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abbca:2" aria-labelledby="tab:R2abbca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abbca:3" aria-labelledby="tab:R2abbca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ebbca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebbca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebbca:0" aria-labelledby="tab:R2ebbca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;check_domains_via_dns&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DCV&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dcv_string"</span>: <span class="token string">&quot;_dcv-test-record=wsWRlG9IsG7KNnLdIsx9Oz2oTw8m5q0imRR9L6LnDBz14sZelvDHqrJyJc6LA0DY&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"failure_reason"</span>: <span class="token string">&quot;The DNS query to _dcv-test-record.example2.org for the DCV challenge returned no TXT record that matches the value _dcv-test-record=wRUFPTN1DskKDG8KHfYM_5cQF5QUGWq1_A2ovO8rKsrIYO_HilAjsQABFCrbJkLX.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"query_results"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;_dcv-test-record=wsWRlG9IsG7KNnLdIsx9Oz2oTw8m5q0imRR9L6LnDBz14sZelvDHqrJyJc6LA0DY&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"succeeded"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"zone"</span>: <span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Verify-Domain-Ownership/operation/check_domains_via_http" data-section-id="tag/Verify-Domain-Ownership/operation/check_domains_via_http" class="sc-dntaoT ceciOs"><div data-section-id="operation/check_domains_via_http" id="operation/check_domains_via_http" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Verify-Domain-Ownership/operation/check_domains_via_http" aria-label="tag/Verify-Domain-Ownership/operation/check_domains_via_http"></a>Verify domain ownership via HTTP </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function checks whether the account&amp;#39;s domains can pass Domain Control Validation (DCV) via an HTTP request.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether the account&#39;s domains can pass Domain Control Validation (DCV) via an HTTP request.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="dcv_file_allowed_characters" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">dcv_file_allowed_characters</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">strings</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;A&amp;dcv_file_allowed_characters=B&amp;dcv_file_allowed_characters=C&amp;dcv_file_allowed_characters=D&amp;dcv_file_allowed_characters=E&amp;dcv_file_allowed_characters=F&amp;dcv_file_allowed_characters=G&amp;dcv_file_allowed_characters=H&amp;dcv_file_allowed_characters=I&amp;dcv_file_allowed_characters=J&amp;dcv_file_allowed_characters=K&amp;dcv_file_allowed_characters=L&amp;dcv_file_allowed_characters=M&amp;dcv_file_allowed_characters=N&amp;dcv_file_allowed_characters=O&amp;dcv_file_allowed_characters=P&amp;dcv_file_allowed_characters=Q&amp;dcv_file_allowed_characters=R&amp;dcv_file_allowed_characters=S&amp;dcv_file_allowed_characters=T&amp;dcv_file_allowed_characters=U&amp;dcv_file_allowed_characters=V&amp;dcv_file_allowed_characters=W&amp;dcv_file_allowed_characters=X&amp;dcv_file_allowed_characters=Y&amp;dcv_file_allowed_characters=Z&amp;dcv_file_allowed_characters=0&amp;dcv_file_allowed_characters=1&amp;dcv_file_allowed_characters=2&amp;dcv_file_allowed_characters=3&amp;dcv_file_allowed_characters=4&amp;dcv_file_allowed_characters=5&amp;dcv_file_allowed_characters=6&amp;dcv_file_allowed_characters=7&amp;dcv_file_allowed_characters=8&amp;dcv_file_allowed_characters=9&quot;</span></div> <div><div html="&lt;p&gt;An array of characters that the certificate provider allows in the DCV check file&amp;#39;s filename.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>An array of characters that the certificate provider allows in the DCV check file&#39;s filename.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="dcv_file_extension" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">dcv_file_extension</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;&quot;</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">dcv_file_extension=txt</span></div><div><div html="&lt;p&gt;The DCV check file extension that the certificate provider requires.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The DCV check file extension that the certificate provider requires.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="dcv_file_random_character_count" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">dcv_file_random_character_count</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= 1 </span></span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">100</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">dcv_file_random_character_count=32</span></div><div><div html="&lt;p&gt;The number of characters that the certificate provider allows in the DCV check file&amp;#39;s filename.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The number of characters that the certificate provider allows in the DCV check file&#39;s filename.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="dcv_file_relative_path" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">dcv_file_relative_path</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;.well-known/pki-validation&quot;</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">dcv_file_relative_path=.well-known/pki-validation</span></div><div><div html="&lt;p&gt;The DCV check file&amp;#39;s file path, relative to the domain&amp;#39;s document &lt;code&gt;root&lt;/code&gt; directory.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The DCV check file&#39;s file path, relative to the domain&#39;s document <code>root</code> directory.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="dcv_max_redirects" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">dcv_max_redirects</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer or null</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= 0 </span></span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">null</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">dcv_max_redirects=2</span></div><div><div html="&lt;p&gt;The number of domain redirects the system permits the DCV check to follow. The function checks the provider&amp;#39;s supported number of redirects.
It will then return the &lt;code&gt;redirect&lt;/code&gt; array of objects for the passed value, plus one. This ensures the function will display any redirects causing DCV failures, if any exist.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;If you pass a &lt;code&gt;0&lt;/code&gt; value, this function does &lt;strong&gt;not&lt;/strong&gt; limit the number of redirect returns.&lt;/li&gt;
&lt;li&gt;Use the &lt;code&gt;Market::get_provider_specific_dcv_constraints&lt;/code&gt; UAPI function to list a provider&amp;#39;s supported number of redirects.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The number of domain redirects the system permits the DCV check to follow. The function checks the provider&#39;s supported number of redirects.
It will then return the <code>redirect</code> array of objects for the passed value, plus one. This ensures the function will display any redirects causing DCV failures, if any exist.</p>
<p><strong>Note:</strong></p>
<ul>
<li>If you pass a <code>0</code> value, this function does <strong>not</strong> limit the number of redirect returns.</li>
<li>Use the <code>Market::get_provider_specific_dcv_constraints</code> UAPI function to list a provider&#39;s supported number of redirects.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="dcv_user_agent_string" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">dcv_user_agent_string</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">dcv_user_agent_string=SECTIGO+DCV</span></div><div><div html="&lt;p&gt;The &lt;a href=&quot;https://wikipedia.org/wiki/User_agent&quot;&gt;user agent string&lt;/a&gt; that the system uses for the imitated local DCV check.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;The default value can change at any time.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The <a href="https://wikipedia.org/wiki/User_agent">user agent string</a> that the system uses for the imitated local DCV check.</p>
<p><strong>Important:</strong></p>
<p>The default value can change at any time.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain-1=example.com&amp;domain-2=example2.com&amp;domain-3=example2.com</span> - Check multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> - Check a single domain.</li></ul><div><div html="&lt;p&gt;The domains to check.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;To check more than one domain, repeat or increment the parameter name. For
example, &lt;code&gt;domain-1&lt;/code&gt;, &lt;code&gt;domain-2&lt;/code&gt;, and &lt;code&gt;domain-3&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domains to check.</p>
<p><strong>Note:</strong></p>
<p>To check more than one domain, repeat or increment the parameter name. For
example, <code>domain-1</code>, <code>domain-2</code>, and <code>domain-3</code>.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DCV/check_domains_via_http</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DCV/check_domains_via_http</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2adbca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2adbca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2adbca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adbca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2adbca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adbca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2adbca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2adbca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2adbca:0" aria-labelledby="tab:R2adbca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DCV <span class="token punctuation">\</span>
  check_domains_via_http <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adbca:1" aria-labelledby="tab:R2adbca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adbca:2" aria-labelledby="tab:R2adbca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2adbca:3" aria-labelledby="tab:R2adbca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2edbca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2edbca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2edbca:0" aria-labelledby="tab:R2edbca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;check_domains_via_http&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DCV&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"failure_reason"</span>: <span class="token string">&quot;The system queried for a temporary file at http://example.com/.well-known/pki-validationD01511F4E E535A5442FC378AA946CF41.txt, but the web server responded with the following error: 404 (Not Found). A DNS (Domain Name System) or web server misconfiguration may exist. The domain example.com resolved to an IP address 93.184.216.34 that does not exist on this server.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"redirects"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"content"</span>: <span class="token string">&quot;&lt;!DOCTYPE HTML PUBLIC \\\&quot;-//IETF//DTD HTML 2.0//EN\\\&quot;&gt;\\n&lt;html&gt;&lt;head&gt;\\n&lt;title&gt;301 Moved Permanently&lt;/title&gt;\\n &lt;/head&gt;&lt;body&gt;\\n&lt;h1&gt;Moved Permanently&lt;/h1&gt;\\n &lt;p&gt;The document has moved &lt;a href=\\\&quot;http://www.example.com/.well-known/pki-validation/770102 17B0CCF0CCF6211602F9A1B2B2.txt\\\&quot;&gt;here&lt;/a&gt;.&lt;/p&gt;\\n&lt;/body&gt;&lt;/html&gt;\\n&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"headers"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"protocol"</span>: <span class="token string">&quot;HTTP/1.1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reason"</span>: <span class="token string">&quot;Moved Permanently&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"redirects"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">301</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"success"</span>: <span class="token string">&quot;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">&quot;</span><a href="http://example.com/.well-known/pki-validation/77010217B0CCF0CCF6211602F9A1B2B2.txt">http://example.com/.well-known/pki-validation/77010217B0CCF0CCF6211602F9A1B2B2.txt</a><span class="token string">&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"redirects_count"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Verify-Domain-Ownership/operation/ensure_domains_can_pass_dcv" data-section-id="tag/Verify-Domain-Ownership/operation/ensure_domains_can_pass_dcv" class="sc-dntaoT ceciOs"><div data-section-id="operation/ensure_domains_can_pass_dcv" id="operation/ensure_domains_can_pass_dcv" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Verify-Domain-Ownership/operation/ensure_domains_can_pass_dcv" aria-label="tag/Verify-Domain-Ownership/operation/ensure_domains_can_pass_dcv"></a>Verify domain ownership <span type="warning" class="sc-jtQUzJ jmDXKf"> Deprecated </span></h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function indicates whether the account&amp;#39;s domains can pass a Domain Control
Validation (DCV) check.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;We deprecated this function. Use UAPI&amp;#39;s &lt;code&gt;DCV::check_domains_via_http&lt;/code&gt; function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function indicates whether the account&#39;s domains can pass a Domain Control
Validation (DCV) check.</p>
<p><strong>Warning:</strong></p>
<p>We deprecated this function. Use UAPI&#39;s <code>DCV::check_domains_via_http</code> function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain-1=example1.com domain-2=example2.com domain-3=example3.com</span> - Check multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=domain=example1.com domain=example2.com domain=example3.com</span> - Check multiple domains.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span> - Check a single domain.</li></ul><div><div html="&lt;p&gt;The domains to check.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; To check multiple domains, duplicate or increment the parameter name. For example,
 &lt;code&gt;domain-1&lt;/code&gt;, &lt;code&gt;domain-2&lt;/code&gt;, and &lt;code&gt;domain-3&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domains to check.</p>
<p><strong>Note:</strong></p>
<p> To check multiple domains, duplicate or increment the parameter name. For example,
 <code>domain-1</code>, <code>domain-2</code>, and <code>domain-3</code>.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/DCV/ensure_domains_can_pass_dcv</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/DCV/ensure_domains_can_pass_dcv</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2afbca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2afbca:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2afbca:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2afbca:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2afbca:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2afbca:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2afbca:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2afbca:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2afbca:0" aria-labelledby="tab:R2afbca:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  DCV <span class="token punctuation">\</span>
  ensure_domains_can_pass_dcv <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2afbca:1" aria-labelledby="tab:R2afbca:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2afbca:2" aria-labelledby="tab:R2afbca:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2afbca:3" aria-labelledby="tab:R2afbca:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2efbca:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2efbca:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2efbca:0" aria-labelledby="tab:R2efbca:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;ensure_domains_can_pass_dcv&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;DCV&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token keyword">null</span>,</div></li><li><div class="hoverable "><span class="token keyword">null</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;The domain resolves to Mars. Beep beep beep.&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Domain-Statistics" data-section-id="tag/Domain-Statistics" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Statistics" aria-label="tag/Domain-Statistics"></a>Domain Statistics</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Statistics / Domain Statistics&lt;/p&gt;
"><p>Statistics / Domain Statistics</p>
</div></div></div><div id="tag/Domain-Statistics/operation/get_site_errors" data-section-id="tag/Domain-Statistics/operation/get_site_errors" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_site_errors" id="operation/get_site_errors" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Statistics/operation/get_site_errors" aria-label="tag/Domain-Statistics/operation/get_site_errors"></a>Return specified domain access log </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns entries from a domain&amp;#39;s error log.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns entries from a domain&#39;s error log.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The domain for which to return error log entries.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain for which to return error log entries.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="log" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">log</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;error&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;suexec&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">log=suexec</span></div><div><div html="&lt;p&gt;The &lt;a href=&quot;https://go.cpanel.net/cpanellogfiles&quot;&gt;Apache log file&lt;/a&gt; to query.
This parameter defaults to error.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;error&lt;/code&gt; - The &lt;code&gt;/var/log/apache2/error_log&lt;/code&gt; file.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;suexec&lt;/code&gt; - The &lt;code&gt;/var/log/apache2/suexec_log&lt;/code&gt; file.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The <a href="https://go.cpanel.net/cpanellogfiles">Apache log file</a> to query.
This parameter defaults to error.</p>
<ul>
<li><code>error</code> - The <code>/var/log/apache2/error_log</code> file.</li>
<li><code>suexec</code> - The <code>/var/log/apache2/suexec_log</code> file.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="maxlines" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">maxlines</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> [ 1 .. 5000 ] </span></span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">300</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">maxlines=250</span></div><div><div html="&lt;p&gt;The number of lines to retrieve from the error log.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The number of lines to retrieve from the error log.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Stats/get_site_errors</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Stats/get_site_errors</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2a9jcq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2a9jcq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2a9jcq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9jcq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2a9jcq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9jcq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2a9jcq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2a9jcq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2a9jcq:0" aria-labelledby="tab:R2a9jcq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Stats <span class="token punctuation">\</span>
  get_site_errors <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9jcq:1" aria-labelledby="tab:R2a9jcq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9jcq:2" aria-labelledby="tab:R2a9jcq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2a9jcq:3" aria-labelledby="tab:R2a9jcq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2e9jcq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2e9jcq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2e9jcq:0" aria-labelledby="tab:R2e9jcq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_site_errors&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Stats&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"date"</span>: <span class="token number">1234576704</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"entry"</span>: <span class="token string">&quot;[Fri Feb 13 19:58:24.420593 2009] [core:error] [pid 29228:tid 47876185720577] (13)Permission denied: [client 10.0.0.2:62908] AH00132: file permissions deny server access: /home/user/public_html/index.html&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Domain-Statistics/operation/get_bandwidth" data-section-id="tag/Domain-Statistics/operation/get_bandwidth" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_bandwidth" id="operation/get_bandwidth" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Statistics/operation/get_bandwidth" aria-label="tag/Domain-Statistics/operation/get_bandwidth"></a>Return bandwidth statistics for all domains </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves a list of bandwidth records for the domains on a cPanel account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This function also returns the bandwidth use of a &lt;a href=&quot;https://docs.cpanel.net/knowledge-base/cpanel-product/cpanel-glossary#distributed-cpanel-account&quot;&gt;distributed cPanel account&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This function requires the &lt;em&gt;Bandwidth Stats&lt;/em&gt; feature. To enable this feature, use WHM&amp;#39;s &lt;a href=&quot;https://go.cpanel.net/whmdocsFeatureManager&quot;&gt;&lt;em&gt;Feature Manager&lt;/em&gt;&lt;/a&gt;
interface (&lt;em&gt;WHM &amp;gt;&amp;gt; Home &amp;gt;&amp;gt; Packages &amp;gt;&amp;gt; Feature Manager&lt;/em&gt;).&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a list of bandwidth records for the domains on a cPanel account.</p>
<p><strong>Note:</strong></p>
<p>This function also returns the bandwidth use of a <a href="https://docs.cpanel.net/knowledge-base/cpanel-product/cpanel-glossary#distributed-cpanel-account">distributed cPanel account</a>.</p>
<p><strong>Warning:</strong></p>
<p>This function requires the <em>Bandwidth Stats</em> feature. To enable this feature, use WHM&#39;s <a href="https://go.cpanel.net/whmdocsFeatureManager"><em>Feature Manager</em></a>
interface (<em>WHM &gt;&gt; Home &gt;&gt; Packages &gt;&gt; Feature Manager</em>).</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="timezone" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">timezone</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">timezone=America/Chicago</span></div><div><div html="&lt;p&gt;The timezone in which to report the data, in &lt;a href=&quot;https://en.wikipedia.org/wiki/List_of_tz_database_time_zones&quot;&gt;Olson tz format&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;This parameter defaults to the server&amp;#39;s timezone.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The timezone in which to report the data, in <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">Olson tz format</a>.</p>
<p><strong>Note:</strong></p>
<p>This parameter defaults to the server&#39;s timezone.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Stats/get_bandwidth</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Stats/get_bandwidth</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2aajcq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2aajcq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2aajcq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aajcq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2aajcq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aajcq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2aajcq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2aajcq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2aajcq:0" aria-labelledby="tab:R2aajcq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Stats <span class="token punctuation">\</span>
  get_bandwidth
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aajcq:1" aria-labelledby="tab:R2aajcq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aajcq:2" aria-labelledby="tab:R2aajcq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2aajcq:3" aria-labelledby="tab:R2aajcq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eajcq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eajcq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eajcq:0" aria-labelledby="tab:R2eajcq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_bandwidth&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Stats&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"bytes"</span>: <span class="token number">74845</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"month_start"</span>: <span class="token number">1561957200</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"protocol"</span>: <span class="token string">&quot;imap&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Domain-Statistics/operation/list_sites" data-section-id="tag/Domain-Statistics/operation/list_sites" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_sites" id="operation/list_sites" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Statistics/operation/list_sites" aria-label="tag/Domain-Statistics/operation/list_sites"></a>Return Analog statistics for all domains </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function displays the Analog statistics for the domains on a cPanel account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function displays the Analog statistics for the domains on a cPanel account.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="engine" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">engine</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;webalizer&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;analog&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">engine=webalizer</span></div><div><div html="&lt;p&gt;The statistics engine.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;webalizer&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;analog&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The statistics engine.</p>
<ul>
<li><code>webalizer</code></li>
<li><code>analog</code></li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="traffic" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">traffic</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;http&quot;</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;http&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;ftp&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">traffic=http</span></div><div><div html="&lt;p&gt;The web traffic type.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;http&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;ftp&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The web traffic type.</p>
<ul>
<li><code>http</code></li>
<li><code>ftp</code></li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Stats/list_sites</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Stats/list_sites</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2abjcq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abjcq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abjcq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abjcq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2abjcq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abjcq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2abjcq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abjcq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abjcq:0" aria-labelledby="tab:R2abjcq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Stats <span class="token punctuation">\</span>
  list_sites <span class="token punctuation">\</span>
  <span class="token assign-left variable">engine</span><span class="token operator">=</span><span class="token string">'webalizer'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abjcq:1" aria-labelledby="tab:R2abjcq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abjcq:2" aria-labelledby="tab:R2abjcq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abjcq:3" aria-labelledby="tab:R2abjcq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ebjcq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebjcq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebjcq:0" aria-labelledby="tab:R2ebjcq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_sites&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Stats&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"all_domains"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/tmp/user/webalizer/index.html&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ssl"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Domain-Statistics/operation/list_stats_by_domain" data-section-id="tag/Domain-Statistics/operation/list_stats_by_domain" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_stats_by_domain" id="operation/list_stats_by_domain" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Domain-Statistics/operation/list_stats_by_domain" aria-label="tag/Domain-Statistics/operation/list_stats_by_domain"></a>Return Analog statistics for specified domain </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns a domain&amp;#39;s Analog statistics.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns a domain&#39;s Analog statistics.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The domain from which to retrieve statistics.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain from which to retrieve statistics.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="engine" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">engine</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Value:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;analog&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">engine=analog</span></div><div><div html="&lt;p&gt;The statistics engine. &lt;code&gt;analog&lt;/code&gt; is the only possible value.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The statistics engine. <code>analog</code> is the only possible value.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="ssl" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">ssl</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">ssl=1</span></div><div><div html="&lt;p&gt;Whether to return statistics from SSL requests.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Return statistics for SSL requests.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Return statistics for non-SSL requests.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to return statistics from SSL requests.</p>
<ul>
<li><code>1</code> - Return statistics for SSL requests.</li>
<li><code>0</code> - Return statistics for non-SSL requests.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Stats/list_stats_by_domain</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Stats/list_stats_by_domain</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2acjcq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2acjcq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2acjcq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acjcq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2acjcq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acjcq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2acjcq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2acjcq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2acjcq:0" aria-labelledby="tab:R2acjcq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Stats <span class="token punctuation">\</span>
  list_stats_by_domain <span class="token punctuation">\</span>
  <span class="token assign-left variable">engine</span><span class="token operator">=</span><span class="token string">'analog'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acjcq:1" aria-labelledby="tab:R2acjcq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acjcq:2" aria-labelledby="tab:R2acjcq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2acjcq:3" aria-labelledby="tab:R2acjcq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ecjcq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ecjcq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ecjcq:0" aria-labelledby="tab:R2ecjcq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_stats_by_domain&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Stats&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"date"</span>: <span class="token number">1565795929</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">&quot;tmp/cptest/analog/8.html.com&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Weblog-Settings" data-section-id="tag/Weblog-Settings" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Weblog-Settings" aria-label="tag/Weblog-Settings"></a>Weblog Settings</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Statistics / Weblog Settings&lt;/p&gt;
"><p>Statistics / Weblog Settings</p>
</div></div></div><div id="tag/Weblog-Settings/operation/stats_manager_get_configuration" data-section-id="tag/Weblog-Settings/operation/stats_manager_get_configuration" class="sc-dntaoT ceciOs"><div data-section-id="operation/stats_manager_get_configuration" id="operation/stats_manager_get_configuration" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Weblog-Settings/operation/stats_manager_get_configuration" aria-label="tag/Weblog-Settings/operation/stats_manager_get_configuration"></a>Returns weblog analyzers&#x27; configuration </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the configuration of the web log anayzers for each domain on the cPanel account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the WebServer role the system disables this function. For more information, read our How to Use &lt;a href=&quot;https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/&quot;&gt;Server Profiles documentation&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;Additional web log analyzer configuration such as if the user can edit their own configuration is provided in the metadata section of the return.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the configuration of the web log anayzers for each domain on the cPanel account.</p>
<p><strong>Important:</strong></p>
<p>When you disable the WebServer role the system disables this function. For more information, read our How to Use <a href="https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/">Server Profiles documentation</a>.</p>
<p><strong>Note</strong></p>
<p>Additional web log analyzer configuration such as if the user can edit their own configuration is provided in the metadata section of the return.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/StatsManager/get_configuration</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/StatsManager/get_configuration</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R155lcq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R155lcq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R155lcq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R155lcq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R155lcq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R155lcq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R155lcq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R155lcq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R155lcq:0" aria-labelledby="tab:R155lcq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  StatsManager <span class="token punctuation">\</span>
  get_configuration
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155lcq:1" aria-labelledby="tab:R155lcq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155lcq:2" aria-labelledby="tab:R155lcq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R155lcq:3" aria-labelledby="tab:R155lcq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R175lcq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R175lcq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R175lcq:0" aria-labelledby="tab:R175lcq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_configuration&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;StatsManager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"analyzers"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled_by_user"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;awstats&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled_by_user"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;analog&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled_by_user"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;webalizer&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;domain.com&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"analyzers"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"available_for_user"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled_by_default"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;analog&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"available_for_user"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled_by_default"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;awstats&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"available_for_user"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled_by_default"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;webalizer&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"locked"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Weblog-Settings/operation/stats_manager_save_configuration" data-section-id="tag/Weblog-Settings/operation/stats_manager_save_configuration" class="sc-dntaoT ceciOs"><div data-section-id="operation/stats_manager_save_configuration" id="operation/stats_manager_save_configuration" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Weblog-Settings/operation/stats_manager_save_configuration" aria-label="tag/Weblog-Settings/operation/stats_manager_save_configuration"></a>Save current user&#x27;s weblog analyzers configuration </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function saves the users choice about which web log anayzers are enabled for each domain on their cPanel users account.
If the log anayzers are controlled by the reseller or root account, the user cannot manage which log analyzers are enabled or disabled.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the WebServer role the system disables this function. For more information, read our How to Use Server Profiles documentation.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function saves the users choice about which web log anayzers are enabled for each domain on their cPanel users account.
If the log anayzers are controlled by the reseller or root account, the user cannot manage which log analyzers are enabled or disabled.</p>
<p><strong>Important:</strong></p>
<p>When you disable the WebServer role the system disables this function. For more information, read our How to Use Server Profiles documentation.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><h5 class="sc-dpBQxM eJAAZj">Request Body schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><div html="&lt;p&gt;List of domains and what web log analyzers to change.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>List of domains and what web log analyzers to change.</p>
</div><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="changes" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand changes"><span class="property-name">changes</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">objects</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="post" class="sc-txhaY dCeVuA http-verb post">post</span><span class="sc-etPtWW iqHzp">/StatsManager/save_configuration</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/StatsManager/save_configuration</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R156lcq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R156lcq:0" tabindex="0" data-rttab="true">Payload</li><li class="react-tabs__tab" role="tab" id="tab:R156lcq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R156lcq:1" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R156lcq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R156lcq:2" data-rttab="true">HTTP Request (Wire Format)</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R156lcq:0" aria-labelledby="tab:R156lcq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"changes"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"analyzers"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;awstats&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;analog&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;webalizer&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;domain.com&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R156lcq:1" aria-labelledby="tab:R156lcq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R156lcq:2" aria-labelledby="tab:R156lcq:2"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R176lcq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R176lcq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R176lcq:0" aria-labelledby="tab:R176lcq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;save_configuration&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;StatsManager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"analyzers"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"locked"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;awstats&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"available"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"locked"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;analog&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"available"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"locked"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;webalizer&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;user&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/EA4" data-section-id="tag/EA4" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/EA4" aria-label="tag/EA4"></a>EA4</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;The EA4 module for UAPI.&lt;/p&gt;
"><p>The EA4 module for UAPI.</p>
</div></div></div><div id="tag/EA4/operation/get_recommendations" data-section-id="tag/EA4/operation/get_recommendations" class="sc-dntaoT ceciOs"><div data-section-id="operation/get_recommendations" id="operation/get_recommendations" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/EA4/operation/get_recommendations" aria-label="tag/EA4/operation/get_recommendations"></a>Get EA4 configuration recommendations </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves a list of EasyApache 4 (EA4) configuration recommendations.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves a list of EasyApache 4 (EA4) configuration recommendations.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/get_recommendations</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/get_recommendations</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rijjda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rijjda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rijjda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijjda:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rijjda:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijjda:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rijjda:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijjda:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rijjda:0" aria-labelledby="tab:Rijjda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  EA4 <span class="token punctuation">\</span>
  get_recommendations
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijjda:1" aria-labelledby="tab:Rijjda:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijjda:2" aria-labelledby="tab:Rijjda:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijjda:3" aria-labelledby="tab:Rijjda:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjjjda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjjjda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjjjda:0" aria-labelledby="tab:Rjjjda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_recommendations&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;EA4&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"ea-php55-php"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"desc"</span>: <span class="token string">&quot;PHP DSO runs as the user [asis,nobody] by default. In a shared hosting environment, this is a security issue.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"level"</span>: <span class="token string">&quot;danger&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;PHP DSO&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"on"</span>: <span class="token string">&quot;add&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"options"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"items"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;ea-apache24-mod_ruid2&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;ea-apache24-mod_mpm_itk&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"level"</span>: <span class="token string">&quot;success&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"recommended"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"text"</span>: <span class="token string">&quot;We strongly recommend that you install one of the following packages unless this is a single-user system:&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"level"</span>: <span class="token string">&quot;warning&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"recommended"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"text"</span>: <span class="token string">&quot;If you use suPHP, you will add some security, but may experience performance issues on your server.&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">&quot;</span><a href="https://www.example.com">https://www.example.com</a><span class="token string">&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/EasyApache-Settings" data-section-id="tag/EasyApache-Settings" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/EasyApache-Settings" aria-label="tag/EasyApache-Settings"></a>EasyApache Settings</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Web Server Configuration / EasyApache Settings&lt;/p&gt;
"><p>Web Server Configuration / EasyApache Settings</p>
</div></div></div><div id="tag/PHP" data-section-id="tag/PHP" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PHP" aria-label="tag/PHP"></a>PHP</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;PHP recommendations&lt;/p&gt;
"><p>PHP recommendations</p>
</div></div></div><div id="tag/PHP/operation/EA4::get_php_recommendations" data-section-id="tag/PHP/operation/EA4::get_php_recommendations" class="sc-dntaoT ceciOs"><div data-section-id="operation/EA4::get_php_recommendations" id="operation/EA4::get_php_recommendations" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PHP/operation/EA4::get_php_recommendations" aria-label="tag/PHP/operation/EA4::get_php_recommendations"></a>Get custom PHP recommendations. </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns a list of recommended PHP versions.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns a list of recommended PHP versions.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/get_php_recommendations</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/get_php_recommendations</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rijnda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rijnda:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:Rijnda:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijnda:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:Rijnda:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijnda:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:Rijnda:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rijnda:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rijnda:0" aria-labelledby="tab:Rijnda:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  EA4 <span class="token punctuation">\</span>
  get_php_recommendations
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijnda:1" aria-labelledby="tab:Rijnda:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijnda:2" aria-labelledby="tab:Rijnda:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rijnda:3" aria-labelledby="tab:Rijnda:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjjnda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjjnda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjjnda:0" aria-labelledby="tab:Rjjnda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_php_recommendations&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;EA4&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;php80&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Application-Manager" data-section-id="tag/Application-Manager" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Application-Manager" aria-label="tag/Application-Manager"></a>Application Manager</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Web Server Management / Application Manager&lt;/p&gt;
"><p>Web Server Management / Application Manager</p>
</div></div></div><div id="tag/Application-Manager/operation/edit_application" data-section-id="tag/Application-Manager/operation/edit_application" class="sc-dntaoT ceciOs"><div data-section-id="operation/edit_application" id="operation/edit_application" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Application-Manager/operation/edit_application" aria-label="tag/Application-Manager/operation/edit_application"></a>Update Passenger application settings </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function edits a Passenger application for an account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note&lt;/strong&gt;:&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Web Server role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function edits a Passenger application for an account.</p>
<p><strong>Note</strong>:</p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">Web Server role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="clear_envvars" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">clear_envvars</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">clear_envvars=0</span></div><div><div html="&lt;p&gt;Whether to clear the application’s environment variables.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to clear the application’s environment variables.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="deployment_mode" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">deployment_mode</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;production&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;development&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">deployment_mode=production</span></div><div><div html="&lt;p&gt;The new server environment in which to run the application. If you do not use this parameter, the function does not change the application’s server environment.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;development&lt;/code&gt; — Sets the application to run in a development environment.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;production&lt;/code&gt; — Sets the application to run in a production environment.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The new server environment in which to run the application. If you do not use this parameter, the function does not change the application’s server environment.</p>
<ul>
<li><code>development</code> — Sets the application to run in a development environment.</li>
<li><code>production</code> — Sets the application to run in a production environment.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=toto.com</span></div><div><div html="&lt;p&gt;The application’s new domain. If you do not use this parameter, the function does not change the application’s domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The application’s new domain. If you do not use this parameter, the function does not change the application’s domain.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="enabled" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">enabled</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">enabled=1</span></div><div><div html="&lt;p&gt;Whether to enable the application and generate the web server configuration for it.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Enable the application and generate the web server configuration.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Don’t enable the application and generate the web server configuration.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to enable the application and generate the web server configuration for it.</p>
<ul>
<li><code>1</code> — Enable the application and generate the web server configuration.</li>
<li><code>0</code> — Don’t enable the application and generate the web server configuration.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="envvar_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">envvar_name</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">strings</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">envvar_name=SCARECROW&amp;envvar_name=TINMAN&amp;envvar_name=LION</span></div><div><div html="&lt;p&gt;New set of environment variables for the application.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important&lt;/strong&gt;:&lt;/p&gt;
&lt;p&gt; The function replaces all current environment variables with the variables that you pass in this parameter.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note&lt;/strong&gt;:&lt;/p&gt;
&lt;p&gt;  For each &lt;code&gt;envvar_name&lt;/code&gt; parameter you send you &lt;strong&gt;must&lt;/strong&gt; include an &lt;code&gt;envvar_value&lt;/code&gt; parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>New set of environment variables for the application.</p>
<p><strong>Important</strong>:</p>
<p> The function replaces all current environment variables with the variables that you pass in this parameter.</p>
<p><strong>Note</strong>:</p>
<p>  For each <code>envvar_name</code> parameter you send you <strong>must</strong> include an <code>envvar_value</code> parameter.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="envvar_value" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">envvar_value</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">strings</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> [ 1 .. 1024 ] characters </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">envvar_value=brain&amp;envvar_value=heart&amp;envvar_value=courage</span></div><div><div html="&lt;p&gt;Each environment variable’s value.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note&lt;/strong&gt;:&lt;/p&gt;
&lt;p&gt;  For each &lt;code&gt;envvar_name&lt;/code&gt; parameter you send you &lt;strong&gt;must&lt;/strong&gt; include an &lt;code&gt;envvar_value&lt;/code&gt; parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Each environment variable’s value.</p>
<p><strong>Note</strong>:</p>
<p>  For each <code>envvar_name</code> parameter you send you <strong>must</strong> include an <code>envvar_value</code> parameter.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">name</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=Ruby Slippers</span></div><div><div html="&lt;p&gt;The application’s current name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The application’s current name.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="new_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">new_name</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">new_name=Little Dog</span></div><div><div html="&lt;p&gt;The application’s new name. If you do not use this parameter, the function does not change the application&amp;#39;s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The application’s new name. If you do not use this parameter, the function does not change the application&#39;s name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="path" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">path</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">path=/home/dorothy/littledog</span></div><div><div html="&lt;p&gt;The application’s new filepath. If you do not use this parameter, the function does not change the application’s filepath.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The application’s new filepath. If you do not use this parameter, the function does not change the application’s filepath.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/PassengerApps/edit_application</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/PassengerApps/edit_application</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kj3dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kj3dq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kj3dq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj3dq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kj3dq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj3dq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kj3dq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj3dq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kj3dq:0" aria-labelledby="tab:R4kj3dq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  PassengerApps <span class="token punctuation">\</span>
  edit_application <span class="token punctuation">\</span>
  <span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'Ruby Slippers'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj3dq:1" aria-labelledby="tab:R4kj3dq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj3dq:2" aria-labelledby="tab:R4kj3dq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj3dq:3" aria-labelledby="tab:R4kj3dq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sj3dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sj3dq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sj3dq:0" aria-labelledby="tab:R4sj3dq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"Little Dog"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"base_uri"</span>: <span class="token string">&quot;/littledog&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deployment_mode"</span>: <span class="token string">&quot;production&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;toto.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"envvars"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"LION"</span>: <span class="token string">&quot;courage&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"SCARECROW"</span>: <span class="token string">&quot;brain&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"TINMAN"</span>: <span class="token string">&quot;heart&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;Little Dog&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/home/dorothy/littledog&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Application-Manager/operation/disable_application" data-section-id="tag/Application-Manager/operation/disable_application" class="sc-dntaoT ceciOs"><div data-section-id="operation/disable_application" id="operation/disable_application" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Application-Manager/operation/disable_application" aria-label="tag/Application-Manager/operation/disable_application"></a>Disable Passenger application </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function disables a Passenger application on an account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles#roles&quot;&gt;Web Server role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables a Passenger application on an account.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles#roles">Web Server role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">name</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=slippers</span></div><div><div html="&lt;p&gt;The application to disable.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The application to disable.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/PassengerApps/disable_application</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/PassengerApps/disable_application</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kl3dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kl3dq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kl3dq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl3dq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kl3dq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl3dq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kl3dq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl3dq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kl3dq:0" aria-labelledby="tab:R4kl3dq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  PassengerApps <span class="token punctuation">\</span>
  disable_application <span class="token punctuation">\</span>
  <span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'slippers'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl3dq:1" aria-labelledby="tab:R4kl3dq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl3dq:2" aria-labelledby="tab:R4kl3dq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl3dq:3" aria-labelledby="tab:R4kl3dq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sl3dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sl3dq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sl3dq:0" aria-labelledby="tab:R4sl3dq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;disable_application&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;PassengerApps&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Application-Manager/operation/enable_application" data-section-id="tag/Application-Manager/operation/enable_application" class="sc-dntaoT ceciOs"><div data-section-id="operation/enable_application" id="operation/enable_application" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Application-Manager/operation/enable_application" aria-label="tag/Application-Manager/operation/enable_application"></a>Enable Passenger application </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function enables a Passenger application and generates the Apache configuration on an account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;Web Server role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function. &lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables a Passenger application and generates the Apache configuration on an account.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles">Web Server role</a>, the system <strong>disables</strong> this function. </p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">name</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=slippers</span></div><div><div html="&lt;p&gt;The Passenger application to enable on the account.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Passenger application to enable on the account.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/PassengerApps/enable_application</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/PassengerApps/enable_application</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kn3dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kn3dq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kn3dq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn3dq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kn3dq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn3dq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kn3dq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn3dq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kn3dq:0" aria-labelledby="tab:R4kn3dq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  PassengerApps <span class="token punctuation">\</span>
  enable_application <span class="token punctuation">\</span>
  <span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'slippers'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn3dq:1" aria-labelledby="tab:R4kn3dq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn3dq:2" aria-labelledby="tab:R4kn3dq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn3dq:3" aria-labelledby="tab:R4kn3dq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sn3dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sn3dq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sn3dq:0" aria-labelledby="tab:R4sn3dq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;enable_application&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;PassengerApps&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Application-Manager/operation/list_applications" data-section-id="tag/Application-Manager/operation/list_applications" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_applications" id="operation/list_applications" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Application-Manager/operation/list_applications" aria-label="tag/Application-Manager/operation/list_applications"></a>Return Passenger applications </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists an account’s Passenger applications.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Web Server role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists an account’s Passenger applications.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">Web Server role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/PassengerApps/list_applications</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/PassengerApps/list_applications</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kp3dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kp3dq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kp3dq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp3dq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kp3dq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp3dq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kp3dq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp3dq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kp3dq:0" aria-labelledby="tab:R4kp3dq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  PassengerApps <span class="token punctuation">\</span>
  list_applications
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp3dq:1" aria-labelledby="tab:R4kp3dq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp3dq:2" aria-labelledby="tab:R4kp3dq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp3dq:3" aria-labelledby="tab:R4kp3dq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sp3dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sp3dq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sp3dq:0" aria-labelledby="tab:R4sp3dq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_applications&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;PassengerApps&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"Name of Application 1"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"base_uri"</span>: <span class="token string">&quot;/app1-uri&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deployment_mode"</span>: <span class="token string">&quot;production&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deps"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"gem"</span>: <span class="token string">&quot;0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"npm"</span>: <span class="token string">&quot;0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pip"</span>: <span class="token string">&quot;cd /home/user/app1-dir &amp;&amp; pip install --user -r requirements.txt&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"envvars"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;Name of Application 1&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/home/user/app1-dir&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"Name of Application 2"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"base_uri"</span>: <span class="token string">&quot;/app2-uri&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deployment_mode"</span>: <span class="token string">&quot;development&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deps"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"gem"</span>: <span class="token string">&quot;cd /home/user/app2-dir &amp;&amp; BUNDLE_PATH=~/.gem /path/to/ruby/version/package/bundler install&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"npm"</span>: <span class="token string">&quot;0&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pip"</span>: <span class="token string">&quot;0&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"envvars"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;Name of Application 2&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/home/user/app2-dir&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Application-Manager/operation/ensure_deps" data-section-id="tag/Application-Manager/operation/ensure_deps" class="sc-dntaoT ceciOs"><div data-section-id="operation/ensure_deps" id="operation/ensure_deps" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Application-Manager/operation/ensure_deps" aria-label="tag/Application-Manager/operation/ensure_deps"></a>Install Passenger application dependencies </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function installs the dependencies for a Passenger application.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note&lt;/strong&gt;:&lt;/p&gt;
&lt;p&gt;  This function starts the installation process. This may take a long time to complete.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important&lt;/strong&gt;:&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Web Server role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function installs the dependencies for a Passenger application.</p>
<p><strong>Note</strong>:</p>
<p>  This function starts the installation process. This may take a long time to complete.</p>
<p><strong>Important</strong>:</p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">Web Server role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="app_path" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">app_path</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">app_path=/home/example/my-app/</span></div><div><div html="&lt;p&gt;The application’s filepath.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The application’s filepath.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="type" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">type</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;gem&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;npm&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;pip&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">type=npm</span></div><div><div html="&lt;p&gt;The application’s type.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;gem&lt;/code&gt; — Ensure ruby gems in the application’s &lt;code&gt;Gemfile&lt;/code&gt; file.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;npm&lt;/code&gt; — Ensure node packages in the application’s &lt;code&gt;package.json&lt;/code&gt; file.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;pip&lt;/code&gt; — Ensure python pips in the application’s &lt;code&gt;requirements.txt&lt;/code&gt; file.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The application’s type.</p>
<ul>
<li><code>gem</code> — Ensure ruby gems in the application’s <code>Gemfile</code> file.</li>
<li><code>npm</code> — Ensure node packages in the application’s <code>package.json</code> file.</li>
<li><code>pip</code> — Ensure python pips in the application’s <code>requirements.txt</code> file.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/PassengerApps/ensure_deps</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/PassengerApps/ensure_deps</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kr3dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kr3dq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kr3dq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kr3dq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kr3dq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kr3dq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kr3dq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kr3dq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kr3dq:0" aria-labelledby="tab:R4kr3dq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  PassengerApps <span class="token punctuation">\</span>
  ensure_deps <span class="token punctuation">\</span>
  <span class="token assign-left variable">type</span><span class="token operator">=</span><span class="token string">'npm'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">app_path</span><span class="token operator">=</span><span class="token string">'/home/example/my-app/'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kr3dq:1" aria-labelledby="tab:R4kr3dq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kr3dq:2" aria-labelledby="tab:R4kr3dq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kr3dq:3" aria-labelledby="tab:R4kr3dq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sr3dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sr3dq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sr3dq:0" aria-labelledby="tab:R4sr3dq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;ensure_deps&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;PassengerApps&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"sse_url"</span>: <span class="token string">&quot;/sse/UserTasks/00000000_5c6c8b18228a35/ensure_deps.log&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"task_id"</span>: <span class="token string">&quot;00000000/5c76ec5566332c&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Application-Manager/operation/register_application" data-section-id="tag/Application-Manager/operation/register_application" class="sc-dntaoT ceciOs"><div data-section-id="operation/register_application" id="operation/register_application" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Application-Manager/operation/register_application" aria-label="tag/Application-Manager/operation/register_application"></a>Register Passenger application </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function registers a Passenger application for an account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important&lt;/strong&gt;:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;This function &lt;strong&gt;only&lt;/strong&gt; registers an application. It does &lt;strong&gt;not&lt;/strong&gt; create the application. You &lt;strong&gt;must&lt;/strong&gt; create an application &lt;strong&gt;before&lt;/strong&gt; you register the application. For an example of how to do this, read our &lt;a href=&quot;https://go.cpanel.net/howtocreaterubyapps&quot;&gt;How to Create Ruby Web Applications&lt;/a&gt; documentation.&lt;/li&gt;
&lt;li&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Web Server role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function registers a Passenger application for an account.</p>
<p><strong>Important</strong>:</p>
<ul>
<li>This function <strong>only</strong> registers an application. It does <strong>not</strong> create the application. You <strong>must</strong> create an application <strong>before</strong> you register the application. For an example of how to do this, read our <a href="https://go.cpanel.net/howtocreaterubyapps">How to Create Ruby Web Applications</a> documentation.</li>
<li>When you disable the <a href="https://go.cpanel.net/serverroles">Web Server role</a>, the system <strong>disables</strong> this function.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="base_uri" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">base_uri</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;url-path&gt; </span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;/&quot;</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">base_uri=/ruby</span></div><div><div html="&lt;p&gt;The application’s base URI.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The application’s base URI.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="deployment_mode" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">deployment_mode</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;production&quot;</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;production&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;development&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">deployment_mode=production</span></div><div><div html="&lt;p&gt;The type of server environment in which to run the application.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;development&lt;/code&gt; — Sets the application to run in a development environment.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;production&lt;/code&gt; — Sets the application to run in a production environment.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The type of server environment in which to run the application.</p>
<ul>
<li><code>development</code> — Sets the application to run in a development environment.</li>
<li><code>production</code> — Sets the application to run in a production environment.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=dorothy.com</span></div><div><div html="&lt;p&gt;The domain for which to register the application.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain for which to register the application.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="enabled" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">enabled</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Default: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">enabled=1</span></div><div><div html="&lt;p&gt;Whether to enable the application and generate the web server configuration for it.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Enable the application and generate the web server configuration.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Don’t enable the application and generate the web server configuration.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to enable the application and generate the web server configuration for it.</p>
<ul>
<li><code>1</code> — Enable the application and generate the web server configuration.</li>
<li><code>0</code> — Don’t enable the application and generate the web server configuration.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="envvar_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">envvar_name</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">strings</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &lt;= 256 characters </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">envvar_name=SHOES&amp;envvar_name=TINMAN</span></div><div><div html="&lt;p&gt;Environment variables that the application needs.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note&lt;/strong&gt;:&lt;/p&gt;
&lt;p&gt;  For each &lt;code&gt;envvar_name&lt;/code&gt; parameter you send, you &lt;strong&gt;must&lt;/strong&gt; include an &lt;code&gt;envvar_value&lt;/code&gt; parameter.&lt;/p&gt;
&lt;p&gt;  This parameter&amp;#39;s value can only contain letters, numbers, underscores, and dashes, and cannot begin with a number. This parameter&amp;#39;s value must also not exceed 256 characters.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Environment variables that the application needs.</p>
<p><strong>Note</strong>:</p>
<p>  For each <code>envvar_name</code> parameter you send, you <strong>must</strong> include an <code>envvar_value</code> parameter.</p>
<p>  This parameter&#39;s value can only contain letters, numbers, underscores, and dashes, and cannot begin with a number. This parameter&#39;s value must also not exceed 256 characters.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="envvar_value" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">envvar_value</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">strings</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &lt;= 1024 characters </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">envvar_value=ruby&amp;envvar_value=heart</span></div><div><div html="&lt;p&gt;Each environment variable’s value.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note&lt;/strong&gt;:&lt;/p&gt;
&lt;p&gt;  For each &lt;code&gt;envvar_name&lt;/code&gt; parameter you send, you &lt;strong&gt;must&lt;/strong&gt; include an &lt;code&gt;envvar_value&lt;/code&gt; parameter.&lt;/p&gt;
&lt;p&gt;  An environment variable value must contain 1024 or fewer ASCII-printable characters.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Each environment variable’s value.</p>
<p><strong>Note</strong>:</p>
<p>  For each <code>envvar_name</code> parameter you send, you <strong>must</strong> include an <code>envvar_value</code> parameter.</p>
<p>  An environment variable value must contain 1024 or fewer ASCII-printable characters.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">name</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> [ 1 .. 50 ] characters </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=Name of Application</span></div><div><div html="&lt;p&gt;The application’s name.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The application’s name.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="path" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">path</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">path=/slippers</span></div><div><div html="&lt;p&gt;The application’s filepath relative to the user’s home directory.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The application’s filepath relative to the user’s home directory.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/PassengerApps/register_application</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/PassengerApps/register_application</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kt3dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kt3dq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kt3dq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kt3dq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kt3dq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kt3dq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kt3dq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kt3dq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kt3dq:0" aria-labelledby="tab:R4kt3dq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  PassengerApps <span class="token punctuation">\</span>
  register_application <span class="token punctuation">\</span>
  <span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'Name of Application'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">path</span><span class="token operator">=</span><span class="token string">'/slippers'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'dorothy.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kt3dq:1" aria-labelledby="tab:R4kt3dq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kt3dq:2" aria-labelledby="tab:R4kt3dq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kt3dq:3" aria-labelledby="tab:R4kt3dq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4st3dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4st3dq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4st3dq:0" aria-labelledby="tab:R4st3dq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;register_application&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;PassengerApps&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"Name of Application"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"base_uri"</span>: <span class="token string">&quot;/ruby&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deployment_mode"</span>: <span class="token string">&quot;production&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;dorothy.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"envvars"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"SHOES"</span>: <span class="token string">&quot;ruby&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"TINMAN"</span>: <span class="token string">&quot;heart&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;Name of Application&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/home/dorothy/slippers&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Application-Manager/operation/unregister_application" data-section-id="tag/Application-Manager/operation/unregister_application" class="sc-dntaoT ceciOs"><div data-section-id="operation/unregister_application" id="operation/unregister_application" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Application-Manager/operation/unregister_application" aria-label="tag/Application-Manager/operation/unregister_application"></a>Unregister Passenger application </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function unregisters a &lt;a href=&quot;https://go.cpanel.net/cpaneldocsApplicationManager&quot;&gt;Passenger application&lt;/a&gt; on an account.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;This function &lt;strong&gt;only&lt;/strong&gt; unregisters an application. It does &lt;strong&gt;not&lt;/strong&gt; delete the application. You &lt;strong&gt;must&lt;/strong&gt; manually delete the application from your system.&lt;/li&gt;
&lt;li&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Web Server role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function unregisters a <a href="https://go.cpanel.net/cpaneldocsApplicationManager">Passenger application</a> on an account.</p>
<p><strong>Note:</strong></p>
<ul>
<li>This function <strong>only</strong> unregisters an application. It does <strong>not</strong> delete the application. You <strong>must</strong> manually delete the application from your system.</li>
<li>When you disable the <a href="https://go.cpanel.net/serverroles">Web Server role</a>, the system <strong>disables</strong> this function.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">name</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">name=slippers</span></div><div><div html="&lt;p&gt;The application to unregister.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The application to unregister.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/PassengerApps/unregister_application</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/PassengerApps/unregister_application</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kv3dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kv3dq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kv3dq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kv3dq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kv3dq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kv3dq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kv3dq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kv3dq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kv3dq:0" aria-labelledby="tab:R4kv3dq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  PassengerApps <span class="token punctuation">\</span>
  unregister_application <span class="token punctuation">\</span>
  <span class="token assign-left variable">name</span><span class="token operator">=</span><span class="token string">'slippers'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kv3dq:1" aria-labelledby="tab:R4kv3dq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kv3dq:2" aria-labelledby="tab:R4kv3dq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kv3dq:3" aria-labelledby="tab:R4kv3dq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sv3dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sv3dq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sv3dq:0" aria-labelledby="tab:R4sv3dq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;unregister_application&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;PassengerApps&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/ModSecurity" data-section-id="tag/ModSecurity" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/ModSecurity" aria-label="tag/ModSecurity"></a>ModSecurity</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;The ModSecurity module for UAPI.&lt;/p&gt;
"><p>The ModSecurity module for UAPI.</p>
</div></div></div><div id="tag/ModSecurity/operation/disable_all_domains" data-section-id="tag/ModSecurity/operation/disable_all_domains" class="sc-dntaoT ceciOs"><div data-section-id="operation/disable_all_domains" id="operation/disable_all_domains" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/ModSecurity/operation/disable_all_domains" aria-label="tag/ModSecurity/operation/disable_all_domains"></a>Disable ModSecurity for all domains </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function disables ModSecurity™ on a cPanel account&amp;#39;s domains.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles#roles&quot;&gt;WebServer role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables ModSecurity™ on a cPanel account&#39;s domains.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles#roles">WebServer role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/ModSecurity/disable_all_domains</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/ModSecurity/disable_all_domains</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kj5dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kj5dq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kj5dq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj5dq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kj5dq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj5dq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kj5dq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj5dq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kj5dq:0" aria-labelledby="tab:R4kj5dq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  ModSecurity <span class="token punctuation">\</span>
  disable_all_domains
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj5dq:1" aria-labelledby="tab:R4kj5dq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj5dq:2" aria-labelledby="tab:R4kj5dq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj5dq:3" aria-labelledby="tab:R4kj5dq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sj5dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sj5dq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sj5dq:0" aria-labelledby="tab:R4sj5dq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;disable_all_domains&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;ModSecurity&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dependencies"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;dallas.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;dallas.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchhint"</span>: <span class="token string">&quot;dallas.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dependencies"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;arkansas.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;kansas.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;nevada.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;newmexico.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;texas.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchhint"</span>: <span class="token string">&quot;arkansas.com,kansas.com,nevada.com,newmexico.com,texas.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;main&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dependencies"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;galveston.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;galveston.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchhint"</span>: <span class="token string">&quot;galveston.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dependencies"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;houston.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;houston.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchhint"</span>: <span class="token string">&quot;houston.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dependencies"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;neworleans.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;neworleans.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchhint"</span>: <span class="token string">&quot;neworleans.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dependencies"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;sanantonio.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;sanantonio.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchhint"</span>: <span class="token string">&quot;sanantonio.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/ModSecurity/operation/disable_domains" data-section-id="tag/ModSecurity/operation/disable_domains" class="sc-dntaoT ceciOs"><div data-section-id="operation/disable_domains" id="operation/disable_domains" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/ModSecurity/operation/disable_domains" aria-label="tag/ModSecurity/operation/disable_domains"></a>Disable ModSecurity for selected domains </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function disables ModSecurity™ on specified domains.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles#roles&quot;&gt;WebServer role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables ModSecurity™ on specified domains.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles#roles">WebServer role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domains" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domains</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domains=example.com,dallas.example.com,galveston.example.com</span></div><div><div html="&lt;p&gt;A comma-separated list of domains that the cPanel account owns.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;The authenticated cPanel account &lt;strong&gt;must&lt;/strong&gt; own these domains.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A comma-separated list of domains that the cPanel account owns.</p>
<p><strong>Important:</strong></p>
<p>The authenticated cPanel account <strong>must</strong> own these domains.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/ModSecurity/disable_domains</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/ModSecurity/disable_domains</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kl5dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kl5dq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kl5dq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl5dq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kl5dq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl5dq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kl5dq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl5dq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kl5dq:0" aria-labelledby="tab:R4kl5dq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  ModSecurity <span class="token punctuation">\</span>
  disable_domains <span class="token punctuation">\</span>
  <span class="token assign-left variable">domains</span><span class="token operator">=</span><span class="token string">'example.com,dallas.example.com,galveston.example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl5dq:1" aria-labelledby="tab:R4kl5dq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl5dq:2" aria-labelledby="tab:R4kl5dq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl5dq:3" aria-labelledby="tab:R4kl5dq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sl5dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sl5dq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sl5dq:0" aria-labelledby="tab:R4sl5dq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;disable_domains&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;ModSecurity&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dependencies"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;dallas.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;dallas.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchhint"</span>: <span class="token string">&quot;dallas.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dependencies"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;arkansas.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;kansas.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;nevada.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;newmexico.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;texas.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchhint"</span>: <span class="token string">&quot;arkansas.com,kansas.com,nevada.com,newmexico.com,texas.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;main&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dependencies"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;galveston.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;galveston.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchhint"</span>: <span class="token string">&quot;galveston.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/ModSecurity/operation/enable_all_domains" data-section-id="tag/ModSecurity/operation/enable_all_domains" class="sc-dntaoT ceciOs"><div data-section-id="operation/enable_all_domains" id="operation/enable_all_domains" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/ModSecurity/operation/enable_all_domains" aria-label="tag/ModSecurity/operation/enable_all_domains"></a>Enable ModSecurity for all domains </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function enables ModSecurity™ on a cPanel account&amp;#39;s domains.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles#roles&quot;&gt;WebServer role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables ModSecurity™ on a cPanel account&#39;s domains.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles#roles">WebServer role</a>, the system <strong>disables</strong> this function</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/ModSecurity/enable_all_domains</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/ModSecurity/enable_all_domains</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kn5dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kn5dq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kn5dq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn5dq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kn5dq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn5dq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kn5dq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn5dq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kn5dq:0" aria-labelledby="tab:R4kn5dq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  ModSecurity <span class="token punctuation">\</span>
  enable_all_domains
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn5dq:1" aria-labelledby="tab:R4kn5dq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn5dq:2" aria-labelledby="tab:R4kn5dq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn5dq:3" aria-labelledby="tab:R4kn5dq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sn5dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sn5dq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sn5dq:0" aria-labelledby="tab:R4sn5dq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;enable_all_domains&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;ModSecurity&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dependencies"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;dallas.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;dallas.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchhint"</span>: <span class="token string">&quot;dallas.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dependencies"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;arkansas.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;kansas.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;nevada.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;newmexico.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;texas.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchhint"</span>: <span class="token string">&quot;arkansas.com,kansas.com,nevada.com,newmexico.com,texas.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;main&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dependencies"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;galveston.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;galveston.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchhint"</span>: <span class="token string">&quot;galveston.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dependencies"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;houston.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;houston.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchhint"</span>: <span class="token string">&quot;houston.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dependencies"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;neworleans.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;neworleans.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchhint"</span>: <span class="token string">&quot;neworleans.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dependencies"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;sanantonio.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;sanantonio.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchhint"</span>: <span class="token string">&quot;sanantonio.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/ModSecurity/operation/enable_domains" data-section-id="tag/ModSecurity/operation/enable_domains" class="sc-dntaoT ceciOs"><div data-section-id="operation/enable_domains" id="operation/enable_domains" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/ModSecurity/operation/enable_domains" aria-label="tag/ModSecurity/operation/enable_domains"></a>Enable ModSecurity for selected domains </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function enables ModSecurity™ for specified domains.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles#roles&quot;&gt;WebServer role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables ModSecurity™ for specified domains.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles#roles">WebServer role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="domains" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domains</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domains=example.com,dallas.example.com,galveston.example.com</span></div><div><div html="&lt;p&gt;A comma-separated list of domains for which to enable ModSecurity.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;The authenticated cPanel account &lt;strong&gt;must&lt;/strong&gt; own these domains.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A comma-separated list of domains for which to enable ModSecurity.</p>
<p><strong>Important:</strong></p>
<p>The authenticated cPanel account <strong>must</strong> own these domains.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/ModSecurity/enable_domains</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/ModSecurity/enable_domains</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kp5dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kp5dq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kp5dq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp5dq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kp5dq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp5dq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kp5dq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp5dq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kp5dq:0" aria-labelledby="tab:R4kp5dq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  ModSecurity <span class="token punctuation">\</span>
  enable_domains <span class="token punctuation">\</span>
  <span class="token assign-left variable">domains</span><span class="token operator">=</span><span class="token string">'example.com,dallas.example.com,galveston.example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp5dq:1" aria-labelledby="tab:R4kp5dq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp5dq:2" aria-labelledby="tab:R4kp5dq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp5dq:3" aria-labelledby="tab:R4kp5dq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sp5dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sp5dq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sp5dq:0" aria-labelledby="tab:R4sp5dq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;enable_domains&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;ModSecurity&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dependencies"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;dallas.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;dallas.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchhint"</span>: <span class="token string">&quot;dallas.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dependencies"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;arkansas.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;kansas.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;nevada.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;newmexico.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;texas.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchhint"</span>: <span class="token string">&quot;arkansas.com,kansas.com,nevada.com,newmexico.com,texas.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;main&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dependencies"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;galveston.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;galveston.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchhint"</span>: <span class="token string">&quot;galveston.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/ModSecurity/operation/has_modsecurity_installed" data-section-id="tag/ModSecurity/operation/has_modsecurity_installed" class="sc-dntaoT ceciOs"><div data-section-id="operation/has_modsecurity_installed" id="operation/has_modsecurity_installed" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/ModSecurity/operation/has_modsecurity_installed" aria-label="tag/ModSecurity/operation/has_modsecurity_installed"></a>Return ModSecurity installation status </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function checks whether ModSecurity™ is installed on a server.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles#roles&quot;&gt;Web Server role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function checks whether ModSecurity™ is installed on a server.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles#roles">Web Server role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/ModSecurity/has_modsecurity_installed</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/ModSecurity/has_modsecurity_installed</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kr5dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kr5dq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kr5dq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kr5dq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kr5dq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kr5dq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kr5dq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kr5dq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kr5dq:0" aria-labelledby="tab:R4kr5dq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  ModSecurity <span class="token punctuation">\</span>
  has_modsecurity_installed
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kr5dq:1" aria-labelledby="tab:R4kr5dq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kr5dq:2" aria-labelledby="tab:R4kr5dq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kr5dq:3" aria-labelledby="tab:R4kr5dq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sr5dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sr5dq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sr5dq:0" aria-labelledby="tab:R4sr5dq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;has_modsecurity_installed&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;ModSecurity&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"installed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/ModSecurity/operation/ModSecurity-list_domains" data-section-id="tag/ModSecurity/operation/ModSecurity-list_domains" class="sc-dntaoT ceciOs"><div data-section-id="operation/ModSecurity-list_domains" id="operation/ModSecurity-list_domains" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/ModSecurity/operation/ModSecurity-list_domains" aria-label="tag/ModSecurity/operation/ModSecurity-list_domains"></a>Return ModSecurity domains&#x27; status </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns ModSecurity&amp;#39;s™ status for a cPanel account&amp;#39;s domains.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles#roles&quot;&gt;WebServer role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns ModSecurity&#39;s™ status for a cPanel account&#39;s domains.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles#roles">WebServer role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/ModSecurity/list_domains</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/ModSecurity/list_domains</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kt5dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kt5dq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kt5dq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kt5dq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kt5dq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kt5dq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kt5dq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kt5dq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kt5dq:0" aria-labelledby="tab:R4kt5dq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  ModSecurity <span class="token punctuation">\</span>
  list_domains
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kt5dq:1" aria-labelledby="tab:R4kt5dq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kt5dq:2" aria-labelledby="tab:R4kt5dq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kt5dq:3" aria-labelledby="tab:R4kt5dq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4st5dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4st5dq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4st5dq:0" aria-labelledby="tab:R4st5dq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_domains&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;ModSecurity&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dependencies"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;dallas.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;dallas.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchhint"</span>: <span class="token string">&quot;dallas.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dependencies"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;arkansas.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;kansas.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;nevada.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;newmexico.com&quot;</span>,</div></li><li><div class="hoverable "><span class="token string">&quot;texas.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchhint"</span>: <span class="token string">&quot;arkansas.com,kansas.com,nevada.com,newmexico.com,texas.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;main&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dependencies"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;galveston.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;galveston.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchhint"</span>: <span class="token string">&quot;galveston.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dependencies"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;houston.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;houston.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchhint"</span>: <span class="token string">&quot;houston.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dependencies"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;neworleans.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;neworleans.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchhint"</span>: <span class="token string">&quot;neworleans.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"dependencies"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;sanantonio.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;sanantonio.example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"enabled"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"searchhint"</span>: <span class="token string">&quot;sanantonio.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;sub&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"modsec"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"total_disabled"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total_enabled"</span>: <span class="token number">3</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/NginxCaching" data-section-id="tag/NginxCaching" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/NginxCaching" aria-label="tag/NginxCaching"></a>NginxCaching</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;The NginxCaching module for UAPI.&lt;/p&gt;
"><p>The NginxCaching module for UAPI.</p>
</div></div></div><div id="tag/NginxCaching/operation/enable_cache" data-section-id="tag/NginxCaching/operation/enable_cache" class="sc-dntaoT ceciOs"><div data-section-id="operation/enable_cache" id="operation/enable_cache" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/NginxCaching/operation/enable_cache" aria-label="tag/NginxCaching/operation/enable_cache"></a>Enable the user&#x27;s NGINX cache </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function enables the user&amp;#39;s NGINX cache.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;You can &lt;strong&gt;only&lt;/strong&gt; use this function if you installed the &lt;code&gt;ea-nginx&lt;/code&gt; package.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function enables the user&#39;s NGINX cache.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You can <strong>only</strong> use this function if you installed the <code>ea-nginx</code> package.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/NginxCaching/enable_cache</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/NginxCaching/enable_cache</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kj7dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kj7dq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kj7dq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj7dq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kj7dq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj7dq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kj7dq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj7dq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kj7dq:0" aria-labelledby="tab:R4kj7dq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  NginxCaching <span class="token punctuation">\</span>
  enable_cache
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj7dq:1" aria-labelledby="tab:R4kj7dq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj7dq:2" aria-labelledby="tab:R4kj7dq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj7dq:3" aria-labelledby="tab:R4kj7dq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sj7dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sj7dq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sj7dq:0" aria-labelledby="tab:R4sj7dq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;enable_cache&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;NginxCaching&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/NginxCaching/operation/clear_cache" data-section-id="tag/NginxCaching/operation/clear_cache" class="sc-dntaoT ceciOs"><div data-section-id="operation/clear_cache" id="operation/clear_cache" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/NginxCaching/operation/clear_cache" aria-label="tag/NginxCaching/operation/clear_cache"></a>Delete NGINX cache contents. </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function clears the user&amp;#39;s NGINX cache.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;You can &lt;strong&gt;only&lt;/strong&gt; use this function if you installed the &lt;code&gt;ea-nginx&lt;/code&gt; package.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function clears the user&#39;s NGINX cache.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You can <strong>only</strong> use this function if you installed the <code>ea-nginx</code> package.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/NginxCaching/clear_cache</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/NginxCaching/clear_cache</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kl7dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kl7dq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kl7dq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl7dq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kl7dq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl7dq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kl7dq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl7dq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kl7dq:0" aria-labelledby="tab:R4kl7dq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  NginxCaching <span class="token punctuation">\</span>
  clear_cache
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl7dq:1" aria-labelledby="tab:R4kl7dq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl7dq:2" aria-labelledby="tab:R4kl7dq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl7dq:3" aria-labelledby="tab:R4kl7dq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sl7dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sl7dq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sl7dq:0" aria-labelledby="tab:R4sl7dq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;clear_cache&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;NginxCaching&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/NginxCaching/operation/reset_cache_config" data-section-id="tag/NginxCaching/operation/reset_cache_config" class="sc-dntaoT ceciOs"><div data-section-id="operation/reset_cache_config" id="operation/reset_cache_config" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/NginxCaching/operation/reset_cache_config" aria-label="tag/NginxCaching/operation/reset_cache_config"></a>Reset the user&#x27;s NGINX cache configuration </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function resets the user&amp;#39;s NGINX caching configuration.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;You can &lt;strong&gt;only&lt;/strong&gt; use this function if you installed the &lt;code&gt;ea-nginx&lt;/code&gt; package.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function resets the user&#39;s NGINX caching configuration.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You can <strong>only</strong> use this function if you installed the <code>ea-nginx</code> package.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/NginxCaching/reset_cache_config</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/NginxCaching/reset_cache_config</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kn7dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kn7dq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kn7dq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn7dq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kn7dq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn7dq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kn7dq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn7dq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kn7dq:0" aria-labelledby="tab:R4kn7dq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  NginxCaching <span class="token punctuation">\</span>
  reset_cache_config
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn7dq:1" aria-labelledby="tab:R4kn7dq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn7dq:2" aria-labelledby="tab:R4kn7dq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn7dq:3" aria-labelledby="tab:R4kn7dq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sn7dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sn7dq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sn7dq:0" aria-labelledby="tab:R4sn7dq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;reset_cache_config&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;NginxCaching&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/NginxCaching/operation/disable_cache" data-section-id="tag/NginxCaching/operation/disable_cache" class="sc-dntaoT ceciOs"><div data-section-id="operation/disable_cache" id="operation/disable_cache" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/NginxCaching/operation/disable_cache" aria-label="tag/NginxCaching/operation/disable_cache"></a>Disable the user&#x27;s NGINX cache </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function disables the user&amp;#39;s NGINX cache.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;You can &lt;strong&gt;only&lt;/strong&gt; use this function if you installed the &lt;code&gt;ea-nginx&lt;/code&gt; package.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function disables the user&#39;s NGINX cache.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You can <strong>only</strong> use this function if you installed the <code>ea-nginx</code> package.</li>
</ul>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/NginxCaching/disable_cache</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/NginxCaching/disable_cache</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kp7dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kp7dq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kp7dq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp7dq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kp7dq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp7dq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kp7dq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp7dq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kp7dq:0" aria-labelledby="tab:R4kp7dq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  NginxCaching <span class="token punctuation">\</span>
  disable_cache
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp7dq:1" aria-labelledby="tab:R4kp7dq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp7dq:2" aria-labelledby="tab:R4kp7dq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp7dq:3" aria-labelledby="tab:R4kp7dq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sp7dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sp7dq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sp7dq:0" aria-labelledby="tab:R4sp7dq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;disable_cache&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;NginxCaching&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/PHP-Settings" data-section-id="tag/PHP-Settings" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PHP-Settings" aria-label="tag/PHP-Settings"></a>PHP Settings</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Web Server Management / PHP Settings&lt;/p&gt;
"><p>Web Server Management / PHP Settings</p>
</div></div></div><div id="tag/PHP-Settings/operation/php_get_domain_handler" data-section-id="tag/PHP-Settings/operation/php_get_domain_handler" class="sc-dntaoT ceciOs"><div data-section-id="operation/php_get_domain_handler" id="operation/php_get_domain_handler" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PHP-Settings/operation/php_get_domain_handler" aria-label="tag/PHP-Settings/operation/php_get_domain_handler"></a>Return PHP version&#x27;s handler </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns a PHP version&amp;#39;s assigned PHP handler.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  This document &lt;strong&gt;only&lt;/strong&gt; applies to systems that run EasyApache 4.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;WebServer role&lt;/a&gt;, the system disables this function. For more information, read our How to Use Server Profiles documentation.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns a PHP version&#39;s assigned PHP handler.</p>
<p><strong>Note:</strong></p>
<p>  This document <strong>only</strong> applies to systems that run EasyApache 4.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles">WebServer role</a>, the system disables this function. For more information, read our How to Use Server Profiles documentation.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="type" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">type</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;home&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;vhost&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">type=vhost</span></div><div><div html="&lt;p&gt;The type of &lt;code&gt;php.ini&lt;/code&gt; file.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;home&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;vhost&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;If you set this parameter to &lt;code&gt;vhost&lt;/code&gt;, you &lt;strong&gt;must&lt;/strong&gt; also include the vhost parameter.&lt;/li&gt;
&lt;li&gt;If you set this parameter to &lt;code&gt;home&lt;/code&gt;, the system returns the system default PHP handler.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The type of <code>php.ini</code> file.</p>
<ul>
<li><code>home</code></li>
<li><code>vhost</code></li>
</ul>
<p><strong>Important:</strong></p>
<ul>
<li>If you set this parameter to <code>vhost</code>, you <strong>must</strong> also include the vhost parameter.</li>
<li>If you set this parameter to <code>home</code>, the system returns the system default PHP handler.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="vhost" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">vhost</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">vhost=clearly.com</span></div><div><div html="&lt;p&gt;The name of a virtual host.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; If the &lt;code&gt;type&lt;/code&gt; value is &lt;code&gt;vhost&lt;/code&gt;, you &lt;strong&gt;must&lt;/strong&gt; use this parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of a virtual host.</p>
<p><strong>Important:</strong></p>
<p> If the <code>type</code> value is <code>vhost</code>, you <strong>must</strong> use this parameter.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/LangPHP/php_get_domain_handler</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/LangPHP/php_get_domain_handler</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R9939dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9939dq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R9939dq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R9939dq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R9939dq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R9939dq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R9939dq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R9939dq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9939dq:0" aria-labelledby="tab:R9939dq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  LangPHP <span class="token punctuation">\</span>
  php_get_domain_handler <span class="token punctuation">\</span>
  <span class="token assign-left variable">type</span><span class="token operator">=</span><span class="token string">'vhost'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R9939dq:1" aria-labelledby="tab:R9939dq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R9939dq:2" aria-labelledby="tab:R9939dq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R9939dq:3" aria-labelledby="tab:R9939dq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p39dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p39dq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p39dq:0" aria-labelledby="tab:R9p39dq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;php_get_domain_handler&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;LangPHP&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"php_handler"</span>: <span class="token string">&quot;cgi&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/PHP-Settings/operation/php_get_impacted_domains" data-section-id="tag/PHP-Settings/operation/php_get_impacted_domains" class="sc-dntaoT ceciOs"><div data-section-id="operation/php_get_impacted_domains" id="operation/php_get_impacted_domains" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PHP-Settings/operation/php_get_impacted_domains" aria-label="tag/PHP-Settings/operation/php_get_impacted_domains"></a>Return domains that shared PHP configuration </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists domains that obtain their PHP version from a specified PHP configuration.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  This document &lt;strong&gt;only&lt;/strong&gt; applies to systems that run EasyApache 4.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;WebServer role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists domains that obtain their PHP version from a specified PHP configuration.</p>
<p><strong>Note:</strong></p>
<p>  This document <strong>only</strong> applies to systems that run EasyApache 4.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles">WebServer role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;A domain on the system.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;You must pass either the &lt;code&gt;system_default&lt;/code&gt; or &lt;code&gt;domain&lt;/code&gt; parameters, or both.&lt;/li&gt;
&lt;li&gt;You can pass this parameter multiple times.&lt;/li&gt;
&lt;li&gt;You &lt;strong&gt;cannot&lt;/strong&gt; pass the name of a parked domain.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A domain on the system.</p>
<p><strong>Note:</strong></p>
<ul>
<li>You must pass either the <code>system_default</code> or <code>domain</code> parameters, or both.</li>
<li>You can pass this parameter multiple times.</li>
<li>You <strong>cannot</strong> pass the name of a parked domain.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="system_default" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">system_default</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">system_default=1</span></div><div><div html="&lt;p&gt;Whether to return domains that inherit the system&amp;#39;s default PHP version.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; - Return domains that inherit the system&amp;#39;s default PHP version.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; - Do &lt;strong&gt;not&lt;/strong&gt; return domains that inherit the system&amp;#39;s default PHP version.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If you pass this parameter with a false value and do &lt;strong&gt;not&lt;/strong&gt; also pass the domain parameter, the function returns an error.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to return domains that inherit the system&#39;s default PHP version.</p>
<ul>
<li><code>1</code> - Return domains that inherit the system&#39;s default PHP version.</li>
<li><code>0</code> - Do <strong>not</strong> return domains that inherit the system&#39;s default PHP version.</li>
</ul>
<p><strong>Note:</strong></p>
<p>If you pass this parameter with a false value and do <strong>not</strong> also pass the domain parameter, the function returns an error.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/LangPHP/php_get_impacted_domains</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/LangPHP/php_get_impacted_domains</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R9959dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9959dq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R9959dq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R9959dq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R9959dq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R9959dq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R9959dq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R9959dq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9959dq:0" aria-labelledby="tab:R9959dq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  LangPHP <span class="token punctuation">\</span>
  php_get_impacted_domains
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R9959dq:1" aria-labelledby="tab:R9959dq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R9959dq:2" aria-labelledby="tab:R9959dq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R9959dq:3" aria-labelledby="tab:R9959dq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p59dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p59dq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p59dq:0" aria-labelledby="tab:R9p59dq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;php_get_impacted_domains&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;LangPHP&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domains"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/PHP-Settings/operation/php_get_installed_versions" data-section-id="tag/PHP-Settings/operation/php_get_installed_versions" class="sc-dntaoT ceciOs"><div data-section-id="operation/php_get_installed_versions" id="operation/php_get_installed_versions" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PHP-Settings/operation/php_get_installed_versions" aria-label="tag/PHP-Settings/operation/php_get_installed_versions"></a>Return installed PHP versions </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the system&amp;#39;s PHP versions.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  This document &lt;strong&gt;only&lt;/strong&gt; applies to systems that run EasyApache 4.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;WebServer role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the system&#39;s PHP versions.</p>
<p><strong>Note:</strong></p>
<p>  This document <strong>only</strong> applies to systems that run EasyApache 4.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles">WebServer role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/LangPHP/php_get_installed_versions</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/LangPHP/php_get_installed_versions</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R9979dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9979dq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R9979dq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R9979dq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R9979dq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R9979dq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R9979dq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R9979dq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9979dq:0" aria-labelledby="tab:R9979dq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  LangPHP <span class="token punctuation">\</span>
  php_get_installed_versions
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R9979dq:1" aria-labelledby="tab:R9979dq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R9979dq:2" aria-labelledby="tab:R9979dq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R9979dq:3" aria-labelledby="tab:R9979dq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p79dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p79dq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p79dq:0" aria-labelledby="tab:R9p79dq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;php_get_installed_versions&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;LangPHP&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"versions"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;ea-php72&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/PHP-Settings/operation/php_ini_get_user_content" data-section-id="tag/PHP-Settings/operation/php_ini_get_user_content" class="sc-dntaoT ceciOs"><div data-section-id="operation/php_ini_get_user_content" id="operation/php_ini_get_user_content" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PHP-Settings/operation/php_ini_get_user_content" aria-label="tag/PHP-Settings/operation/php_ini_get_user_content"></a>Return virtual host&#x27;s php.ini content </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the contents of a virtual host&amp;#39;s &lt;code&gt;php.ini&lt;/code&gt; file.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  This document &lt;strong&gt;only&lt;/strong&gt; applies to systems that run EasyApache 4 with MultiPHP enabled.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;WebServer role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the contents of a virtual host&#39;s <code>php.ini</code> file.</p>
<p><strong>Note:</strong></p>
<p>  This document <strong>only</strong> applies to systems that run EasyApache 4 with MultiPHP enabled.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles">WebServer role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="type" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">type</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">type=vhost</span></div><div><div html="&lt;p&gt;The type of &lt;code&gt;php.ini&lt;/code&gt; file.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;home&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;vhost&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;If you set this parameter to &lt;code&gt;vhost&lt;/code&gt;, you &lt;strong&gt;must&lt;/strong&gt; also include the &lt;code&gt;vhost&lt;/code&gt; parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The type of <code>php.ini</code> file.</p>
<ul>
<li><code>home</code></li>
<li><code>vhost</code></li>
</ul>
<p><strong>Important:</strong></p>
<p>If you set this parameter to <code>vhost</code>, you <strong>must</strong> also include the <code>vhost</code> parameter.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="vhost" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">vhost</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">vhost=clearly.com</span></div><div><div html="&lt;p&gt;The name of a virtual host.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; If the type value is &lt;code&gt;vhost&lt;/code&gt;, you &lt;strong&gt;must&lt;/strong&gt; use this parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of a virtual host.</p>
<p><strong>Important:</strong></p>
<p> If the type value is <code>vhost</code>, you <strong>must</strong> use this parameter.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/LangPHP/php_ini_get_user_content</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/LangPHP/php_ini_get_user_content</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R9999dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9999dq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R9999dq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R9999dq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R9999dq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R9999dq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R9999dq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R9999dq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9999dq:0" aria-labelledby="tab:R9999dq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  LangPHP <span class="token punctuation">\</span>
  php_ini_get_user_content <span class="token punctuation">\</span>
  <span class="token assign-left variable">type</span><span class="token operator">=</span><span class="token string">'vhost'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R9999dq:1" aria-labelledby="tab:R9999dq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R9999dq:2" aria-labelledby="tab:R9999dq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R9999dq:3" aria-labelledby="tab:R9999dq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9p99dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9p99dq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9p99dq:0" aria-labelledby="tab:R9p99dq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;php_ini_get_user_content&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;LangPHP&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"content"</span>: <span class="token string">&quot;allow_url_fopen = On\\nallow_url_include = On\\nasp_tags = Off\\ndisplay_errors = On\\nenable_dl = Off\\nfile_uploads = On\\ninclude_path = &amp;quot;.;/path/to/php/pear&amp;quot;\\nmax_execution_time = 30\\nmax_input_time = 60\\nmax_input_vars = 1050\\nmemory_limit = 32M\\nupload_max_filesize = 2M&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/PHP-Settings/operation/php_get_system_default_version" data-section-id="tag/PHP-Settings/operation/php_get_system_default_version" class="sc-dntaoT ceciOs"><div data-section-id="operation/php_get_system_default_version" id="operation/php_get_system_default_version" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PHP-Settings/operation/php_get_system_default_version" aria-label="tag/PHP-Settings/operation/php_get_system_default_version"></a>Return default PHP version </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the system’s default PHP version.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important&lt;/strong&gt;:&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Web Server role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the system’s default PHP version.</p>
<p><strong>Important</strong>:</p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">Web Server role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/LangPHP/php_get_system_default_version</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/LangPHP/php_get_system_default_version</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99b9dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99b9dq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99b9dq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b9dq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99b9dq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b9dq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99b9dq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99b9dq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99b9dq:0" aria-labelledby="tab:R99b9dq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  LangPHP <span class="token punctuation">\</span>
  php_get_system_default_version
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b9dq:1" aria-labelledby="tab:R99b9dq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b9dq:2" aria-labelledby="tab:R99b9dq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99b9dq:3" aria-labelledby="tab:R99b9dq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pb9dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pb9dq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pb9dq:0" aria-labelledby="tab:R9pb9dq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;php_get_system_default_version&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;LangPHP&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">&quot;ea-php73&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/PHP-Settings/operation/php_ini_get_user_basic_directives" data-section-id="tag/PHP-Settings/operation/php_ini_get_user_basic_directives" class="sc-dntaoT ceciOs"><div data-section-id="operation/php_ini_get_user_basic_directives" id="operation/php_ini_get_user_basic_directives" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PHP-Settings/operation/php_ini_get_user_basic_directives" aria-label="tag/PHP-Settings/operation/php_ini_get_user_basic_directives"></a>Return basic PHP directives </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists a virtual host&amp;#39;s basic PHP directives. The Basic Mode section of cPanel&amp;#39;s &lt;a href=&quot;https://go.cpanel.net/cPanelMultiPHPINI&quot;&gt;MultiPHP INI Editor&lt;/a&gt;  interface (Home &amp;gt;&amp;gt; Software &amp;gt;&amp;gt; MultiPHP INI Editor) also lists these directives.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  This document &lt;strong&gt;only&lt;/strong&gt; applies to systems that run EasyApache 4 with MultiPHP enabled.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;WebServer role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists a virtual host&#39;s basic PHP directives. The Basic Mode section of cPanel&#39;s <a href="https://go.cpanel.net/cPanelMultiPHPINI">MultiPHP INI Editor</a>  interface (Home &gt;&gt; Software &gt;&gt; MultiPHP INI Editor) also lists these directives.</p>
<p><strong>Note:</strong></p>
<p>  This document <strong>only</strong> applies to systems that run EasyApache 4 with MultiPHP enabled.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles">WebServer role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="type" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">type</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;home&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;vhost&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">type=vhost</span></div><div><div html="&lt;p&gt;The type of &lt;code&gt;php.ini&lt;/code&gt; file.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;home&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;vhost&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; If you set this parameter to &lt;code&gt;vhost&lt;/code&gt;, you &lt;strong&gt;must&lt;/strong&gt; also include the &lt;code&gt;vhost&lt;/code&gt; parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The type of <code>php.ini</code> file.</p>
<ul>
<li><code>home</code></li>
<li><code>vhost</code></li>
</ul>
<p><strong>Important:</strong></p>
<p> If you set this parameter to <code>vhost</code>, you <strong>must</strong> also include the <code>vhost</code> parameter.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="vhost" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">vhost</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">vhost=clearly.com</span></div><div><div html="&lt;p&gt;The name of a virtual host.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; If the type value is &lt;code&gt;vhost&lt;/code&gt;, you &lt;strong&gt;must&lt;/strong&gt; use this parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of a virtual host.</p>
<p><strong>Important:</strong></p>
<p> If the type value is <code>vhost</code>, you <strong>must</strong> use this parameter.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/LangPHP/php_ini_get_user_basic_directives</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/LangPHP/php_ini_get_user_basic_directives</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99d9dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99d9dq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99d9dq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d9dq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99d9dq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d9dq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99d9dq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99d9dq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99d9dq:0" aria-labelledby="tab:R99d9dq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  LangPHP <span class="token punctuation">\</span>
  php_ini_get_user_basic_directives <span class="token punctuation">\</span>
  <span class="token assign-left variable">type</span><span class="token operator">=</span><span class="token string">'vhost'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99d9dq:1" aria-labelledby="tab:R99d9dq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99d9dq:2" aria-labelledby="tab:R99d9dq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99d9dq:3" aria-labelledby="tab:R99d9dq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pd9dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pd9dq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pd9dq:0" aria-labelledby="tab:R9pd9dq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;php_ini_get_user_basic_directives&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;LangPHP&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"directives"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"default_value"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"info"</span>: <span class="token string">&quot;This option enables the URL-aware fopen wrappers that enable accessing URL object like files. Default wrappers are provided for the access of remote files using the ftp or http protocol, some extensions like zlib may register additional wrappers.&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">&quot;allow_url_fopen&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"php_ini_mode"</span>: <span class="token string">&quot;PHP_INI_SYSTEM&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;integer&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"value"</span>: <span class="token string">&quot;On&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/PHP-Settings/operation/php_ini_get_user_paths" data-section-id="tag/PHP-Settings/operation/php_ini_get_user_paths" class="sc-dntaoT ceciOs"><div data-section-id="operation/php_ini_get_user_paths" id="operation/php_ini_get_user_paths" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PHP-Settings/operation/php_ini_get_user_paths" aria-label="tag/PHP-Settings/operation/php_ini_get_user_paths"></a>Return php.ini file paths </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists the &lt;code&gt;php.ini&lt;/code&gt; file paths for the user&amp;#39;s home directory and virtual host document roots.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  This document &lt;strong&gt;only&lt;/strong&gt; applies to systems that run EasyApache 4 with MultiPHP enabled.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;WebServer role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists the <code>php.ini</code> file paths for the user&#39;s home directory and virtual host document roots.</p>
<p><strong>Note:</strong></p>
<p>  This document <strong>only</strong> applies to systems that run EasyApache 4 with MultiPHP enabled.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles">WebServer role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/LangPHP/php_ini_get_user_paths</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/LangPHP/php_ini_get_user_paths</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99f9dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99f9dq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99f9dq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f9dq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99f9dq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f9dq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99f9dq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99f9dq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99f9dq:0" aria-labelledby="tab:R99f9dq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  LangPHP <span class="token punctuation">\</span>
  php_ini_get_user_paths
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99f9dq:1" aria-labelledby="tab:R99f9dq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99f9dq:2" aria-labelledby="tab:R99f9dq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99f9dq:3" aria-labelledby="tab:R99f9dq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pf9dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pf9dq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pf9dq:0" aria-labelledby="tab:R9pf9dq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;php_ini_get_user_paths&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;LangPHP&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"paths"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"account"</span>: <span class="token string">&quot;allthethings&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"documentroot"</span>: <span class="token string">&quot;/home/allthethings/public_html&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/home/allthethings/&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"main_domain"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;php.ini&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;vhost&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">&quot;ea-php72&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vhost"</span>: <span class="token string">&quot;clearly.com&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/PHP-Settings/operation/php_ini_set_user_basic_directives" data-section-id="tag/PHP-Settings/operation/php_ini_set_user_basic_directives" class="sc-dntaoT ceciOs"><div data-section-id="operation/php_ini_set_user_basic_directives" id="operation/php_ini_set_user_basic_directives" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PHP-Settings/operation/php_ini_set_user_basic_directives" aria-label="tag/PHP-Settings/operation/php_ini_set_user_basic_directives"></a>Update basic PHP directives </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function sets the values of any basic PHP directive. The &lt;em&gt;Basic Mode&lt;/em&gt; section of cPanel&amp;#39;s
&lt;a href=&quot;https://go.cpanel.net/whmdocsMultiPHPINIEditor&quot;&gt;&lt;em&gt;MultiPHP INI Editor&lt;/em&gt;&lt;/a&gt; interface (&lt;em&gt;WHM &amp;gt;&amp;gt; Home &amp;gt;&amp;gt; Software &amp;gt;&amp;gt; MultiPHP INI Editor&lt;/em&gt;) lists these directives.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  This document &lt;strong&gt;only&lt;/strong&gt; applies to systems that run EasyApache 4 with MultiPHP enabled.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Web Server role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets the values of any basic PHP directive. The <em>Basic Mode</em> section of cPanel&#39;s
<a href="https://go.cpanel.net/whmdocsMultiPHPINIEditor"><em>MultiPHP INI Editor</em></a> interface (<em>WHM &gt;&gt; Home &gt;&gt; Software &gt;&gt; MultiPHP INI Editor</em>) lists these directives.</p>
<p><strong>Note:</strong></p>
<p>  This document <strong>only</strong> applies to systems that run EasyApache 4 with MultiPHP enabled.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">Web Server role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="directive" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">directive</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">directive=directive-1=allow_url_fopen%3A0&amp;directive-2=upload_max_filesize%3A4M&amp;directive-3=post_max_size</span> - Multiple PHP directives.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">directive=allow_url_fopen:0</span> - A single PHP directive.</li></ul><div><div html="&lt;p&gt;The name of a PHP directive and its value.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;To change the directive&amp;#39;s value for multiple PHP directives, increment the parameter name. For example, the &lt;code&gt;directive-1&lt;/code&gt;, &lt;code&gt;directive-2&lt;/code&gt;, and &lt;code&gt;directive-3&lt;/code&gt; parameters.&lt;/li&gt;
&lt;li&gt;You &lt;strong&gt;must&lt;/strong&gt; format values as &lt;code&gt;&amp;lt;directive&amp;gt;:&amp;lt;value&amp;gt;&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of a PHP directive and its value.</p>
<p><strong>Note:</strong></p>
<ul>
<li>To change the directive&#39;s value for multiple PHP directives, increment the parameter name. For example, the <code>directive-1</code>, <code>directive-2</code>, and <code>directive-3</code> parameters.</li>
<li>You <strong>must</strong> format values as <code>&lt;directive&gt;:&lt;value&gt;</code></li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="type" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">type</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;home&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;vhost&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">type=vhost</span></div><div><div html="&lt;p&gt;The type of &lt;code&gt;php.ini&lt;/code&gt; file.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;home&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;vhost&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; If you set this parameter to &lt;code&gt;vhost&lt;/code&gt;, you &lt;strong&gt;must&lt;/strong&gt; also include the &lt;code&gt;vhost&lt;/code&gt; parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The type of <code>php.ini</code> file.</p>
<ul>
<li><code>home</code></li>
<li><code>vhost</code></li>
</ul>
<p><strong>Important:</strong></p>
<p> If you set this parameter to <code>vhost</code>, you <strong>must</strong> also include the <code>vhost</code> parameter.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="vhost" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">vhost</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">vhost=clearly.com</span></div><div><div html="&lt;p&gt;The name of a virtual host.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; If the &lt;code&gt;type&lt;/code&gt; value is &lt;code&gt;vhost&lt;/code&gt;, you &lt;strong&gt;must&lt;/strong&gt; use this parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of a virtual host.</p>
<p><strong>Important:</strong></p>
<p> If the <code>type</code> value is <code>vhost</code>, you <strong>must</strong> use this parameter.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/LangPHP/php_ini_set_user_basic_directives</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/LangPHP/php_ini_set_user_basic_directives</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99h9dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99h9dq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99h9dq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h9dq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99h9dq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h9dq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99h9dq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99h9dq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99h9dq:0" aria-labelledby="tab:R99h9dq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  LangPHP <span class="token punctuation">\</span>
  php_ini_set_user_basic_directives <span class="token punctuation">\</span>
  <span class="token assign-left variable">type</span><span class="token operator">=</span><span class="token string">'vhost'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">directive</span><span class="token operator">=</span><span class="token string">'allow_url_fopen:0'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h9dq:1" aria-labelledby="tab:R99h9dq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h9dq:2" aria-labelledby="tab:R99h9dq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99h9dq:3" aria-labelledby="tab:R99h9dq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9ph9dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9ph9dq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9ph9dq:0" aria-labelledby="tab:R9ph9dq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;php_ini_set_user_basic_directives&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;LangPHP&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"LangPHP"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/home/allthethings/public_html/php.ini&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phpversion"</span>: <span class="token string">&quot;ea-php55&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;vhost&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vhost"</span>: <span class="token string">&quot;clearly.com&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/PHP-Settings/operation/php_ini_set_user_content" data-section-id="tag/PHP-Settings/operation/php_ini_set_user_content" class="sc-dntaoT ceciOs"><div data-section-id="operation/php_ini_set_user_content" id="operation/php_ini_set_user_content" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PHP-Settings/operation/php_ini_set_user_content" aria-label="tag/PHP-Settings/operation/php_ini_set_user_content"></a>Update virtual host&#x27;s php.ini content </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function changes the contents of a virtual host&amp;#39;s &lt;code&gt;php.ini&lt;/code&gt; file.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  This document &lt;strong&gt;only&lt;/strong&gt; applies to systems that run EasyApache 4 with MultiPHP enabled.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;WebServer role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function changes the contents of a virtual host&#39;s <code>php.ini</code> file.</p>
<p><strong>Note:</strong></p>
<p>  This document <strong>only</strong> applies to systems that run EasyApache 4 with MultiPHP enabled.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles">WebServer role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="content" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">content</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">content=%5BPHP%5D%0D%0A%3B+About+php.ini%0D%0A%3B+php.ini+is+responsible+for+configuring+many+of+the+aspects+of+PHP%27s+behavior.%0D%0Apcre.backtrack_limit%3D100000</span></div><div><div html="&lt;p&gt;The content of the &lt;code&gt;php.ini&lt;/code&gt; file to change.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The content of the <code>php.ini</code> file to change.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="type" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">type</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;host&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;vhost&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">type=vhost</span></div><div><div html="&lt;p&gt;The type of &lt;code&gt;php.ini&lt;/code&gt; file.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;home&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;vhost&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; If you set this parameter to &lt;code&gt;vhost&lt;/code&gt;, you &lt;strong&gt;must&lt;/strong&gt; also include the &lt;code&gt;vhost&lt;/code&gt; parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The type of <code>php.ini</code> file.</p>
<ul>
<li><code>home</code></li>
<li><code>vhost</code></li>
</ul>
<p><strong>Important:</strong></p>
<p> If you set this parameter to <code>vhost</code>, you <strong>must</strong> also include the <code>vhost</code> parameter.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="vhost" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">vhost</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">vhost=clearly.com</span></div><div><div html="&lt;p&gt;The name of a virtual host.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; If the type value is &lt;code&gt;vhost&lt;/code&gt; , you &lt;strong&gt;must&lt;/strong&gt; use this parameter.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of a virtual host.</p>
<p><strong>Important:</strong></p>
<p> If the type value is <code>vhost</code> , you <strong>must</strong> use this parameter.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/LangPHP/php_ini_set_user_content</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/LangPHP/php_ini_set_user_content</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99j9dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99j9dq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99j9dq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99j9dq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99j9dq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99j9dq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99j9dq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99j9dq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99j9dq:0" aria-labelledby="tab:R99j9dq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  LangPHP <span class="token punctuation">\</span>
  php_ini_set_user_content <span class="token punctuation">\</span>
  <span class="token assign-left variable">type</span><span class="token operator">=</span><span class="token string">'vhost'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">content</span><span class="token operator">=</span><span class="token string">'%5BPHP%5D%0D%0A%3B+About+php.ini%0D%0A%3B+php.ini+is+responsible+for+configuring+many+of+the+aspects+of+PHP%27s+behavior.%0D%0Apcre.backtrack_limit%3D100000'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99j9dq:1" aria-labelledby="tab:R99j9dq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99j9dq:2" aria-labelledby="tab:R99j9dq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99j9dq:3" aria-labelledby="tab:R99j9dq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pj9dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pj9dq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pj9dq:0" aria-labelledby="tab:R9pj9dq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;php_ini_set_user_content&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;LangPHP&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/PHP-Settings/operation/php_set_vhost_versions" data-section-id="tag/PHP-Settings/operation/php_set_vhost_versions" class="sc-dntaoT ceciOs"><div data-section-id="operation/php_set_vhost_versions" id="operation/php_set_vhost_versions" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PHP-Settings/operation/php_set_vhost_versions" aria-label="tag/PHP-Settings/operation/php_set_vhost_versions"></a>Update virtual host&#x27;s PHP version </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function sets a virtual host&amp;#39;s PHP version.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  This document &lt;strong&gt;only&lt;/strong&gt; applies to systems that run EasyApache 4.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;WebServer role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function sets a virtual host&#39;s PHP version.</p>
<p><strong>Note:</strong></p>
<p>  This document <strong>only</strong> applies to systems that run EasyApache 4.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles">WebServer role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="version" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">version</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">version=ea-php72</span></div><div><div html="&lt;p&gt;The PHP version of a virtual host.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The PHP version of a virtual host.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="vhost" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">vhost</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <span class="sc-CNKsk hPAOR"> Examples: </span><ul class="sc-gqYRWL bJXdVn"><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">vhost=vhost-1=example.com&amp;vhost-2=example2.com&amp;vhost-3=example3.com</span> - Set a multiple vhosts.</li><li><span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">vhost=example.com</span> - Set a single vhost.</li></ul><div><div html="&lt;p&gt;The virtual host&amp;#39;s name.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  To change the PHP version of multiple virtual hosts, duplicate or increment the parameter name. For example, &lt;code&gt;vhost-1&lt;/code&gt;, &lt;code&gt;vhost-2&lt;/code&gt;, and &lt;code&gt;vhost-3&lt;/code&gt;.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The virtual host&#39;s name.</p>
<p><strong>Note:</strong></p>
<p>  To change the PHP version of multiple virtual hosts, duplicate or increment the parameter name. For example, <code>vhost-1</code>, <code>vhost-2</code>, and <code>vhost-3</code>.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/LangPHP/php_set_vhost_versions</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/LangPHP/php_set_vhost_versions</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99l9dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99l9dq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99l9dq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99l9dq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99l9dq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99l9dq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99l9dq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99l9dq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99l9dq:0" aria-labelledby="tab:R99l9dq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  LangPHP <span class="token punctuation">\</span>
  php_set_vhost_versions <span class="token punctuation">\</span>
  <span class="token assign-left variable">version</span><span class="token operator">=</span><span class="token string">'ea-php72'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">vhost</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99l9dq:1" aria-labelledby="tab:R99l9dq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99l9dq:2" aria-labelledby="tab:R99l9dq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99l9dq:3" aria-labelledby="tab:R99l9dq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pl9dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pl9dq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pl9dq:0" aria-labelledby="tab:R9pl9dq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;php_set_vhost_versions&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;LangPHP&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"vhosts"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;example.com&quot;</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/PHP-Settings/operation/php_get_vhost_versions" data-section-id="tag/PHP-Settings/operation/php_get_vhost_versions" class="sc-dntaoT ceciOs"><div data-section-id="operation/php_get_vhost_versions" id="operation/php_get_vhost_versions" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/PHP-Settings/operation/php_get_vhost_versions" aria-label="tag/PHP-Settings/operation/php_get_vhost_versions"></a>Return virtual host&#x27;s PHP version </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns the PHP version of every virtual host that a reseller controls.&lt;/p&gt;
&lt;p&gt;You can get the version of a single virtual host by providing an optional &lt;code&gt;vhost&lt;/code&gt; name.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  This document &lt;strong&gt;only&lt;/strong&gt; applies to systems that run EasyApache 4.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;Web Server role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns the PHP version of every virtual host that a reseller controls.</p>
<p>You can get the version of a single virtual host by providing an optional <code>vhost</code> name.</p>
<p><strong>Note:</strong></p>
<p>  This document <strong>only</strong> applies to systems that run EasyApache 4.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles">Web Server role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="vhost" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">vhost</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">vhost=your-domain.test</span></div><div><div html="&lt;p&gt;The PHP Virtual Hostname.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The PHP Virtual Hostname.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/LangPHP/php_get_vhost_versions</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/LangPHP/php_get_vhost_versions</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99n9dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99n9dq:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R99n9dq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R99n9dq:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R99n9dq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R99n9dq:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R99n9dq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R99n9dq:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99n9dq:0" aria-labelledby="tab:R99n9dq:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  LangPHP <span class="token punctuation">\</span>
  php_get_vhost_versions
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99n9dq:1" aria-labelledby="tab:R99n9dq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99n9dq:2" aria-labelledby="tab:R99n9dq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R99n9dq:3" aria-labelledby="tab:R99n9dq:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pn9dq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pn9dq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pn9dq:0" aria-labelledby="tab:R9pn9dq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;php_get_vhost_versions&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;LangPHP&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"account"</span>: <span class="token string">&quot;blee&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"account_owner"</span>: <span class="token string">&quot;blee&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"documentroot"</span>: <span class="token string">&quot;/home/blee/public_html&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/home/blee&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"main_domain"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"php_fpm"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"php_fpm_pool_parms"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"pm_max_children"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pm_max_requests"</span>: <span class="token number">20</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"pm_process_idle_timeout"</span>: <span class="token number">10</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phpversion_source"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;blee.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"system_default"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">&quot;ea-php72&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"vhost"</span>: <span class="token string">&quot;blee.com&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Handler-Management" data-section-id="tag/Handler-Management" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Handler-Management" aria-label="tag/Handler-Management"></a>Handler Management</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Website Configuration / Handler Management&lt;/p&gt;
"><p>Website Configuration / Handler Management</p>
</div></div></div><div id="tag/Handler-Management/operation/add_handler" data-section-id="tag/Handler-Management/operation/add_handler" class="sc-dntaoT ceciOs"><div data-section-id="operation/add_handler" id="operation/add_handler" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Handler-Management/operation/add_handler" aria-label="tag/Handler-Management/operation/add_handler"></a>Add web server MIME type handler </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function creates an Apache MIME type handler for a file extension.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Web Server&lt;/a&gt; role, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function creates an Apache MIME type handler for a file extension.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Web Server</a> role, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="extension" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">extension</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">extension=.foo</span></div><div><div html="&lt;p&gt;The file extension.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The file extension.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="handler" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">handler</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">handler=txt-foo</span></div><div><div html="&lt;p&gt;The Apache MIME handler.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The Apache MIME handler.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mime/add_handler</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mime/add_handler</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kj3ea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kj3ea:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kj3ea:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj3ea:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kj3ea:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj3ea:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kj3ea:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj3ea:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kj3ea:0" aria-labelledby="tab:R4kj3ea:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mime <span class="token punctuation">\</span>
  add_handler <span class="token punctuation">\</span>
  <span class="token assign-left variable">extension</span><span class="token operator">=</span><span class="token string">'.foo'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">handler</span><span class="token operator">=</span><span class="token string">'txt-foo'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj3ea:1" aria-labelledby="tab:R4kj3ea:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj3ea:2" aria-labelledby="tab:R4kj3ea:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj3ea:3" aria-labelledby="tab:R4kj3ea:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sj3ea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sj3ea:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sj3ea:0" aria-labelledby="tab:R4sj3ea:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;add_handler&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mime&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Handler-Management/operation/delete_handler" data-section-id="tag/Handler-Management/operation/delete_handler" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete_handler" id="operation/delete_handler" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Handler-Management/operation/delete_handler" aria-label="tag/Handler-Management/operation/delete_handler"></a>Remove web server MIME type handler </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function deletes an Apache MIME type handler.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;WebServer role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function deletes an Apache MIME type handler.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">WebServer role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="extension" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">extension</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">extension=.foo</span></div><div><div html="&lt;p&gt;The file extension.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The file extension.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mime/delete_handler</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mime/delete_handler</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kl3ea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kl3ea:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kl3ea:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl3ea:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kl3ea:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl3ea:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kl3ea:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl3ea:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kl3ea:0" aria-labelledby="tab:R4kl3ea:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mime <span class="token punctuation">\</span>
  delete_handler <span class="token punctuation">\</span>
  <span class="token assign-left variable">extension</span><span class="token operator">=</span><span class="token string">'.foo'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl3ea:1" aria-labelledby="tab:R4kl3ea:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl3ea:2" aria-labelledby="tab:R4kl3ea:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl3ea:3" aria-labelledby="tab:R4kl3ea:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sl3ea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sl3ea:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sl3ea:0" aria-labelledby="tab:R4sl3ea:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;delete_handler&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mime&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Handler-Management/operation/list_handlers" data-section-id="tag/Handler-Management/operation/list_handlers" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_handlers" id="operation/list_handlers" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Handler-Management/operation/list_handlers" aria-label="tag/Handler-Management/operation/list_handlers"></a>Return web server&#x27;s MIME handlers </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists all of Apache&amp;#39;s MIME handlers.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;WebServer role&lt;/a&gt;,
  the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists all of Apache&#39;s MIME handlers.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">WebServer role</a>,
  the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="type" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">type</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;system&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;user&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">type=user</span></div><div><div html="&lt;p&gt;Whether to retrieve system or user handlers.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to retrieve system or user handlers.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mime/list_handlers</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mime/list_handlers</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kn3ea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kn3ea:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kn3ea:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn3ea:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kn3ea:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn3ea:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kn3ea:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn3ea:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kn3ea:0" aria-labelledby="tab:R4kn3ea:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mime <span class="token punctuation">\</span>
  list_handlers <span class="token punctuation">\</span>
  <span class="token assign-left variable">type</span><span class="token operator">=</span><span class="token string">'user'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn3ea:1" aria-labelledby="tab:R4kn3ea:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn3ea:2" aria-labelledby="tab:R4kn3ea:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn3ea:3" aria-labelledby="tab:R4kn3ea:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sn3ea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sn3ea:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sn3ea:0" aria-labelledby="tab:R4sn3ea:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_handlers&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mime&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"extension"</span>: <span class="token string">&quot;.foo&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"handler"</span>: <span class="token string">&quot;text-foo&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"origin"</span>: <span class="token string">&quot;user&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Handler-Management/operation/redirect_info" data-section-id="tag/Handler-Management/operation/redirect_info" class="sc-dntaoT ceciOs"><div data-section-id="operation/redirect_info" id="operation/redirect_info" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Handler-Management/operation/redirect_info" aria-label="tag/Handler-Management/operation/redirect_info"></a>Return redirect information </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves redirect information for a URL or &lt;code&gt;** All Public Domains **&lt;/code&gt;.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Web Server role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves redirect information for a URL or <code>** All Public Domains **</code>.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Web Server role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="domain" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">domain</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;domain&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">domain=example.com</span></div><div><div html="&lt;p&gt;The domain for which to retrieve redirector information.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The domain for which to retrieve redirector information.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="url" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">url</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;url&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">url=http://redirect.example.com</span></div><div><div html="&lt;p&gt;The URL for which to retrieve redirector information.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The URL for which to retrieve redirector information.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mime/redirect_info</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mime/redirect_info</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kp3ea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kp3ea:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kp3ea:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp3ea:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kp3ea:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp3ea:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kp3ea:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp3ea:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kp3ea:0" aria-labelledby="tab:R4kp3ea:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mime <span class="token punctuation">\</span>
  redirect_info <span class="token punctuation">\</span>
  <span class="token assign-left variable">url</span><span class="token operator">=</span><span class="token string">'http://redirect.example.com'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">domain</span><span class="token operator">=</span><span class="token string">'example.com'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp3ea:1" aria-labelledby="tab:R4kp3ea:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp3ea:2" aria-labelledby="tab:R4kp3ea:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp3ea:3" aria-labelledby="tab:R4kp3ea:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sp3ea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sp3ea:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sp3ea:0" aria-labelledby="tab:R4sp3ea:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;redirect_info&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mime&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">&quot;</span><a href="http://redirect.example.com">http://redirect.example.com</a><span class="token string">&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Logs" data-section-id="tag/Logs" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Logs" aria-label="tag/Logs"></a>Logs</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Website Configuration / Logs&lt;/p&gt;
"><p>Website Configuration / Logs</p>
</div></div></div><div id="tag/Logs/operation/LogManager_delete_archive" data-section-id="tag/Logs/operation/LogManager_delete_archive" class="sc-dntaoT ceciOs"><div data-section-id="operation/LogManager_delete_archive" id="operation/LogManager_delete_archive" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Logs/operation/LogManager_delete_archive" aria-label="tag/Logs/operation/LogManager_delete_archive"></a>Delete a log archive file </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;Delete a specific log archive file from the authenticated user&amp;#39;s &lt;code&gt;~/logs&lt;/code&gt; directory.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>Delete a specific log archive file from the authenticated user&#39;s <code>~/logs</code> directory.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="file" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">file</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">file=example.com-Aug-2024.gz</span></div><div><div html="&lt;p&gt;The log archive filename to delete. Requirements:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;Must reside in the user&amp;#39;s &lt;code&gt;~/logs&lt;/code&gt; directory.&lt;/li&gt;
&lt;li&gt;Must end with &lt;code&gt;.gz&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;Must not contain path traversal characters.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The log archive filename to delete. Requirements:</p>
<ul>
<li>Must reside in the user&#39;s <code>~/logs</code> directory.</li>
<li>Must end with <code>.gz</code>.</li>
<li>Must not contain path traversal characters.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/LogManager/delete_archive</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/LogManager/delete_archive</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kj5ea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kj5ea:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kj5ea:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj5ea:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kj5ea:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj5ea:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kj5ea:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kj5ea:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kj5ea:0" aria-labelledby="tab:R4kj5ea:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  LogManager <span class="token punctuation">\</span>
  delete_archive <span class="token punctuation">\</span>
  <span class="token assign-left variable">file</span><span class="token operator">=</span>example.com-Aug-2024.gz
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj5ea:1" aria-labelledby="tab:R4kj5ea:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj5ea:2" aria-labelledby="tab:R4kj5ea:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kj5ea:3" aria-labelledby="tab:R4kj5ea:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sj5ea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sj5ea:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sj5ea:0" aria-labelledby="tab:R4sj5ea:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;delete_archive&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;LogManager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Logs/operation/LogManager_get_settings" data-section-id="tag/Logs/operation/LogManager_get_settings" class="sc-dntaoT ceciOs"><div data-section-id="operation/LogManager_get_settings" id="operation/LogManager_get_settings" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Logs/operation/LogManager_get_settings" aria-label="tag/Logs/operation/LogManager_get_settings"></a>Retrieve cPanel account&#x27;s log archival settings </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves the account&amp;#39;s log archival settings.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the account&#39;s log archival settings.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/LogManager/get_settings</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/LogManager/get_settings</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kl5ea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kl5ea:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kl5ea:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl5ea:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kl5ea:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl5ea:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kl5ea:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kl5ea:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kl5ea:0" aria-labelledby="tab:R4kl5ea:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  LogManager <span class="token punctuation">\</span>
  get_settings
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl5ea:1" aria-labelledby="tab:R4kl5ea:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl5ea:2" aria-labelledby="tab:R4kl5ea:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kl5ea:3" aria-labelledby="tab:R4kl5ea:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sl5ea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sl5ea:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sl5ea:0" aria-labelledby="tab:R4sl5ea:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;get_settings&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;LogManager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"archive_logs"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"prune_archive"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"retention_days"</span>: <span class="token number">30</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"using_default"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Logs/operation/LogManager_list_archives" data-section-id="tag/Logs/operation/LogManager_list_archives" class="sc-dntaoT ceciOs"><div data-section-id="operation/LogManager_list_archives" id="operation/LogManager_list_archives" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Logs/operation/LogManager_list_archives" aria-label="tag/Logs/operation/LogManager_list_archives"></a>Return cPanel account&#x27;s archive files list </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function returns a list of the user&amp;#39;s archive files.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function returns a list of the user&#39;s archive files.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/LogManager/list_archives</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/LogManager/list_archives</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kn5ea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kn5ea:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kn5ea:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn5ea:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kn5ea:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn5ea:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kn5ea:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kn5ea:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kn5ea:0" aria-labelledby="tab:R4kn5ea:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  LogManager <span class="token punctuation">\</span>
  list_archives
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn5ea:1" aria-labelledby="tab:R4kn5ea:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn5ea:2" aria-labelledby="tab:R4kn5ea:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kn5ea:3" aria-labelledby="tab:R4kn5ea:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sn5ea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sn5ea:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sn5ea:0" aria-labelledby="tab:R4sn5ea:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_archives&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;LogManager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"file"</span>: <span class="token string">&quot;domain.com-May-2019.gz&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"mtime"</span>: <span class="token number">1557835866</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/home/user/logs/domain.com-May-2019.gz&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Logs/operation/LogManager_set_settings" data-section-id="tag/Logs/operation/LogManager_set_settings" class="sc-dntaoT ceciOs"><div data-section-id="operation/LogManager_set_settings" id="operation/LogManager_set_settings" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Logs/operation/LogManager_set_settings" aria-label="tag/Logs/operation/LogManager_set_settings"></a>Save cPanel account&#x27;s log archive settings </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function saves the account&amp;#39;s log archive settings.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You &lt;strong&gt;must&lt;/strong&gt; pass at least one of the &lt;code&gt;archive_logs&lt;/code&gt;, &lt;code&gt;prune_archive&lt;/code&gt;, or &lt;code&gt;retention_days&lt;/code&gt; parameters.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function saves the account&#39;s log archive settings.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> pass at least one of the <code>archive_logs</code>, <code>prune_archive</code>, or <code>retention_days</code> parameters.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="archive_logs" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">archive_logs</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">archive_logs=1</span></div><div><div html="&lt;p&gt;Whether to archive log files to your home directory after the
system processes statistics.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Archive the logs.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Do &lt;strong&gt;not&lt;/strong&gt; archive the logs.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;This parameter defaults to the &lt;code&gt;archive-logs&lt;/code&gt; setting&amp;#39;s value in the user&amp;#39;s &lt;code&gt;~/.cpanel-logs&lt;/code&gt; file.&lt;/li&gt;
&lt;li&gt;If this file does &lt;strong&gt;not&lt;/strong&gt; exist, this parameter defaults to the &lt;code&gt;default_archive-logs&lt;/code&gt; key&amp;#39;s value in the &lt;a href=&quot;https://go.cpanel.net/cpanelconfiginvalid&quot;&gt;&lt;code&gt;cpanel.config&lt;/code&gt;&lt;/a&gt; file.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to archive log files to your home directory after the
system processes statistics.</p>
<ul>
<li><code>1</code> — Archive the logs.</li>
<li><code>0</code> — Do <strong>not</strong> archive the logs.</li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li>This parameter defaults to the <code>archive-logs</code> setting&#39;s value in the user&#39;s <code>~/.cpanel-logs</code> file.</li>
<li>If this file does <strong>not</strong> exist, this parameter defaults to the <code>default_archive-logs</code> key&#39;s value in the <a href="https://go.cpanel.net/cpanelconfiginvalid"><code>cpanel.config</code></a> file.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="prune_archive" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">prune_archive</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">0</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">1</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">prune_archive=1</span></div><div><div html="&lt;p&gt;Whether to remove the previous month&amp;#39;s archived logs from the &lt;code&gt;~/logs directory&lt;/code&gt; at the end of each month.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;1&lt;/code&gt; — Remove the logs.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Do &lt;strong&gt;not&lt;/strong&gt; remove the logs.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;This parameter defaults to the &lt;code&gt;remove-old-archived-logs&lt;/code&gt; setting&amp;#39;s value in the user&amp;#39;s &lt;code&gt;~/.cpanel-logs&lt;/code&gt; file.&lt;/li&gt;
&lt;li&gt;If this file doesn&amp;#39;t exist, this parameter defaults to the &lt;code&gt;default_remove-old-archive-logs&lt;/code&gt; key&amp;#39;s value in the &lt;a href=&quot;https://go.cpanel.net/cpanelconfiginvalid&quot;&gt;&lt;code&gt;cpanel.config&lt;/code&gt;&lt;/a&gt; file.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>Whether to remove the previous month&#39;s archived logs from the <code>~/logs directory</code> at the end of each month.</p>
<ul>
<li><code>1</code> — Remove the logs.</li>
<li><code>0</code> — Do <strong>not</strong> remove the logs.</li>
</ul>
<p><strong>Note:</strong></p>
<ul>
<li>This parameter defaults to the <code>remove-old-archived-logs</code> setting&#39;s value in the user&#39;s <code>~/.cpanel-logs</code> file.</li>
<li>If this file doesn&#39;t exist, this parameter defaults to the <code>default_remove-old-archive-logs</code> key&#39;s value in the <a href="https://go.cpanel.net/cpanelconfiginvalid"><code>cpanel.config</code></a> file.</li>
</ul>
</div></div></div></td></tr><tr class="last "><td kind="field" title="retention_days" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">retention_days</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR dSZMEh"> &gt;= -1 </span></span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">retention_days=30</span></div><div><div html="&lt;p&gt;The number of days to retain archived log files before automatic removal.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;0&lt;/code&gt; — Retain logs indefinitely.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;-1&lt;/code&gt; — Clear the per-user override and revert to the server default.&lt;/li&gt;
&lt;li&gt;Any positive integer — Retain logs for that many days.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;When not provided, the existing value is preserved.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The number of days to retain archived log files before automatic removal.</p>
<ul>
<li><code>0</code> — Retain logs indefinitely.</li>
<li><code>-1</code> — Clear the per-user override and revert to the server default.</li>
<li>Any positive integer — Retain logs for that many days.</li>
</ul>
<p>When not provided, the existing value is preserved.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/LogManager/set_settings</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/LogManager/set_settings</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4kp5ea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4kp5ea:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R4kp5ea:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp5ea:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R4kp5ea:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp5ea:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R4kp5ea:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4kp5ea:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4kp5ea:0" aria-labelledby="tab:R4kp5ea:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  LogManager <span class="token punctuation">\</span>
  set_settings <span class="token punctuation">\</span>
  <span class="token assign-left variable">archive_logs</span><span class="token operator">=</span><span class="token number">1</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">prune_archive</span><span class="token operator">=</span><span class="token number">1</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">retention_days</span><span class="token operator">=</span><span class="token number">30</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp5ea:1" aria-labelledby="tab:R4kp5ea:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp5ea:2" aria-labelledby="tab:R4kp5ea:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4kp5ea:3" aria-labelledby="tab:R4kp5ea:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4sp5ea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4sp5ea:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4sp5ea:0" aria-labelledby="tab:R4sp5ea:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;set_settings&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;LogManager&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Mime-Type-Management" data-section-id="tag/Mime-Type-Management" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mime-Type-Management" aria-label="tag/Mime-Type-Management"></a>Mime Type Management</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Website Configuration / Mime Type Management&lt;/p&gt;
"><p>Website Configuration / Mime Type Management</p>
</div></div></div><div id="tag/Mime-Type-Management/operation/add_mime" data-section-id="tag/Mime-Type-Management/operation/add_mime" class="sc-dntaoT ceciOs"><div data-section-id="operation/add_mime" id="operation/add_mime" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mime-Type-Management/operation/add_mime" aria-label="tag/Mime-Type-Management/operation/add_mime"></a>Add MIME type to web server </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function adds a MIME type to Apache.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Web Server&lt;/a&gt; role, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function adds a MIME type to Apache.</p>
<p><strong>Important:</strong></p>
<p>When you disable the <a href="https://go.cpanel.net/serverroles">Web Server</a> role, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="extension" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">extension</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">extension=.foo</span></div><div><div html="&lt;p&gt;The file extension.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The file extension.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="type" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">type</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;MIME&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">type=text/foo</span></div><div><div html="&lt;p&gt;The MIME type.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The MIME type.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mime/add_mime</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mime/add_mime</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ab7ea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ab7ea:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ab7ea:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab7ea:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2ab7ea:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab7ea:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2ab7ea:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ab7ea:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ab7ea:0" aria-labelledby="tab:R2ab7ea:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mime <span class="token punctuation">\</span>
  add_mime <span class="token punctuation">\</span>
  <span class="token assign-left variable">type</span><span class="token operator">=</span><span class="token string">'text/foo'</span> <span class="token punctuation">\</span>
  <span class="token assign-left variable">extension</span><span class="token operator">=</span><span class="token string">'.foo'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab7ea:1" aria-labelledby="tab:R2ab7ea:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab7ea:2" aria-labelledby="tab:R2ab7ea:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ab7ea:3" aria-labelledby="tab:R2ab7ea:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eb7ea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eb7ea:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eb7ea:0" aria-labelledby="tab:R2eb7ea:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;add_mime&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mime&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Mime-Type-Management/operation/delete_mime" data-section-id="tag/Mime-Type-Management/operation/delete_mime" class="sc-dntaoT ceciOs"><div data-section-id="operation/delete_mime" id="operation/delete_mime" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mime-Type-Management/operation/delete_mime" aria-label="tag/Mime-Type-Management/operation/delete_mime"></a>Remove MIME type from web server </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function removes a MIME type from Apache.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;WebServer role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function removes a MIME type from Apache.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">WebServer role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="type" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">type</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">type=text/foo</span></div><div><div html="&lt;p&gt;The MIME type.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The MIME type.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mime/delete_mime</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mime/delete_mime</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2ad7ea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ad7ea:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2ad7ea:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ad7ea:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2ad7ea:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ad7ea:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2ad7ea:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2ad7ea:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ad7ea:0" aria-labelledby="tab:R2ad7ea:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mime <span class="token punctuation">\</span>
  delete_mime <span class="token punctuation">\</span>
  <span class="token assign-left variable">type</span><span class="token operator">=</span><span class="token string">'text/foo'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ad7ea:1" aria-labelledby="tab:R2ad7ea:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ad7ea:2" aria-labelledby="tab:R2ad7ea:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2ad7ea:3" aria-labelledby="tab:R2ad7ea:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ed7ea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ed7ea:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ed7ea:0" aria-labelledby="tab:R2ed7ea:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;delete_mime&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mime&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Mime-Type-Management/operation/list_mime" data-section-id="tag/Mime-Type-Management/operation/list_mime" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_mime" id="operation/list_mime" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Mime-Type-Management/operation/list_mime" aria-label="tag/Mime-Type-Management/operation/list_mime"></a>Return web server&#x27;s MIME types </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists all of Apache&amp;#39;s MIME types.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  This function does &lt;strong&gt;not&lt;/strong&gt; list PHP versions with MIME types when the user or domain enables PHP-FPM. The system displays &lt;strong&gt;only&lt;/strong&gt; custom MIME types.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Web Server role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists all of Apache&#39;s MIME types.</p>
<p><strong>Note:</strong></p>
<p>  This function does <strong>not</strong> list PHP versions with MIME types when the user or domain enables PHP-FPM. The system displays <strong>only</strong> custom MIME types.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">Web Server role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class="last "><td kind="field" title="type" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">type</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div><div><span class="sc-CNKsk hPAOR"> Possible Values:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;system&quot;</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">&quot;user&quot;</span> </div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">type=user</span></div><div><div html="&lt;p&gt;The MIME types to list.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;system&lt;/code&gt; — List the Apache system MIME types.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;user&lt;/code&gt; — List the Apache user MIME types.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The MIME types to list.</p>
<ul>
<li><code>system</code> — List the Apache system MIME types.</li>
<li><code>user</code> — List the Apache user MIME types.</li>
</ul>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/Mime/list_mime</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/Mime/list_mime</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2af7ea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2af7ea:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2af7ea:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2af7ea:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2af7ea:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2af7ea:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2af7ea:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2af7ea:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2af7ea:0" aria-labelledby="tab:R2af7ea:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  Mime <span class="token punctuation">\</span>
  list_mime <span class="token punctuation">\</span>
  <span class="token assign-left variable">type</span><span class="token operator">=</span><span class="token string">'user'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2af7ea:1" aria-labelledby="tab:R2af7ea:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2af7ea:2" aria-labelledby="tab:R2af7ea:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2af7ea:3" aria-labelledby="tab:R2af7ea:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ef7ea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ef7ea:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ef7ea:0" aria-labelledby="tab:R2ef7ea:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_mime&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;Mime&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"extension"</span>: <span class="token string">&quot;.foo&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"origin"</span>: <span class="token string">&quot;user&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;application/foo&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Site-Information" data-section-id="tag/Site-Information" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Site-Information" aria-label="tag/Site-Information"></a>Site Information</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Website Configuration / Site Information&lt;/p&gt;
"><p>Website Configuration / Site Information</p>
</div></div></div><div id="tag/Site-Information/operation/WordPressSite::retrieve" data-section-id="tag/Site-Information/operation/WordPressSite::retrieve" class="sc-dntaoT ceciOs"><div data-section-id="operation/WordPressSite::retrieve" id="operation/WordPressSite::retrieve" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Site-Information/operation/WordPressSite::retrieve" aria-label="tag/Site-Information/operation/WordPressSite::retrieve"></a>Return WordPress site information </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function retrieves the installation status and detailed information of the WordPress site for cPanel user&amp;#39;s primary domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function retrieves the installation status and detailed information of the WordPress site for cPanel user&#39;s primary domain.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/WordPressSite/retrieve</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/WordPressSite/retrieve</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R1579ea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R1579ea:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R1579ea:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R1579ea:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R1579ea:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R1579ea:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R1579ea:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R1579ea:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R1579ea:0" aria-labelledby="tab:R1579ea:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  WordPressSite <span class="token punctuation">\</span>
  retrieve
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1579ea:1" aria-labelledby="tab:R1579ea:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1579ea:2" aria-labelledby="tab:R1579ea:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R1579ea:3" aria-labelledby="tab:R1579ea:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R1779ea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R1779ea:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R1779ea:0" aria-labelledby="tab:R1779ea:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;retrieve&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;WordPressSite&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"details"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"install_status"</span>: <span class="token string">&quot;in progress&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Site-Installation" data-section-id="tag/Site-Installation" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Site-Installation" aria-label="tag/Site-Installation"></a>Site Installation</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Website Configuration / Site Installation&lt;/p&gt;
"><p>Website Configuration / Site Installation</p>
</div></div></div><div id="tag/Site-Installation/operation/WordPressSite::create" data-section-id="tag/Site-Installation/operation/WordPressSite::create" class="sc-dntaoT ceciOs"><div data-section-id="operation/WordPressSite::create" id="operation/WordPressSite::create" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Site-Installation/operation/WordPressSite::create" aria-label="tag/Site-Installation/operation/WordPressSite::create"></a>Install WordPress site </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function installs a WordPress site for cPanel user&amp;#39;s primary domain.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function installs a WordPress site for cPanel user&#39;s primary domain.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/WordPressSite/create</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/WordPressSite/create</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R157bea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R157bea:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R157bea:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R157bea:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R157bea:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R157bea:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R157bea:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R157bea:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R157bea:0" aria-labelledby="tab:R157bea:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  WordPressSite <span class="token punctuation">\</span>
  create
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R157bea:1" aria-labelledby="tab:R157bea:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R157bea:2" aria-labelledby="tab:R157bea:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R157bea:3" aria-labelledby="tab:R157bea:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R177bea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R177bea:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R177bea:0" aria-labelledby="tab:R177bea:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;create&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;WordPressSite&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Site-Publisher-Management" data-section-id="tag/Site-Publisher-Management" class="sc-dntaoT pDqvn"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Site-Publisher-Management" aria-label="tag/Site-Publisher-Management"></a>Site Publisher Management</h2></div></div><div class="sc-fAUdSK cREzDu"><div class="sc-epnzzT sc-eMwmJz drsioI fPWJlx redoc-markdown " html="&lt;p&gt;Website Configuration / Site Publisher Management&lt;/p&gt;
"><p>Website Configuration / Site Publisher Management</p>
</div></div></div><div id="tag/Site-Publisher-Management/operation/list_site_templates" data-section-id="tag/Site-Publisher-Management/operation/list_site_templates" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_site_templates" id="operation/list_site_templates" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Site-Publisher-Management/operation/list_site_templates" aria-label="tag/Site-Publisher-Management/operation/list_site_templates"></a>Return available Site Publisher templates </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists available templates for cPanel&amp;#39;s &lt;a href=&quot;https://go.cpanel.net/cpaneldocsSitePublisher&quot;&gt;Site Publisher&lt;/a&gt; feature.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;If you call this function as the &lt;code&gt;root&lt;/code&gt; or &lt;code&gt;system&lt;/code&gt; user, the function lists the &lt;code&gt;root&lt;/code&gt; user&amp;#39;s templates.&lt;/li&gt;
&lt;li&gt;If you call this function as a reseller, the function lists the &lt;code&gt;root&lt;/code&gt; user&amp;#39;s templates &lt;strong&gt;and&lt;/strong&gt; the reseller&amp;#39;s templates.&lt;/li&gt;
&lt;li&gt;If you call this function as a cPanel user, the function&amp;#39;s output depends on the account&amp;#39;s owner:&lt;ul&gt;
&lt;li&gt;If the &lt;code&gt;root&lt;/code&gt; user owns the account, the function only lists the &lt;code&gt;root&lt;/code&gt; user&amp;#39;s templates.&lt;/li&gt;
&lt;li&gt;If a reseller owns the account, the function lists the &lt;code&gt;root&lt;/code&gt; user&amp;#39;s templates &lt;strong&gt;and&lt;/strong&gt; that reseller&amp;#39;s templates.&lt;/li&gt;
&lt;/ul&gt;
&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  The template directory&amp;#39;s location depends on whether the &lt;code&gt;root&lt;/code&gt; user or a reseller owns the template:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;/var/cpanel/customizations/site_templates/&lt;/code&gt; — The &lt;code&gt;root&lt;/code&gt; user&amp;#39;s templates.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;/home/username/var/cpanel/reseller/site_templates/&lt;/code&gt; — A reseller&amp;#39;s templates, where &lt;code&gt;username&lt;/code&gt; represents the reseller&amp;#39;s username.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;/usr/local/cpanel/3rdparty/share/site_templates/&lt;/code&gt; — cPanel-provided templates.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/serverroles&quot;&gt;Web Server role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists available templates for cPanel&#39;s <a href="https://go.cpanel.net/cpaneldocsSitePublisher">Site Publisher</a> feature.</p>
<ul>
<li>If you call this function as the <code>root</code> or <code>system</code> user, the function lists the <code>root</code> user&#39;s templates.</li>
<li>If you call this function as a reseller, the function lists the <code>root</code> user&#39;s templates <strong>and</strong> the reseller&#39;s templates.</li>
<li>If you call this function as a cPanel user, the function&#39;s output depends on the account&#39;s owner:<ul>
<li>If the <code>root</code> user owns the account, the function only lists the <code>root</code> user&#39;s templates.</li>
<li>If a reseller owns the account, the function lists the <code>root</code> user&#39;s templates <strong>and</strong> that reseller&#39;s templates.</li>
</ul>
</li>
</ul>
<p><strong>Note:</strong></p>
<p>  The template directory&#39;s location depends on whether the <code>root</code> user or a reseller owns the template:</p>
<ul>
<li><code>/var/cpanel/customizations/site_templates/</code> — The <code>root</code> user&#39;s templates.</li>
<li><code>/home/username/var/cpanel/reseller/site_templates/</code> — A reseller&#39;s templates, where <code>username</code> represents the reseller&#39;s username.</li>
<li><code>/usr/local/cpanel/3rdparty/share/site_templates/</code> — cPanel-provided templates.</li>
</ul>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/serverroles">Web Server role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SiteTemplates/list_site_templates</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SiteTemplates/list_site_templates</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2abdea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2abdea:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2abdea:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abdea:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2abdea:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abdea:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2abdea:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2abdea:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2abdea:0" aria-labelledby="tab:R2abdea:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SiteTemplates <span class="token punctuation">\</span>
  list_site_templates
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abdea:1" aria-labelledby="tab:R2abdea:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abdea:2" aria-labelledby="tab:R2abdea:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2abdea:3" aria-labelledby="tab:R2abdea:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2ebdea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2ebdea:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2ebdea:0" aria-labelledby="tab:R2ebdea:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_site_templates&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SiteTemplates&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"meta"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"fields"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;fullName&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"label"</span>: <span class="token string">&quot;Full Name&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"placeholder"</span>: <span class="token string">&quot;Your Name&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;text&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"information"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"date"</span>: <span class="token string">&quot;2020-06-30&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">&quot;Single page 'About Me' site&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;about_me&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">&quot;About Me&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"preview_image_path"</span>: <span class="token string">&quot;/preview.png&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/usr/local/cpanel/3rdparty/share/site_templates&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"preview"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"template"</span>: <span class="token string">&quot;about_me&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Site-Publisher-Management/operation/publish" data-section-id="tag/Site-Publisher-Management/operation/publish" class="sc-dntaoT ceciOs"><div data-section-id="operation/publish" id="operation/publish" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Site-Publisher-Management/operation/publish" aria-label="tag/Site-Publisher-Management/operation/publish"></a>Add Site Publisher website </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function publishes a &lt;a href=&quot;https://go.cpanel.net/cpaneldocsSitePublisher&quot;&gt;Site Publisher&lt;/a&gt; website.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;This function uses the &lt;code&gt;/scripts/process_site_template&lt;/code&gt; script to publish the Site Publisher website.&lt;/li&gt;
&lt;li&gt;This function creates the &lt;code&gt;configurations.json&lt;/code&gt; file in the specified directory.&lt;ul&gt;
&lt;li&gt;This file contains the user-entered data for the Site Publisher website and uses &lt;code&gt;0700&lt;/code&gt; permissions.&lt;/li&gt;
&lt;li&gt;For more information, read our &lt;a href=&quot;https://go.cpanel.net/SitePublisherTemplates&quot;&gt;Guide to Site Publisher Templates&lt;/a&gt; documentation.&lt;/li&gt;
&lt;/ul&gt;
&lt;/li&gt;
&lt;li&gt;When users publish a Site Publisher website, the system first creates a backup tarball of the target directory&amp;#39;s contents in the &lt;code&gt;/site_publisher/backups/&lt;/code&gt; directory within the user&amp;#39;s home directory.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Notes:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;When users publish a Site Publisher website, the system logs template information and the target directory to the &lt;code&gt;/usr/local/cpanel/logs/error_log&lt;/code&gt; file.&lt;/li&gt;
&lt;li&gt;The template directory&amp;#39;s location depends on whether the &lt;code&gt;root&lt;/code&gt; user or a reseller owns the template:&lt;ul&gt;
&lt;li&gt;&lt;code&gt;/var/cpanel/customizations/site_templates/&lt;/code&gt; — The &lt;code&gt;root&lt;/code&gt; user&amp;#39;s templates.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;/home/username/var/cpanel/reseller/site_templates/&lt;/code&gt; — A reseller&amp;#39;s templates, where &lt;code&gt;username&lt;/code&gt; represents the reseller&amp;#39;s username.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;/usr/local/cpanel/3rdparty/share/site_templates/&lt;/code&gt; — cPanel-provided templates.&lt;/li&gt;
&lt;/ul&gt;
&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;&lt;em&gt;Web Server&lt;/em&gt;&lt;/a&gt; role, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function publishes a <a href="https://go.cpanel.net/cpaneldocsSitePublisher">Site Publisher</a> website.</p>
<ul>
<li>This function uses the <code>/scripts/process_site_template</code> script to publish the Site Publisher website.</li>
<li>This function creates the <code>configurations.json</code> file in the specified directory.<ul>
<li>This file contains the user-entered data for the Site Publisher website and uses <code>0700</code> permissions.</li>
<li>For more information, read our <a href="https://go.cpanel.net/SitePublisherTemplates">Guide to Site Publisher Templates</a> documentation.</li>
</ul>
</li>
<li>When users publish a Site Publisher website, the system first creates a backup tarball of the target directory&#39;s contents in the <code>/site_publisher/backups/</code> directory within the user&#39;s home directory.</li>
</ul>
<p><strong>Notes:</strong></p>
<ul>
<li>When users publish a Site Publisher website, the system logs template information and the target directory to the <code>/usr/local/cpanel/logs/error_log</code> file.</li>
<li>The template directory&#39;s location depends on whether the <code>root</code> user or a reseller owns the template:<ul>
<li><code>/var/cpanel/customizations/site_templates/</code> — The <code>root</code> user&#39;s templates.</li>
<li><code>/home/username/var/cpanel/reseller/site_templates/</code> — A reseller&#39;s templates, where <code>username</code> represents the reseller&#39;s username.</li>
<li><code>/usr/local/cpanel/3rdparty/share/site_templates/</code> — cPanel-provided templates.</li>
</ul>
</li>
</ul>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles"><em>Web Server</em></a> role, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query Parameters</h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="parameter_name" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">parameter_name</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">parameter_name=My Website</span></div><div><div html="&lt;p&gt;The template&amp;#39;s variables and values.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;Use each variable&amp;#39;s name as a parameter name for a parameter and value pair.&lt;/li&gt;
&lt;li&gt;The template that you specify determines the values to define.&lt;/li&gt;
&lt;li&gt;You &lt;strong&gt;must&lt;/strong&gt; include the appropriate data for the selected template. If you use a cPanel-provided template, read our &lt;a href=&quot;https://go.cpanel.net/guide-to-site-publisher-templates-template-files&quot;&gt;Guide to Site Publisher Templates&lt;/a&gt; documentation for more information. If you use a third-party template, consult that template&amp;#39;s documentation or its &lt;code&gt;meta.json&lt;/code&gt; file.&lt;/li&gt;
&lt;/ul&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The template&#39;s variables and values.</p>
<p><strong>Note:</strong></p>
<ul>
<li>Use each variable&#39;s name as a parameter name for a parameter and value pair.</li>
<li>The template that you specify determines the values to define.</li>
<li>You <strong>must</strong> include the appropriate data for the selected template. If you use a cPanel-provided template, read our <a href="https://go.cpanel.net/guide-to-site-publisher-templates-template-files">Guide to Site Publisher Templates</a> documentation for more information. If you use a third-party template, consult that template&#39;s documentation or its <code>meta.json</code> file.</li>
</ul>
</div></div></div></td></tr><tr class=""><td kind="field" title="path" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">path</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">path=/usr/local/cpanel/3rdparty/share/site_templates/</span></div><div><div html="&lt;p&gt;The directory that contains the template&amp;#39;s source directory.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;/var/cpanel/customizations/site_templates/&lt;/code&gt; — The &lt;code&gt;root&lt;/code&gt; user&amp;#39;s templates.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;/home/username/var/cpanel/reseller/site_templates/&lt;/code&gt; — A reseller&amp;#39;s templates, where &lt;code&gt;username&lt;/code&gt; represents the reseller&amp;#39;s username.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;/usr/local/cpanel/3rdparty/share/site_templates/&lt;/code&gt; — cPanel-provided templates.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You &lt;strong&gt;must&lt;/strong&gt; include either the &lt;code&gt;source&lt;/code&gt; parameter &lt;strong&gt;or&lt;/strong&gt; the &lt;code&gt;path&lt;/code&gt; and &lt;code&gt;template&lt;/code&gt; parameters.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The directory that contains the template&#39;s source directory.</p>
<ul>
<li><code>/var/cpanel/customizations/site_templates/</code> — The <code>root</code> user&#39;s templates.</li>
<li><code>/home/username/var/cpanel/reseller/site_templates/</code> — A reseller&#39;s templates, where <code>username</code> represents the reseller&#39;s username.</li>
<li><code>/usr/local/cpanel/3rdparty/share/site_templates/</code> — cPanel-provided templates.</li>
</ul>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> include either the <code>source</code> parameter <strong>or</strong> the <code>path</code> and <code>template</code> parameters.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="source" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">source</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">source=/usr/local/cpanel/3rdparty/share/site_templates/under_construction</span></div><div><div html="&lt;p&gt;The absolute path to a template directory that exists in one of the following directories:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;/var/cpanel/customizations/site_templates/&lt;/code&gt; — The &lt;code&gt;root&lt;/code&gt; user&amp;#39;s templates.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;/home/username/var/cpanel/reseller/site_templates/&lt;/code&gt; — A reseller&amp;#39;s templates, where &lt;code&gt;username&lt;/code&gt; represents the reseller&amp;#39;s username.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;/usr/local/cpanel/3rdparty/share/site_templates/&lt;/code&gt; — cPanel-provided templates.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;If you do not specify a value, the system uses the path and template values to determine the template&amp;#39;s source directory.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt; You &lt;strong&gt;must&lt;/strong&gt; include either the &lt;code&gt;source&lt;/code&gt; parameter &lt;strong&gt;or&lt;/strong&gt; the &lt;code&gt;path&lt;/code&gt; and &lt;code&gt;template&lt;/code&gt; parameters.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The absolute path to a template directory that exists in one of the following directories:</p>
<ul>
<li><code>/var/cpanel/customizations/site_templates/</code> — The <code>root</code> user&#39;s templates.</li>
<li><code>/home/username/var/cpanel/reseller/site_templates/</code> — A reseller&#39;s templates, where <code>username</code> represents the reseller&#39;s username.</li>
<li><code>/usr/local/cpanel/3rdparty/share/site_templates/</code> — cPanel-provided templates.</li>
</ul>
<p>If you do not specify a value, the system uses the path and template values to determine the template&#39;s source directory.</p>
<p><strong>Note:</strong></p>
<p> You <strong>must</strong> include either the <code>source</code> parameter <strong>or</strong> the <code>path</code> and <code>template</code> parameters.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="target  or  docroot" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">target  or  docroot</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh"> &lt;path&gt; </span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">target  or  docroot=/home/example/public_html</span></div><div><div html="&lt;p&gt;The directory that will contain the Site Publisher website.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The directory that will contain the Site Publisher website.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="template" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">template</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><span class="sc-CNKsk hPAOR"> Example: </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR jSTDDl">template=under_construction</span></div><div><div html="&lt;p&gt;The template&amp;#39;s directory&amp;#39;s name.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You &lt;strong&gt;must&lt;/strong&gt; include either the &lt;code&gt;source&lt;/code&gt; parameter &lt;strong&gt;or&lt;/strong&gt; the &lt;code&gt;path&lt;/code&gt; and &lt;code&gt;template&lt;/code&gt; parameters.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The template&#39;s directory&#39;s name.</p>
<p><strong>Note:</strong></p>
<p>You <strong>must</strong> include either the <code>source</code> parameter <strong>or</strong> the <code>path</code> and <code>template</code> parameters.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SiteTemplates/publish</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SiteTemplates/publish</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2addea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2addea:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2addea:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2addea:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2addea:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2addea:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2addea:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2addea:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2addea:0" aria-labelledby="tab:R2addea:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SiteTemplates <span class="token punctuation">\</span>
  publish <span class="token punctuation">\</span>
  target  or  <span class="token assign-left variable">docroot</span><span class="token operator">=</span><span class="token string">'/home/example/public_html'</span>
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2addea:1" aria-labelledby="tab:R2addea:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2addea:2" aria-labelledby="tab:R2addea:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2addea:3" aria-labelledby="tab:R2addea:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eddea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eddea:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eddea:0" aria-labelledby="tab:R2eddea:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;publish&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SiteTemplates&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Site-Publisher-Management/operation/list_user_settings" data-section-id="tag/Site-Publisher-Management/operation/list_user_settings" class="sc-dntaoT ceciOs"><div data-section-id="operation/list_user_settings" id="operation/list_user_settings" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK jgNMBI"><h2 class="sc-khLCKb dEkAqG"><a class="sc-jwIPbr hbTOAm" href="#tag/Site-Publisher-Management/operation/list_user_settings" aria-label="tag/Site-Publisher-Management/operation/list_user_settings"></a>Return Site Publisher websites&#x27; information </h2><div class="sc-fantwC dGPqXf"><div html="&lt;p&gt;This function lists information for the cPanel account&amp;#39;s &lt;a href=&quot;https://go.cpanel.net/cpaneldocsSitePublisher&quot;&gt;Site Publisher&lt;/a&gt; websites.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  To retrieve the list of Site Publisher website information, the function queries the &lt;code&gt;configurations.json&lt;/code&gt; file in each domain&amp;#39;s document root. For more information, read our &lt;a href=&quot;https://go.cpanel.net/SitePublisherTemplates&quot;&gt;Guide to Site Publisher Templates&lt;/a&gt; documentation.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Important:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;  When you disable the &lt;a href=&quot;https://go.cpanel.net/howtouseserverprofiles#roles&quot;&gt;Web Server role&lt;/a&gt;, the system &lt;strong&gt;disables&lt;/strong&gt; this function.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx"><p>This function lists information for the cPanel account&#39;s <a href="https://go.cpanel.net/cpaneldocsSitePublisher">Site Publisher</a> websites.</p>
<p><strong>Note:</strong></p>
<p>  To retrieve the list of Site Publisher website information, the function queries the <code>configurations.json</code> file in each domain&#39;s document root. For more information, read our <a href="https://go.cpanel.net/SitePublisherTemplates">Guide to Site Publisher Templates</a> documentation.</p>
<p><strong>Important:</strong></p>
<p>  When you disable the <a href="https://go.cpanel.net/howtouseserverprofiles#roles">Web Server role</a>, the system <strong>disables</strong> this function.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy gezKts"><span class="sc-bqvdXA eEDpaQ"><i>BasicAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cfrHSm" aria-expanded="true"><svg class="sc-cHqXqK ibfcMM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200 </strong><div html="&lt;p&gt;HTTP Request was successful.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI fPWJlx sc-drVZOg jtjIAv"><p>HTTP Request was successful.</p>
</div></button><div class="sc-kJZLhT fIJIfR"><h5 class="sc-dpBQxM eJAAZj">Response Schema: <span class="sc-dhCplO khtVmz">application/json</span></h5><table class="sc-dprtRQ hNmabw"><tbody><tr class=""><td kind="field" title="apiversion" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">apiversion</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">integer</span></div> <div><div html="&lt;p&gt;The version of the API.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The version of the API.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="func" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">func</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the method called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the method called.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="module" class="sc-ovuCP sc-eauhAA dEkioI iQpMVv"><span class="sc-gQaihK eDMLOa"></span><span class="property-name">module</span></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">string</span></div> <div><div html="&lt;p&gt;The name of the module called.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>The name of the module called.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="result" class="sc-ovuCP sc-eauhAA sc-hsfCcR dEkioI iQpMVv wPtbb"><span class="sc-gQaihK eDMLOa"></span><button aria-label="expand result"><span class="property-name">result</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl dYBdBR"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR gjyOxn"></span><span class="sc-CNKsk sc-gQkENW hPAOR jHGfFh">object</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"></div></div></div></td></tr></tbody></table></div></div></div></div><div class="sc-ivxoEo sc-ghWlax bhrdmz oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY idEIJX http-verb get">get</span><span class="sc-etPtWW iqHzp">/SiteTemplates/list_user_settings</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="&lt;p&gt;A server running cPanel.&lt;/p&gt;
" class="sc-epnzzT sc-eMwmJz drsioI liva-Dz"><p>A server running cPanel.</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr huWsJW"><span>https://{host}:{port}/execute</span>/SiteTemplates/list_user_settings</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> Request samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R2afdea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2afdea:0" tabindex="0" data-rttab="true">CLI</li><li class="react-tabs__tab" role="tab" id="tab:R2afdea:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2afdea:1" data-rttab="true">URL</li><li class="react-tabs__tab" role="tab" id="tab:R2afdea:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2afdea:2" data-rttab="true">LiveAPI Perl</li><li class="react-tabs__tab" role="tab" id="tab:R2afdea:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2afdea:3" data-rttab="true">LiveAPI PHP</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2afdea:0" aria-labelledby="tab:R2afdea:0"><div class="sc-bbQqnZ jdzthf"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><pre class="sc-epnzzT sc-iwXfZk drsioI geKqvs">uapi <span class="token parameter variable">--output</span><span class="token operator">=</span>jsonpretty <span class="token punctuation">\</span>
  <span class="token parameter variable">--user</span><span class="token operator">=</span>username <span class="token punctuation">\</span>
  SiteTemplates <span class="token punctuation">\</span>
  list_user_settings
</pre></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2afdea:1" aria-labelledby="tab:R2afdea:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2afdea:2" aria-labelledby="tab:R2afdea:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2afdea:3" aria-labelledby="tab:R2afdea:3"></div></div></div><div><h3 class="sc-keTIit zvQzH"> Response samples </h3><div class="sc-bMTdWJ jsZdmN" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2efdea:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2efdea:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2efdea:0" aria-labelledby="tab:R2efdea:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm kjhUaT">Content type</span><div class="sc-UblHX bOGonZ">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hSmBqZ"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"apiversion"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"func"</span>: <span class="token string">&quot;list_user_settings&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"module"</span>: <span class="token string">&quot;SiteTemplates&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"result"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"documentroot"</span>: <span class="token string">&quot;/home/example/public_html&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"domain"</span>: <span class="token string">&quot;example.com&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"homedir"</span>: <span class="token string">&quot;/home/example&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"serveralias"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><span class="token string">&quot;www.example.com&quot;</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"template_settings"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"is_empty"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;/usr/local/cpanel/3rdparty/share/site_templates/&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"template"</span>: <span class="token string">&quot;mytemplate&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">&quot;main&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errors"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"messages"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"transformed"</span>: <span class="token number">1</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"warnings"</span>: <span class="token keyword">null</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div></div><div class="sc-eEVuZf ifLiBE"></div></div></div>
      <script>
      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.2","info":{"contact":{"email":"cs@cpanel.net","name":"WebPros International, LLC","url":"https://cpanel.net/support/"},"description":"UAPI accesses the cPanel interface's features. Use this API to access and modify cPanel account data and settings.","license":{"name":"cPanel License","url":"https://cpanel.net/legal-notices/"},"termsOfService":"https://cpanel.net/legal-notices/","title":"cPanel UAPI","version":null,"x-logo":{"url":"images/docs-api-full.png","altText":"WebPros International, LLC"}},"servers":[{"description":"A server running cPanel.","url":"https://{host}:{port}/execute","variables":{"host":{"default":"cpanel-server.tld","description":"The hostname of a server running cPanel"},"port":{"default":"2083","description":"The cPanel port."}}}],"security":[{"BasicAuth":[]}],"tags":[{"description":"The Account Enhancement module for UAPI.","name":"Account Enhancements"},{"description":"cPanel Account / Account Information","name":"Account Information"},{"description":"cPanel Account / Account Management","name":"Account Management"},{"description":"Optional Applications / Antivirus Protection (ClamAV)","name":"Antivirus Protection (ClamAV)"},{"description":"API Development Tools / API Token Management","name":"API Token Management"},{"description":"cPanel Theme Management / Application Information","name":"Application Information"},{"description":"Web Server Management / Application Manager","name":"Application Manager"},{"description":"The AuditLog module for UAPI.","name":"AuditLog"},{"description":"SSL Certificates / Auto-generated SSL Certificates","name":"Auto-generated SSL Certificates"},{"description":"The Backup module for UAPI.","name":"Backup"},{"description":"The Bandwidth module for UAPI.","name":"Bandwidth"},{"description":"The Batch module for UAPI.","name":"Batch"},{"description":"Block Ip Addresses / Block IP","name":"Block IP"},{"description":"The BlockIP module for UAPI.","name":"BlockIP"},{"description":"The BoxTrapper module for UAPI.","name":"BoxTrapper"},{"description":"cPanel Theme Management / Brand Management","name":"Brand Management"},{"description":"The Branding module for UAPI.","name":"Branding"},{"description":"cPanel Theme Management / Browser Cache Management","name":"Browser Cache Management"},{"description":"The CacheBuster module for UAPI.","name":"CacheBuster"},{"description":"Optional Applications / Calendar and Contacts (DAV)","name":"Calendar and Contacts (DAV)"},{"description":"Optional Applications / Calendar and Contacts Server","name":"Calendar and Contacts Server"},{"description":"The CCS module for UAPI.","name":"CCS"},{"description":"The Chkservd module for UAPI.","name":"Chkservd"},{"description":"The Chrome module for UAPI.","name":"Chrome"},{"description":"The ClamScanner module provides methods for ClamAV® virus scans and disinfection.","name":"ClamScanner"},{"description":"Contact Information","name":"Contact Information"},{"description":"cPanel Account / Contact Information","name":"Contact Information"},{"description":"The ContactInformation module for UAPI.","name":"ContactInformation"},{"description":"The Contactus module for UAPI.","name":"Contactus"},{"description":"The cPAddons module for UAPI.","name":"cPAddons"},{"description":"SSL Certificates / cPanel Account SSL Management","name":"cPanel Account SSL Management"},{"description":"Optional Applications / cPanel Addons (cPAddons)","name":"cPanel Addons (cPAddons)"},{"description":"cPanel Account / cPanel Features","name":"cPanel Features"},{"description":"Server Information / Server Information","name":"cPanel Server Information"},{"description":"Server Information / cPanel Server Information","name":"cPanel Server Information"},{"description":"The CPDAVD module for UAPI.","name":"CPDAVD"},{"description":"The cPGreyList module for UAPI.","name":"cPGreyList"},{"description":"The CSVImport module for UAPI.","name":"CSVImport"},{"description":"MySQL and MariaDB / Database Information","name":"Database Information"},{"description":"MySQL and MariaDB / Database Management","name":"Database Management"},{"description":"The DAV module for UAPI.","name":"DAV"},{"description":"The DCV module for UAPI.","name":"DCV"},{"description":"GIT Management / Deployment Settings","name":"Deployment Settings"},{"description":"Domain Management / Direct Link Protection (Hotlink)","name":"Direct Link Protection (Hotlink)"},{"description":"Directory Management / Directory Indexes","name":"Directory Indexes"},{"description":"Directory Management / Directory Privacy","name":"Directory Privacy"},{"description":"Directory Management / Directory Protection","name":"Directory Protection"},{"description":"The DirectoryIndexes module for UAPI.","name":"DirectoryIndexes"},{"description":"The DirectoryPrivacy module for UAPI.","name":"DirectoryPrivacy"},{"description":"The DirectoryProtection module for UAPI.","name":"DirectoryProtection"},{"description":"cPanel Account / Disk Quotas","name":"Disk Quotas"},{"description":"The DNS module for UAPI.","name":"DNS"},{"description":"DNS / DNS Information","name":"DNS Information"},{"description":"DNS / DNS Security","name":"DNS Security"},{"description":"The DNSSEC module for UAPI.","name":"DNSSEC"},{"description":"Domain Management / Domain Information","name":"Domain Information"},{"description":"Domain Management / Domain Redirection","name":"Domain Redirection"},{"description":"Statistics / Domain Statistics","name":"Domain Statistics"},{"description":"The DomainInfo module for UAPI.","name":"DomainInfo"},{"description":"DNS / Dynamic DNS","name":"Dynamic DNS"},{"description":"The DynamicDNS module for UAPI.","name":"DynamicDNS"},{"description":"The EA4 module for UAPI.","name":"EA4"},{"description":"Web Server Configuration / EasyApache Settings","name":"EasyApache Settings"},{"description":"The Email module for UAPI.","name":"Email"},{"description":"Email / Email Accounts","name":"Email Accounts"},{"description":"DNS / Email DNS Settings","name":"Email DNS Settings"},{"description":"Email / Email Filtering","name":"Email Filtering"},{"description":"Email / Email Forwarding","name":"Email Forwarding"},{"description":"Email / Email Server Information","name":"Email Server Information"},{"description":"Email / Email Server Information.","name":"Email Server Information"},{"description":"Email / Email Suspensions","name":"Email Suspensions"},{"description":"The EmailAuth module for UAPI.","name":"EmailAuth"},{"description":"Authentication / External Authentication","name":"External Authentication"},{"description":"The ExternalAuthentication module for UAPI.","name":"ExternalAuthentication"},{"description":"The Features module for UAPI.","name":"Features"},{"description":"cPanel Account Backups / File Restoration","name":"File Restoration"},{"description":"The Fileman module for UAPI.","name":"Fileman"},{"description":"The Ftp module for UAPI.","name":"Ftp"},{"description":"The FTP module for UAPI.","name":"Ftp"},{"description":"Files / FTP Accounts","name":"FTP Accounts"},{"description":"Files / FTP Server Settings","name":"FTP Server Settings"},{"description":"The GPG module for UAPI.","name":"GPG"},{"description":"Website Configuration / Handler Management","name":"Handler Management"},{"description":"Files / Image Tools","name":"Image Tools"},{"description":"The ImageManager module for UAPI.","name":"ImageManager"},{"description":"The Integration module for UAPI.","name":"Integration"},{"description":"Security / Known SSH Hosts Management","name":"Known SSH Hosts Management"},{"description":"The KnownHosts module for UAPI.","name":"KnownHosts"},{"description":"The LangPHP module for UAPI.","name":"LangPHP"},{"description":"cPanel Theme Management / Language","name":"Language"},{"description":"The LastLogin module for UAPI.","name":"LastLogin"},{"name":"Leika","description":"Configuration management for the Leika module."},{"description":"The Locale module for UAPI.","name":"Locale"},{"description":"Security / Login Information","name":"Login Information"},{"description":"The LogManager module for UAPI.","name":"LogManager"},{"description":"Website Configuration / Logs","name":"Logs"},{"description":"Email / Mail Server Information","name":"Mail Server Information"},{"description":"Email / Mailbox Management","name":"Mailbox Management"},{"description":"The Mailboxes module for UAPI.","name":"Mailboxes"},{"description":"Email / Mailing Lists","name":"Mailing Lists"},{"description":"Files / Manage Files","name":"Manage Files"},{"description":"The Market module for UAPI.","name":"Market"},{"description":"Commerce Integration / Market Integration","name":"Market Integration"},{"description":"The Mime module for UAPI.","name":"Mime"},{"description":"Website Configuration / Mime Type Management","name":"Mime Type Management"},{"description":"The ModSecurity module for UAPI.","name":"ModSecurity"},{"description":"The Mysql module for UAPI.","name":"Mysql"},{"description":"The NginxCaching module for UAPI.","name":"NginxCaching"},{"description":"The Notifications module for UAPI.","name":"Notifications"},{"description":"The NVData module for UAPI.","name":"NVData"},{"description":"The Parser module for UAPI.","name":"Parser"},{"description":"The PassengerApps module for UAPI.","name":"PassengerApps"},{"description":"The PasswdStrength module for UAPI.","name":"PasswdStrength"},{"description":"Server Information / Password Strength","name":"Password Strength"},{"description":"The Personalization module for UAPI.","name":"Personalization"},{"description":"PHP recommendations","name":"PHP"},{"description":"Web Server Management / PHP Settings","name":"PHP Settings"},{"description":"The Postgresql module for UAPI.","name":"Postgresql"},{"description":"PostgreSQL / Database Management","name":"PostgreSQL Database Management"},{"description":"PostgreSQL / User Management","name":"PostgreSQL User Management"},{"description":"The Pushbullet module for UAPI.","name":"Pushbullet"},{"description":"The Quota module for UAPI.","name":"Quota"},{"description":"MySQL and MariaDB / Remote Databases","name":"Remote Databases"},{"description":"GIT Management / Repository Management","name":"Repository Management"},{"description":"The Resellers module for UAPI.","name":"Resellers"},{"description":"cPanel Account / Resource Usage and Statistics","name":"Resource Usage and Statistics"},{"description":"The ResourceUsage module for UAPI.","name":"ResourceUsage"},{"description":"The ServerInformation module for UAPI.","name":"ServerInformation"},{"description":"Service Proxy","name":"Service Proxy"},{"description":"The ServiceProxy module for UAPI.","name":"ServiceProxy"},{"description":"The Session module for UAPI.","name":"Session"},{"description":"Email / Signing and Encryption (GnuPG Keys)","name":"Signing and Encryption (GnuPG Keys)"},{"description":"Website Configuration / Site Information","name":"Site Information"},{"description":"Website Configuration / Site Installation","name":"Site Installation"},{"description":"Website Configuration / Site Publisher Management","name":"Site Publisher Management"},{"description":"The SiteTemplates module for UAPI.","name":"SiteTemplates"},{"description":"SSL Certificates / SNI Email Settings","name":"SNI Email Settings"},{"description":"Email / Spam Filtering (Greylisting)","name":"Spam Filtering (Greylisting)"},{"description":"Email / Spam Management","name":"Spam Management"},{"description":"Email / Spam Prevention (BoxTrapper)","name":"Spam Prevention (BoxTrapper)"},{"description":"The SpamAssassin module for UAPI.","name":"SpamAssassin"},{"description":"API Development Tools / SSE Task Management","name":"SSE Task Management"},{"description":"The SSH module for UAPI.","name":"SSH"},{"description":"The SSL module for UAPI.","name":"SSL"},{"description":"SSL Certificates / SSL Certificate Management","name":"SSL Certificate Management"},{"description":"Commerce Integration / SSL Certificates","name":"SSL Certificates"},{"description":"The Stats module for UAPI.","name":"Stats"},{"description":"The StatsBar module for UAPI.","name":"StatsBar"},{"description":"The StatsManager module for UAPI.","name":"StatsManager"},{"description":"cPanel Account / Subaccount Management","name":"Subaccount Management"},{"description":"The SubDomain module for UAPI.","name":"SubDomain"},{"description":"The Team Roles module for UAPI.","name":"Team Roles"},{"description":"The Team User module for UAPI.","name":"Team Users"},{"description":"cPanel Theme Management / Theme Settings","name":"Theme Settings"},{"description":"The Themes module for UAPI.","name":"Themes"},{"description":"The Tokens module for UAPI.","name":"Tokens"},{"description":"Authentication / Two-Factor Settings","name":"Two-Factor Settings"},{"description":"The TwoFactorAuth module for UAPI.","name":"TwoFactorAuth"},{"description":"API Development Tools / URL Parsing","name":"URL Parsing"},{"description":"MySQL and MariaDB / User Management","name":"User Management"},{"description":"The UserManager module for UAPI.","name":"UserManager"},{"description":"The UserTasks module for UAPI.","name":"UserTasks"},{"description":"The Variables module for UAPI.","name":"Variables"},{"description":"SSL Certificates / Verify Domain Ownership","name":"Verify Domain Ownership"},{"description":"The VersionControl module for UAPI.","name":"VersionControl"},{"description":"The VersionControlDeployment module for UAPI.","name":"VersionControlDeployment"},{"description":"Domain Management / Virtual Host Information","name":"Virtual Host Information"},{"description":"The WebDisk module for UAPI.","name":"WebDisk"},{"description":"Files / WebDisk Settings","name":"WebDisk Settings"},{"description":"Statistics / Weblog Settings","name":"Weblog Settings"},{"description":"Email / Webmail Applications","name":"Webmail Applications"},{"description":"Email / Webmail Sessions","name":"Webmail Sessions"},{"description":"The WebmailApps module for UAPI.","name":"WebmailApps"},{"description":"The WebVhosts module for UAPI.","name":"WebVhosts"},{"description":"Optional Applications / WordPress Manager Backups","name":"WordPress Manager Backups"},{"description":"Optional Applications / WordPress Manager Settings","name":"WordPress Manager Settings"},{"description":"The WordPressBackup module for UAPI.","name":"WordPressBackup"},{"description":"The WordPressInstanceManager module for UAPI.","name":"WordPressInstanceManager"},{"description":"The WordPressRestore module for UAPI.","name":"WordPressRestore"},{"description":"The WordPressSite module for UAPI.","name":"WordPressSite"}],"externalDocs":{"url":"https://cpanel.net/developers/"},"paths":{"/DirectoryIndexes/get_indexing":{"get":{"description":"This function returns the directory indexing settings for a directory on the cPanel account and its subdirectories.","operationId":"get_indexing","parameters":[{"description":"The directory for which to check the indexing type.","in":"query","name":"dir","required":true,"schema":{"example":"/home/example/example.com","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_indexing","type":"string"},"module":{"description":"The name of the module called.","example":"DirectoryIndexes","type":"string"},"result":{"properties":{"data":{"description":"The directory's indexing type.\n- standard  The directory uses directory indexing with standard formatting.\n- disabled  The directory doesn't use directory indexing.\n- inherit  The directory uses the system's default settings.\n- fancy  The directory uses directory indexing with Apache FancyIndexing directive. The directory will include additional information such as file size and the date of the file's last update.","example":"disabled","type":"string"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return directory indexing settings","tags":["DirectoryIndexes","Directory Indexes"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DirectoryIndexes \\\n  get_indexing \\\n  dir='/home/example/example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DirectoryIndexes/get_indexing?dir=%2fhome%2fexample%2fexample.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DirectoryIndexes_get_indexing.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DirectoryIndexes_get_indexing.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DirectoryIndexes/,\n    q/get_indexing/,\n    {\n        'dir' => '/home/example/example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DirectoryIndexes_get_indexing.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DirectoryIndexes_get_indexing.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DirectoryIndexes',\n    'get_indexing',\n    array (\n        'dir' => '/home/example/example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 88"}},"/DirectoryIndexes/list_directories":{"get":{"description":"This function returns the [directory indexing](https://go.cpanel.net/cpaneldocsIndexes) settings of the subdirectories in a directory.","operationId":"DirectoryIndexes-list_directories","parameters":[{"description":"The absolute path of the directory for which to return indexing information.","in":"query","name":"dir","required":true,"schema":{"example":"/home/example/example.com","format":"path","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_directories","type":"string"},"module":{"description":"The name of the module called.","example":"DirectoryIndexes","type":"string"},"result":{"properties":{"data":{"properties":{"children":{"description":"Subdirectories and their indexing information.\n\n**Note:**\n\nThe function returns an object for each subdirectory in a directory.","items":{"properties":{"path":{"description":"The subdirectory's absolute path.","example":"/home/example/example.com/cgi-bin","format":"path","type":"string"},"state":{"description":"The subdirectory's indexing information.","properties":{"index_type":{"$ref":"#/components/schemas/index_type"}},"type":"object"}},"type":"object"},"type":"array"},"current":{"description":"The user's current directory and its indexing information.","properties":{"path":{"description":"The current directory's absolute path.","example":"/home/example/example.com","format":"path","type":"string"},"state":{"description":"The current directory's indexing information.","properties":{"index_type":{"$ref":"#/components/schemas/index_type"}},"type":"object"}},"type":"object"},"home":{"description":"The user's home directory and its indexing information.","properties":{"path":{"description":"The home directory's absolute path.","example":"/home/example","format":"path","type":"string"},"state":{"description":"An object containing the home directory's indexing information.","properties":{"index_type":{"$ref":"#/components/schemas/index_type"}},"type":"object"}},"type":"object"},"parent":{"description":"The current directory’s parent directory and its indexing information.","properties":{"path":{"description":"The parent directory's absolute path.","example":"/home/example","format":"path","type":"string"},"state":{"description":"The parent directory's indexing information.","properties":{"index_type":{"$ref":"#/components/schemas/index_type"}},"type":"object"}},"type":"object"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return subdirectories directory indexing settings","tags":["DirectoryIndexes","Directory Indexes"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DirectoryIndexes \\\n  list_directories \\\n  dir='/home/example/example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DirectoryIndexes/list_directories?dir=%2fhome%2fexample%2fexample.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DirectoryIndexes_list_directories.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DirectoryIndexes_list_directories.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DirectoryIndexes/,\n    q/list_directories/,\n    {\n        'dir' => '/home/example/example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DirectoryIndexes_list_directories.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DirectoryIndexes_list_directories.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DirectoryIndexes',\n    'list_directories',\n    array (\n        'dir' => '/home/example/example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 88"}},"/Postgresql/update_privileges":{"get":{"description":"This function synchronizes PostgreSQL® database user privileges on an account.\n\nSome versions of PostgreSQL are ANSI SQL-92 compliant and do not support recursive grants,\nwildcard grants, or future grants. If you use phpPgAdmin, or manually create new tables, and\nyou want multiple PostgreSQL users to access your PostgreSQL tables, you may either call this\nAPI function or click _Synchronize Grants_ in the _PostgreSQL Databases_ interface\n(_Home >> Databases >> PostgreSQL Databases_) after you add a table.\n\n**Important:**\n\nWhen you disable the [PostgreSQL role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"Postgresql-update_privileges","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"update_privileges","type":"string"},"module":{"description":"The name of the module called.","example":"Postgresql","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update PostgreSQL® privileges","tags":["Postgresql","PostgreSQL User Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Postgresql \\\n  update_privileges\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Postgresql/update_privileges"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Postgresql_update_privileges.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Postgresql_update_privileges.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Postgresql/,\n    q/update_privileges/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Postgresql_update_privileges.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Postgresql_update_privileges.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Postgresql',\n    'update_privileges'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 84"}},"/Mysql/update_privileges":{"get":{"description":"This function updates privileges for all MySQL® databases and users on an account.\n\n**Important:**\n\nWhen you disable the [MySQL/MariaDB role](https://go.cpanel.net/serverroles) **and**\nremote MySQL is **not** configured, the system **disables** this function.","operationId":"Mysql-update_privileges","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"update_privileges","type":"string"},"module":{"description":"The name of the module called.","example":"Mysql","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update MySQL® privileges","tags":["Mysql","Database Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mysql \\\n  update_privileges\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mysql/update_privileges"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mysql_update_privileges.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Mysql_update_privileges.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mysql/,\n    q/update_privileges/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mysql_update_privileges.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Mysql_update_privileges.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mysql',\n    'update_privileges'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82","x-cpanel-internal-only":false}},"/DirectoryPrivacy/is_directory_protected":{"get":{"description":"This function confirms whether a directory uses password protection.","operationId":"is_directory_protected","parameters":[{"description":"The absolute directory path on the cPanel account to check for password protection.","in":"query","name":"dir","required":true,"schema":{"example":"/home/example/example.com","format":"path","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"is_directory_protected","type":"string"},"module":{"description":"The name of the module called.","example":"DirectoryPrivacy","type":"string"},"result":{"properties":{"data":{"properties":{"auth_name":{"description":"The authentication resource name.","example":"Protected 'example.com'","type":"string"},"auth_type":{"description":"The directory's authentication type.\n* `Basic`\n* `None`","enum":["Basic","None"],"example":"Basic","type":"string"},"passwd_file":{"description":"The path to the directory's password file.","example":"/home/example/.htpasswds/example.com/passwd","format":"path","type":"string"},"protected":{"description":"Whether the directory uses password protection.\n* `1` - Protected.\n* `0` - **Not** protected.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return whether directory uses password protection","tags":["DirectoryPrivacy","Directory Privacy"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DirectoryPrivacy \\\n  is_directory_protected \\\n  dir='/home/example/example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DirectoryPrivacy/is_directory_protected?dir=%2fhome%2fexample%2fexample.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DirectoryPrivacy_is_directory_protected.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DirectoryPrivacy_is_directory_protected.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DirectoryPrivacy/,\n    q/is_directory_protected/,\n    {\n        'dir' => '/home/example/example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DirectoryPrivacy_is_directory_protected.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DirectoryPrivacy_is_directory_protected.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DirectoryPrivacy',\n    'is_directory_protected',\n    array (\n        'dir' => '/home/example/example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 88"}},"/DirectoryPrivacy/list_users":{"get":{"description":"This function returns the users who can access a password-protected directory on the cPanel account.","operationId":"DirectoryPrivacy::list_users","parameters":[{"description":"The password-protected directory for which to return authorized users.","in":"query","name":"dir","required":true,"schema":{"example":"/home/example/example.com","format":"path","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_users","type":"string"},"module":{"description":"The name of the module called.","example":"DirectoryPrivacy","type":"string"},"result":{"properties":{"data":{"description":"list of users who can access the directory.","example":["example1","example2"],"items":{"type":"string"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return authorized users for protected directory","tags":["DirectoryPrivacy","Directory Privacy"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DirectoryPrivacy \\\n  list_users \\\n  dir='/home/example/example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DirectoryPrivacy/list_users?dir=%2fhome%2fexample%2fexample.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DirectoryPrivacy_list_users.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DirectoryPrivacy_list_users.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DirectoryPrivacy/,\n    q/list_users/,\n    {\n        'dir' => '/home/example/example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DirectoryPrivacy_list_users.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DirectoryPrivacy_list_users.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DirectoryPrivacy',\n    'list_users',\n    array (\n        'dir' => '/home/example/example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 88"}},"/DirectoryPrivacy/list_directories":{"get":{"description":"This function returns the privacy status of the subdirectories in a directory.","operationId":"DirectoryPrivacy-list_directories","parameters":[{"description":"The directory path for which to return the subdirectories' privacy information.","in":"query","name":"dir","required":true,"schema":{"example":"/home/example/example.com","format":"path","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_directories","type":"string"},"module":{"description":"The name of the module called.","example":"DirectoryPrivacy","type":"string"},"result":{"properties":{"data":{"properties":{"children":{"description":"An array of objects containing subdirectories and their privacy\ninformation.\n\n**Note:**\n\nThe function returns an object for each subdirectory in a directory.","items":{"properties":{"path":{"description":"The subdirectory's directory path.","example":"/home/example/example.com/cgi-bin","format":"path","type":"string"},"state":{"description":"The subdirectory's privacy information.","properties":{"auth_name":{"description":"The authentication resource name.","example":"Protected 'example.com'","type":"string"},"auth_type":{"description":"The subdirectory's authentication type.\n\n* `Basic`\n* `None`","enum":["Basic","None"],"example":"Basic","type":"string"},"passwd_file":{"description":"The absolute file path to the subdirectory's password file.","example":"/home/example/.htpasswds/example.com/passwd","format":"path","type":"string"},"protected":{"description":"Whether the subdirectory is protected.\n\n* `1` — Protected.\n* `0` — **Not** protected.","enum":[1,0],"example":1,"type":"integer"}},"type":"object"}},"type":"object"},"type":"array"},"current":{"description":"The user's current directory and its privacy information.","properties":{"path":{"description":"The current directory's path.","example":"/home/example/example.com","format":"path","type":"string"},"state":{"description":"The current subdirectory's privacy information.","properties":{"auth_name":{"description":"The authentication resource name.","example":"protected","type":"string"},"auth_type":{"description":"The directory's authentication type.\n\n* `Basic`\n* `None`","enum":["Basic","None"],"example":"Basic","type":"string"},"passwd_file":{"description":"The absolute file path to the directory's password file.","example":"/home/example/.htpasswds/example.com/passwd","format":"path","type":"string"},"protected":{"description":"Whether the directory is protected.\n\n* `1` — Protected.\n* `0` — **Not** protected.","enum":[1,0],"example":1,"type":"integer"}},"type":"object"}},"type":"object"},"home":{"description":"The user's home directory and its privacy information.","properties":{"path":{"description":"The home directory's absolute path.","example":"/home/example","format":"path","type":"string"},"state":{"description":"The home directory's privacy information.","properties":{"auth_name":{"description":"The authentication resource name.","example":"protected","type":"string"},"auth_type":{"description":"The home directory's authentication type.\n\n* `Basic`\n* `None`","enum":["Basic","None"],"example":"Basic","type":"string"},"passwd_file":{"description":"The absolute file path to the home directory's password file.","example":"/home/example/.htpasswds/example.com/passwd","format":"path","type":"string"},"protected":{"description":"Whether the home directory is protected.\n\n* `1` — Protected.\n* `0` — **Not** protected.","enum":[1,0],"example":1,"type":"integer"}},"type":"object"}},"type":"object"},"parent":{"description":"The parent directory of the current directory and its privacy information.","properties":{"path":{"description":"The parent directory's absolute directory path.","example":"/home/example","format":"path","type":"string"},"state":{"description":"The parent directory's privacy information.","properties":{"auth_name":{"description":"The authentication resource name.","example":"protected","type":"string"},"auth_type":{"description":"The parent directory's authentication type.\n\n* `Basic`\n* `None`","enum":["Basic","None"],"example":"Basic","type":"string"},"passwd_file":{"description":"The absolute file path to the parent directory's password file.","example":"/home/example/.htpasswds/example.com/passwd","format":"path","type":"string"},"protected":{"description":"Whether the subdirectory is protected.\n\n* `1` — Protected.\n* `0` — **Not** protected.","enum":[1,0],"example":1,"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return privacy status of subdirectories","tags":["DirectoryPrivacy","Directory Privacy"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DirectoryPrivacy \\\n  list_directories \\\n  dir='/home/example/example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DirectoryPrivacy/list_directories?dir=%2fhome%2fexample%2fexample.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DirectoryPrivacy_list_directories.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DirectoryPrivacy_list_directories.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DirectoryPrivacy/,\n    q/list_directories/,\n    {\n        'dir' => '/home/example/example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DirectoryPrivacy_list_directories.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DirectoryPrivacy_list_directories.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DirectoryPrivacy',\n    'list_directories',\n    array (\n        'dir' => '/home/example/example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 88"}},"/DirectoryProtection/list_directories":{"get":{"description":"This function returns the\n[leech protection](https://go.cpanel.net/cpaneldocsLeechProtection)\nsettings of the subdirectories in a directory.","operationId":"DirectoryProtection-list_directories","parameters":[{"description":"The absolute or relative file path in the user's `home` directory for which to return leech protection information.","in":"query","name":"dir","required":true,"schema":{"example":"/home/example/example.com","format":"path","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_directories","type":"string"},"module":{"description":"The name of the module called.","example":"DirectoryProtection","type":"string"},"result":{"properties":{"data":{"properties":{"children":{"description":"A list of subdirectories and their leech protection information.\n\n**Note:**\n\nThe function returns a list for each subdirectory in a directory.","items":{"properties":{"path":{"description":"The subdirectory's absolute directory path.","example":"/home/example/example.com/cgi-bin","format":"path","type":"string"},"state":{"description":"A object containing the subdirectory's leech protection information.","properties":{"has_leech_protection":{"description":"The directory's leech protection status.\n\n* `1` — Leech protection is enabled.\n* `0` — Leech protection is disabled.","enum":[1,0],"example":1,"type":"integer"}},"type":"object"}},"type":"object"},"type":"array"},"current":{"description":"The user's current directory and its leech protection information.","properties":{"path":{"description":"The current directory's absolute file path.","example":"/home/example/example.com","format":"path","type":"string"},"state":{"description":"An object containing the current directory's leech protection information.","properties":{"has_leech_protection":{"description":"The current directory's leech protection status.\n\n* `1` — Leech protection is enabled.\n* `0` — Leech protection is disabled.","enum":[1,0],"example":1,"type":"integer"}},"type":"object"}},"type":"object"},"home":{"description":"The user's `home` directory and its leech protection information.","properties":{"path":{"description":"The `home` directory's absolute directory path.","example":"/home/example","format":"path","type":"string"},"state":{"description":"A object containing the `home` directory's leech protection information.","properties":{"has_leech_protection":{"description":"The home directory's leech protection status.\n\n* `1` — Leech protection is enabled.\n* `0` — Leech protection is disabled.","enum":[1,0],"example":1,"type":"integer"}},"type":"object"}},"type":"object"},"parent":{"description":"The parent directory of the current directory and its leech protection information.","properties":{"path":{"description":"The parent directory's absolute directory path.","example":"/home/example","format":"path","type":"string"},"state":{"description":"An object containing the parent directory's leech protection information.","properties":{"has_leech_protection":{"description":"The parent directory's leech protection status.\n\n* `1` — Leech protection is enabled.\n* `0` — Leech protection is disabled.","enum":[1,0],"example":1,"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return Directory Protection settings","tags":["DirectoryProtection","Directory Protection"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DirectoryProtection \\\n  list_directories \\\n  dir='/home/example/example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DirectoryProtection/list_directories?dir=%2fhome%2fexample%2fexample.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DirectoryProtection_list_directories.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DirectoryProtection_list_directories.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DirectoryProtection/,\n    q/list_directories/,\n    {\n        'dir' => '/home/example/example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DirectoryProtection_list_directories.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DirectoryProtection_list_directories.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DirectoryProtection',\n    'list_directories',\n    array (\n        'dir' => '/home/example/example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 88"}},"/DomainInfo/domains_data":{"get":{"description":"This function lists user data for the cPanel account's domains.\n\n**Note:**\n\nThis function retrieves data from the `/var/cpanel/userdata/user/domain` file, where `user`\nrepresents the cPanel account username and `domain` represents the domain. For this reason,\nactual output may not contain all of the returns that this document lists.","operationId":"domains_data","parameters":[{"description":"The function's return format.\n\n* `hash` — Use a hash format. The function will return objects based on the domain type.\n* `list` — Use a list format. The function will return an array of objects, where each object is a domain.","in":"query","name":"format","required":false,"schema":{"default":"hash","enum":["hash","list"],"example":"hash","type":"string"}},{"description":"Whether to return the secure redirect status of the addon domains.\n\n* `1` — Return the status.\n* `0` — Do **not** return the status.","in":"query","name":"return_https_redirects_status","required":false,"schema":{"default":0,"enum":[1,0],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"hash":{"summary":"Output in hash return format.","value":{"data":{"addon_domains":[{"all_aliases_valid":"0","can_https_redirect":"0","documentroot":"/home/user/public_html/seconddomain.com","domain":"seconddomain.com","group":"user","hascgi":"1","homedir":"/home/user","ip":"192.168.0.128","ipv6":null,"is_https_redirecting":"0","no_cache_update":"0","owner":"root","serveradmin":"webmaster@seconddomain.example.com","serveralias":"seconddomain.com www.seconddomain.com www.seconddomain.example.com","servername":"seconddomain.example.com","type":"addon_domain","usecanonicalname":"Off","user":"user","userdirprotect":""},{"all_aliases_valid":"0","can_https_redirect":"0","documentroot":"/home/user/public_html/subdomain","domain":"exampledomain.com","group":"user","hascgi":"1","homedir":"/home/user","ip":"192.168.0.128","ipv6":null,"is_https_redirecting":"0","no_cache_update":"0","owner":"root","serveradmin":"webmaster@subdomain.example.com","serveralias":"exampledomain.com www.exampledomain.com www.subdomain.example.com","servername":"subdomain.example.com","type":"addon_domain","usecanonicalname":"Off","user":"user","userdirprotect":""},{"all_aliases_valid":"0","can_https_redirect":"0","documentroot":"/home/user/addondomain/home/dir","domain":"addondomain.com","group":"user","hascgi":"1","homedir":"/home/user","ip":"192.168.0.128","ipv6":null,"is_https_redirecting":"0","main_domain":{"all_aliases_valid":"0","can_https_redirect":"0","customlog":[{"format":"combined","target":"/usr/local/apache/domlogs/example.com"},{"format":"\"%{%s}t %I .\\n%{%s}t %O .\"","target":"/usr/local/apache/domlogs/example.com-bytes_log"}],"documentroot":"/home/user/public_html","domain":"example.com","group":"user","hascgi":"1","homedir":"/home/user","ifmodulemodsuphpc":{"group":"user"},"ip":"192.168.0.128","is_https_redirecting":"0","options":"ExecCGI Includes","owner":"root","port":"80","scriptalias":[{"path":"/home/user/public_html/cgi-bin","url":"/cgi-bin/"},{"path":"/home/user/public_html/cgi-bin/","url":"/cgi-bin/"}],"serveradmin":"webmaster@example.com","serveralias":"parkeddomain.com www.parkeddomain.com www.example.com","servername":"example.com","type":"main_domain","usecanonicalname":"Off","user":"user","userdirprotect":""},"no_cache_update":"0","owner":"root","parked_capable_of_https_redirects":["parkeddomain.com"],"parked_domains":["parkeddomain.com"],"parked_with_https_redirects":["parkeddomain.com"],"serveradmin":"webmaster@subdomain.example.com","serveralias":"addondomain.com www.addondomain.com www.subdomain.example.com","servername":"subdomain.example.com","sub_domains":[{"all_aliases_valid":"0","can_https_redirect":"0","documentroot":"/home/user/public_html/sub","domain":"sub.example.com","group":"user","hascgi":"1","homedir":"/home/user","ip":"192.168.0.128","ipv6":null,"is_https_redirecting":"0","no_cache_update":"0","owner":"root","serveradmin":"webmaster@sub.example.com","serveralias":"www.sub.example.com","servername":"sub.example.com","type":"sub_domain","usecanonicalname":"Off","user":"user","userdirprotect":""}],"type":"addon_domain","usecanonicalname":"Off","user":"user","userdirprotect":""}]},"errors":null,"messages":null,"metadata":null,"status":1}},"list":{"summary":"Output in list return format.","value":{"data":[{"all_aliases_valid":"0","can_https_redirect":"0","customlog":[{"format":"combined","target":"/usr/local/apache/domlogs/example.com"},{"format":"\"%{%s}t %I .\\n%{%s}t %O .\"","target":"/usr/local/apache/domlogs/example.com-bytes_log"}],"documentroot":"/home/user/public_html","domain":"example.com","group":"user","hascgi":"1","homedir":"/home/user","ifmodulemodsuphpc":{"group":"user"},"ip":"192.168.0.128","is_https_redirecting":"0","options":"ExecCGI Includes","owner":"root","port":"80","scriptalias":[{"path":"/home/user/public_html/cgi-bin","url":"/cgi-bin/"},{"path":"/home/user/public_html/cgi-bin/","url":"/cgi-bin/"}],"serveradmin":"webmaster@example.com","serveralias":"parkeddomain.com www.parkeddomain.com www.example.com","servername":"example.com","type":"main_domain","usecanonicalname":"Off","user":"user","userdirprotect":"1"},{"parked_with_https_redirects":["parkeddomain.com"]},{"parked_capable_of_https_redirects":["zippy.nugs.test"]},{"all_aliases_valid":"0","can_https_redirect":"0","documentroot":"/home/user/public_html/seconddomain.com","domain":"seconddomain.com","group":"user","hascgi":"1","homedir":"/home/user","ip":"192.168.0.128","ipv6":null,"is_https_redirecting":"0","no_cache_update":"0","owner":"root","serveradmin":"webmaster@seconddomain.example.com","serveralias":"seconddomain.com www.seconddomain.com www.seconddomain.example.com","servername":"seconddomain.example.com","type":"addon_domain","usecanonicalname":"Off","user":"user","userdirprotect":""},{"all_aliases_valid":"0","can_https_redirect":"0","documentroot":"/home/user/public_html/subdomain","domain":"exampledomain.com","group":"user","hascgi":"1","homedir":"/home/user","ip":"192.168.0.128","ipv6":null,"is_https_redirecting":"0","no_cache_update":"0","owner":"root","serveradmin":"webmaster@subdomain.example.com","serveralias":"exampledomain.com www.exampledomain.com www.subdomain.example.com","servername":"subdomain.example.com","type":"addon_domain","usecanonicalname":"Off","user":"user","userdirprotect":""},{"all_aliases_valid":"0","can_https_redirect":"0","documentroot":"/home/user/addondomain/home/dir","domain":"addondomain.com","group":"user","hascgi":"1","homedir":"/home/user","ip":"192.168.0.128","ipv6":null,"is_https_redirecting":"0","no_cache_update":"0","owner":"root","serveradmin":"webmaster@subdomain.example.com","serveralias":"addondomain.com www.addondomain.com www.subdomain.example.com","servername":"subdomain.example.com","type":"addon_domain","usecanonicalname":"Off","user":"user","userdirprotect":""},{"all_aliases_valid":"0","can_https_redirect":"0","documentroot":"/home/user/public_html/sub","domain":"sub.example.com","group":"user","hascgi":"1","homedir":"/home/user","ip":"192.168.0.128","ipv6":null,"is_https_redirecting":"0","no_cache_update":"0","owner":"root","serveradmin":"webmaster@sub.example.com","serveralias":"www.sub.example.com","servername":"sub.example.com","type":"sub_domain","usecanonicalname":"Off","user":"user","userdirprotect":""}],"errors":null,"messages":null,"metadata":{"transformed":1},"status":1}}},"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"domains_data","type":"string"},"module":{"description":"The name of the module called.","example":"DomainInfo","type":"string"},"result":{"properties":{"data":{"description":"An object containing information about a cPanel account's domains. The output of this function changes, based on the `format` parameter value.","oneOf":[{"$ref":"#/components/schemas/HashOutput"},{"$ref":"#/components/schemas/ListOutput"}]},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return all domains' hosting configuration","tags":["DomainInfo","Domain Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DomainInfo \\\n  domains_data\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DomainInfo/domains_data"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DomainInfo_domains_data.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DomainInfo_domains_data.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DomainInfo/,\n    q/domains_data/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DomainInfo_domains_data.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DomainInfo_domains_data.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DomainInfo',\n    'domains_data'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/DirectoryIndexes/set_indexing":{"get":{"description":"This function configures the [directory indexing](https://go.cpanel.net/cpaneldocsIndexes) settings for a directory on the cPanel account.","operationId":"set_indexing","parameters":[{"description":"The directory for which to manage directory indexing.","in":"query","name":"dir","required":true,"schema":{"example":"/home/example/example.com","format":"path","type":"string"}},{"description":"The type of directory indexing.\n\n* `standard` — The directory uses directory indexing with standard formatting.\n* `disabled` — The directory doesn't use directory indexing.\n* `inherit` — The directory uses the system's default settings.\n* `fancy` — The directory uses directory indexing with Apache FancyIndexing directive. The directory will include additional information such as file size and the date of the file's last update.","in":"query","name":"type","required":true,"schema":{"enum":["standard","disabled","inherit","fancy"],"example":"inherit","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_indexing","type":"string"},"module":{"description":"The name of the module called.","example":"DirectoryIndexes","type":"string"},"result":{"properties":{"data":{"description":"The directory's indexing type.\n* `standard` — The directory uses directory indexing with standard formatting.\n* `disabled` — The directory doesn't use directory indexing.\n* `inherit` — The directory uses the system's default settings.\n* `fancy` — The directory uses directory indexing with Apache FancyIndexing directive. The directory will include additional information such as file size and the date of the file's last update.","enum":["standard","disabled","inherit","fancy"],"example":"disabled","type":"string"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* 1 — Success.\n* 0 — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update directory indexing settings","tags":["DirectoryIndexes","Directory Indexes"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DirectoryIndexes \\\n  set_indexing \\\n  dir='/home/example/example.com' \\\n  type='inherit'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DirectoryIndexes/set_indexing?dir=%2fhome%2fexample%2fexample.com&type=inherit"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DirectoryIndexes_set_indexing.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DirectoryIndexes_set_indexing.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DirectoryIndexes/,\n    q/set_indexing/,\n    {\n        'dir' => '/home/example/example.com',\n        'type' => 'inherit',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DirectoryIndexes_set_indexing.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DirectoryIndexes_set_indexing.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DirectoryIndexes',\n    'set_indexing',\n    array (\n        'dir' => '/home/example/example.com',\n        'type' => 'inherit',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 88"}},"/DirectoryPrivacy/configure_directory_protection":{"get":{"description":"This function enables or disables password protection for a directory on the cPanel account.","operationId":"configure_directory_protection","parameters":[{"description":"The absolute or relative directory path for which to enable or disable password protection.","in":"query","name":"dir","required":true,"schema":{"example":"/home/example/example.com","format":"path","type":"string"}},{"description":"Whether to enable password protection for the directory.\n* `1` - Enable.\n* `0` - Disable.","in":"query","name":"enabled","required":true,"schema":{"enum":[0,1],"example":1,"type":"integer"}},{"description":"The name of the directory protection authorization instance.\n\n**Note:**\n\n**Only** use this parameter when you enable password protection.","in":"query","name":"authname","required":true,"schema":{"example":"protectandserve","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"configure_directory_protection","type":"string"},"module":{"description":"The name of the module called.","example":"DirectoryPrivacy","type":"string"},"result":{"properties":{"data":{"properties":{"auth_name":{"description":"The authentication resource name.","example":"protectandserve","type":"string"},"auth_type":{"description":"The directory's authentication type.\n* `Basic`\n* `None`","enum":["Basic","None"],"example":"Basic","type":"string"},"passwd_file":{"description":"The path to the directory's password file.","example":"/home/example/.htpasswds/example.com/passwd","format":"path","type":"string"},"protected":{"description":"Whether the directory uses password protection.\n* `1` - Protected.\n* `0` - **Not** protected.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable or disable protected directory","tags":["DirectoryPrivacy","Directory Privacy"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DirectoryPrivacy \\\n  configure_directory_protection \\\n  dir='/home/example/example.com' \\\n  enabled='1' \\\n  authname='protectandserve'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DirectoryPrivacy/configure_directory_protection?dir=%2fhome%2fexample%2fexample.com&enabled=1&authname=protectandserve"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DirectoryPrivacy_configure_directory_protection.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DirectoryPrivacy_configure_directory_protection.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DirectoryPrivacy/,\n    q/configure_directory_protection/,\n    {\n        'dir' => '/home/example/example.com',\n        'enabled' => '1',\n        'authname' => 'protectandserve',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DirectoryPrivacy_configure_directory_protection.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DirectoryPrivacy_configure_directory_protection.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DirectoryPrivacy',\n    'configure_directory_protection',\n    array (\n        'dir' => '/home/example/example.com',\n        'enabled' => '1',\n        'authname' => 'protectandserve',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 88"}},"/DNSSEC/unset_nsec3":{"get":{"description":"This function configures the domain to use [Next Secure Record](https://tools.ietf.org/html/rfc4470) (NSEC) semantics instead of Next Secure Record 3 (NSEC3) semantics.\n\n**Important:**\n\n  When you disable the [DNS role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"unset_nsec3","parameters":[{"description":"The domain on which to disable NSEC3 semantics and use NSEC semantics.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"unset_nsec3","type":"string"},"module":{"description":"The name of the module called.","example":"DNSSEC","type":"string"},"result":{"properties":{"data":{"example":{"disabled":{"example.com":1}},"properties":{"disabled":{"description":"A list of the domains for which the system disabled NSEC3.","properties":{"additionalProperties":{"description":"Whether the system disabled NSEC3 on the domain.\n\n* `1` — Disabled.\n* `0` — The system failed to disable NSEC3.\n\n**Note:**\n\nThis return's name is the `domain` parameter's value.","enum":[1,0],"type":"integer"}},"type":"object"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update domain to use NSEC","tags":["DNSSEC","DNS Security"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DNSSEC \\\n  unset_nsec3 \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DNSSEC/unset_nsec3?domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DNSSEC_unset_nsec3.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DNSSEC_unset_nsec3.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DNSSEC/,\n    q/unset_nsec3/,\n    {\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DNSSEC_unset_nsec3.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DNSSEC_unset_nsec3.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DNSSEC',\n    'unset_nsec3',\n    array (\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 60"}},"/DomainInfo/list_domains":{"get":{"description":"This function lists the cPanel account's domains.\n\n**Note:**\n\nFor this function to succeed, the `/var/cpanel/userdata/username/main` file (where `username` represents the authenticated user) **must** possess the correct permissions. If a permissions error occurs, this function returns blank values for **all** of its returns and does **not** return an error message.","operationId":"list_domains","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_domains","type":"string"},"module":{"description":"The name of the module called.","example":"DomainInfo","type":"string"},"result":{"properties":{"data":{"properties":{"addon_domains":{"description":"An array of string values that lists the addon domains on the cPanel account.","items":{"example":"addondomain.com","format":"domain","type":"string"},"type":"array"},"main_domain":{"description":"The cPanel account's main domain.","items":{"example":"example.com","format":"domain","type":"string"},"type":"array"},"parked_domains":{"description":"An array of string values that lists the parked domains on the cPanel account.","items":{"example":"parkeddomain.com","format":"domain","type":"string"},"type":"array"},"sub_domains":{"description":"An array of string values that lists the subdomains on the cPanel account.","items":{"example":"subdomain.example.com","format":"domain","type":"string"},"type":"array"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel account's domains","tags":["DomainInfo","Domain Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DomainInfo \\\n  list_domains\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DomainInfo/list_domains"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DomainInfo_list_domains.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DomainInfo_list_domains.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DomainInfo/,\n    q/list_domains/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DomainInfo_list_domains.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DomainInfo_list_domains.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DomainInfo',\n    'list_domains'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/DomainInfo/single_domain_data":{"get":{"description":"This function lists user data for a domain.\n\n**Important:**\n\n  This function retrieves data from the `/var/cpanel/userdata/user/domain` file, where `user` represents the cPanel account username and `domain` represents the domain.\n  * Because aliases (parked domains) do **not** use a user data file, this function **cannot** query information for aliases. To retrieve information for an alias, specify the associated main or addon domain.\n  * Due to differences in user data files, the function's actual output may not contain all of the returns that this document lists.","operationId":"single_domain_data","parameters":[{"description":"The domain on the cPanel account.\n\n**Important:**\n\nDo **not** specify an alias (parked domain).","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"Whether to return the secure redirect status of the addon domains.\n* `1` - Return status.\n* `0` - Do **not** return status.","in":"query","name":"return_https_redirect_status","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"single_domain_data","type":"string"},"module":{"description":"The name of the module called.","example":"DomainInfo","type":"string"},"result":{"properties":{"data":{"properties":{"all_aliases_valid":{"description":"Whether a valid SSL certificate exists on the domain's aliases.\n* `1` - A valid SSL certificate exists on the aliases.\n* `0` - A valid SSL certificate does **not** exist on the aliases.\n\n**Important:**\n\nThis return only appears if you set the `return_https_redirects_status` parameter to `1`.","enum":[0,1],"example":0,"type":"integer"},"can_https_redirect":{"description":"Whether a valid SSL certificate exists or AutoSSL runs on the domain.\n* `1` - A valid SSL certificate exists or AutoSSL runs.\n* `0` - A valid SSL certificate does **not** exist, and AutoSSL does not run.\n\n**Important:**\n\nThis return only appears if you set the `return_https_redirects_status` parameter to `1`.","enum":[0,1],"example":0,"type":"integer"},"customlog":{"description":"An object containing Apache log information.","properties":{"domain":{"description":"The `target` log file's domain. An [Apache log](http://httpd.apache.org/docs/2.2/mod/mod_log_config.html) domain. Generally, this value is `combined`.","example":"combined","type":"string"},"target":{"description":"The absolute path to the domain's log file.","example":"/usr/local/apache/domlogs/example.com","format":"path","type":"string"}},"type":"object"},"documentroot":{"description":"The absolute path to the domain's document root.","example":"/home/user/public_html/","format":"path","type":"string"},"domain":{"description":"The domain name on the cPanel account.","example":"example.com","format":"domain","type":"string"},"group":{"description":"The domain's group name.","example":"user","type":"string"},"hascgi":{"description":"Whether CGI is enabled for the domain.\n* `1` - Enabled.\n* `0` - Disabled.","enum":[0,1],"example":1,"type":"integer"},"homedir":{"description":"The absolute path to the account's home directory.","example":"/home/user","format":"path","type":"string"},"ifmodulemodsuphpc":{"description":"An object containing information about PHP scripts and suPHP.","properties":{"group":{"description":"If suPHP is enabled, the group that PHP scripts run as.","example":"user","type":"string"}},"type":"object"},"ip":{"description":"The domain's IP address.","example":"192.168.0.128","format":"ipv4","type":"string"},"is_https_redirecting":{"description":"Whether the domain redirects to https.\n* `1` - Redirects.\n* `0` - Does **not** redirect.\n\n**Important:**\n\nThis return only appears if you set the `return_https_redirects_status` parameter to `1`.","enum":[0,1],"example":0,"type":"integer"},"options":{"description":"The Apache `Options` directive for the domain.","example":"ExecCGI Includes","type":"string"},"owner":{"description":"The WHM account (root or a reseller) that owns the cPanel account.","example":"root","format":"username","type":"string"},"phpopenbasedirprotect":{"description":"The domain's `open_basedir` setting.\n* `1` - Enabled.\n* `0` - Disabled.\n\n**Note:**\n\nIn EasyApache 4, change this directive in the *Editor Mode* section of WHM's\n[*MultiPHP INI Editor*](https://go.cpanel.net/whmdocsMultiPHPINIEditor) interface\n(*WHM >> Home >> Software >> MultiPHP INI Editor*).","enum":[0,1],"example":1,"type":"integer"},"port":{"description":"Apache's port to access the domain.","example":80,"maximum":65335,"minimum":1,"type":"integer"},"scriptalias":{"description":"An object containing CGI information.","properties":{"path":{"description":"The absolute path to the domain's CGI directory.","example":"/home/user/public_html/cgi-bin","format":"path","type":"string"},"url":{"description":"The domain's CGI directory.","example":"/cgi-bin/","format":"url-path","type":"string"}},"type":"object"},"serveradmin":{"description":"The domain's administrator's contact email address.","example":"webmaster@example.com","format":"email","type":"string"},"serveralias":{"description":"A space-separated list of the domain's aliases.","example":"parkeddomain.com www.parkeddomain.com www.example.com","type":"string"},"servername":{"description":"The domain's identifier on the server.","example":"example.com","format":"domain","type":"string"},"type":{"description":"The domain type.\n* `addon_domain` - The domain is an addon domain.\n* `sub_domain` - The domain is a subdomain.\n* `main_domain` - The domain is the account's main domain.\n* `parked_domain` - The domain is a parked domain (domain alias).","enum":["addon_domain","sub_domain","main_domain","parked_domain"],"example":"main_domain","type":"string"},"usecanonicalname":{"description":"The domain's Canonical Name (CNAME) setting.\n* `On` - Use the CNAME.\n* `Off` - Do **not** use the CNAME.","enum":["On","Off"],"example":"Off","type":"string"},"user":{"description":"The cPanel account's username.","example":"user","format":"username","type":"string"},"userdirprotect":{"description":"The domain's [Apache `mod_userdir` Tweak](https://go.cpanel.net/whmdocsApachemod_userdirTweak) setting.\n* `1` - Enabled.\n* `0` - Disabled.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success.\n- 0 - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return domain's hosting configuration","tags":["DomainInfo","Domain Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DomainInfo \\\n  single_domain_data \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DomainInfo/single_domain_data?domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DomainInfo_single_domain_data.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DomainInfo_single_domain_data.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DomainInfo/,\n    q/single_domain_data/,\n    {\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DomainInfo_single_domain_data.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DomainInfo_single_domain_data.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DomainInfo',\n    'single_domain_data',\n    array (\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/account_name":{"get":{"description":"This function returns the provided value. This function works with other functions to display form data within a user interface.\n\n**Note:**\n\n  If you call this function from a Webmail session URL, the system will **only** access data for that email account.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"account_name","parameters":[{"description":"The function will return this value in the data return. If you do **not** include this parameter, the function returns `All Mail On The Account` or a blank value.\n* A valid string.\n* An empty value.\n\n**Note:**\n\n The function does **not** validate this parameter's value.","in":"query","name":"account","required":false,"schema":{"example":"user","type":"string"}},{"description":"Include this parameter to cause the function to return `All Mail On The Account` if the account parameter is blank or does not exist. If you do **not** include this parameter and the account value is blank or does not exist, the function returns a blank data value.","in":"query","name":"display","required":false,"schema":{"example":"any_value","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"account_name","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"The account parameter's value.\n* A valid string.\n* `All Mail On The Account`\n* An empty value.","example":"user@example.com","format":"email","type":"string"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return current user's account name","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  account_name\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/account_name"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_account_name.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_account_name.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/account_name/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_account_name.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_account_name.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'account_name'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/add_domain_forwarder":{"get":{"description":"This function creates a domain-level forwarder.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"add_domain_forwarder","parameters":[{"description":"The domain on the cPanel account from which to forward mail.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"The domain to receive forwarded mail.","in":"query","name":"destdomain","required":true,"schema":{"example":"forwardtome.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"add_domain_forwarder","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"A message of success, or a reason for failure.\n* A message of success that lists the updated `vdomainaliases` file.\n* A reason for failure.","example":"File updated \"/etc/vdomainaliases/example.com\"","type":"string"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create domain-level forwarder","tags":["Email","Email Forwarding"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  add_domain_forwarder \\\n  domain='example.com' \\\n  destdomain='forwardtome.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/add_domain_forwarder?domain=example.com&destdomain=forwardtome.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_add_domain_forwarder.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_add_domain_forwarder.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/add_domain_forwarder/,\n    {\n        'domain' => 'example.com',\n        'destdomain' => 'forwardtome.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_add_domain_forwarder.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_add_domain_forwarder.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'add_domain_forwarder',\n    array (\n        'domain' => 'example.com',\n        'destdomain' => 'forwardtome.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/add_forwarder":{"get":{"description":"This function creates an email forwarder.\n\n**Important:**\n\n  When you disable the MailReceive role, the system disables this function. \n  For more information, read our [How to Use Server Profiles](https://go.cpanel.net/howtouseserverprofiles) \n  documentation.","operationId":"add_forwarder","parameters":[{"description":"The domain.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","type":"string"}},{"description":"The email address to forward.","in":"query","name":"email","required":true,"schema":{"example":"forwardme@example.com","type":"string"}},{"description":"The method to use to handle the email address's mail.","in":"query","name":"fwdopt","required":true,"schema":{"example":"fwd","type":"string"}},{"description":"The email address to which the system forwards messages.\n\n**Note:**\n\n You must use this parameter if you used the fwd method for the fwdopt parameter. You can pass multiple addresses to this parameter as a comma-separated list.","in":"query","name":"fwdemail","required":false,"schema":{"example":"fwdtome@example.com","type":"string"}},{"description":"The system user to whom the system forwards messages.\n\n**Note:**\n\n You must use this parameter if you used the system method for the fwdopt parameter.","in":"query","name":"fwdsystem","required":false,"schema":{"example":"user","type":"string"}},{"description":"The failure message for the message's sender.\n\n**Note:**\n\n Use this parameter if you used the fail method for the fwdopt parameter.","in":"query","name":"failmsgs","required":false,"schema":{"default":"No such person at this address","example":"Nobody home.","type":"string"}},{"description":"The application to which the system pipes messages.\n\n**Note:**\n\n You must use this parameter if you used the pipe method for the fwdopt parameter.\n\n**Important:**\n\n  This parameter requires the FileStorage role. For more information, read our \n  [How to Use Server Profiles](https://go.cpanel.net/howtouseserverprofiles) documentation.","in":"query","name":"pipefwd","required":false,"schema":{"example":"mailscript.pl","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"add_forwarder","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"domain":{"description":"The domain. A valid domain on the account.","example":"example.com","type":"string"},"email":{"description":"The email address. An email address on the account.","example":"user@example.com","type":"string"},"forward":{"description":"The method that the system will use to handle the address's mail.\n- An email address  The system forwards mail to this address.\n- :fail:  The system bounces mail back to the sender and sends a failure message.\n- :blackhole:  The system deletes mail without a failure message.\n- The path to an application  The system pipes mail to this application.\n- A username  The system forwards mail to this system account.","example":"fwdtome@example.com","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create email account forwarder","tags":["Email","Email Forwarding"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  add_forwarder \\\n  domain='example.com' \\\n  email='forwardme@example.com' \\\n  fwdopt='fwd'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/add_forwarder?domain=example.com&email=forwardme%40example.com&fwdopt=fwd"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_add_forwarder.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_add_forwarder.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/add_forwarder/,\n    {\n        'domain' => 'example.com',\n        'email' => 'forwardme@example.com',\n        'fwdopt' => 'fwd',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_add_forwarder.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_add_forwarder.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'add_forwarder',\n    array (\n        'domain' => 'example.com',\n        'email' => 'forwardme@example.com',\n        'fwdopt' => 'fwd',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/DomainInfo/main_domain_builtin_subdomain_aliases":{"get":{"description":"This function returns the built-in subdomain aliases for an account's main domain.\n\n**Note:**\n\n  This function retrieves data from the `/var/cpanel/userdata/user/domain` file, where `user` represents the cPanel account username and `domain` represents the domain. For this reason, actual output may not contain all of the returns that this document lists.","operationId":"main_domain_builtin_subdomain_aliases","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"main_domain_builtin_subdomain_aliases","type":"string"},"module":{"description":"The name of the module called.","example":"DomainInfo","type":"string"},"result":{"properties":{"data":{"description":"A list of the built-in subdomain aliases for the account's main domain.","example":["mail","www"],"items":{"type":"string"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return built-in subdomain aliases","tags":["DomainInfo","Domain Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DomainInfo \\\n  main_domain_builtin_subdomain_aliases\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DomainInfo/main_domain_builtin_subdomain_aliases"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DomainInfo_main_domain_builtin_subdomain_aliases.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DomainInfo_main_domain_builtin_subdomain_aliases.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DomainInfo/,\n    q/main_domain_builtin_subdomain_aliases/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DomainInfo_main_domain_builtin_subdomain_aliases.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DomainInfo_main_domain_builtin_subdomain_aliases.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DomainInfo',\n    'main_domain_builtin_subdomain_aliases'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/add_mailman_delegates":{"get":{"description":"This function grants mailing list administrative privileges to users.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"add_mailman_delegates","parameters":[{"description":"The mailing list.","in":"query","name":"list","required":true,"schema":{"example":"mylist","type":"string"}},{"description":"A list of the administrators to add.\n\n**Note:**\n\n  Separate multiple email addresses with commas.","examples":{"multiple":{"summary":"Multiple delegates","value":"delegates=user@example.com,admin@example.com"},"single":{"summary":"A single delegate.","value":"user@example.com"}},"explode":false,"in":"query","name":"delegates","required":true,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"add_mailman_delegates","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"properties":{"delegates":{"description":"An array of the mailing list's administrators.","items":{"example":"admin@example.com, user@example.com","type":"string"},"type":"array"},"metadata":{"properties":{"transformed":{}},"type":"object"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add administrators to mailing list","tags":["Email","Mailing Lists"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  add_mailman_delegates \\\n  list='mylist' \\\n  delegates='user@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/add_mailman_delegates?list=mylist&delegates=user%40example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_add_mailman_delegates.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_add_mailman_delegates.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/add_mailman_delegates/,\n    {\n        'list' => 'mylist',\n        'delegates' => 'user@example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_add_mailman_delegates.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_add_mailman_delegates.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'add_mailman_delegates',\n    array (\n        'list' => 'mylist',\n        'delegates' => 'user@example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/add_mx":{"get":{"description":"This function creates a Mail Exchanger (MX) record. For more information about MX record settings, read our [Email Routing Configuration](https://go.cpanel.net/whmdocsEmailRoutingConfiguration) documentation.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles), the system **disables** this function","operationId":"add_mx","parameters":[{"description":"The new mail exchanger's domain.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"The new mail exchanger's name.","in":"query","name":"exchanger","required":true,"schema":{"example":"mail.example.com","format":"domain","type":"string"}},{"description":"The new mail exchanger's [priority value](https://go.cpanel.net/whmdocsEditMXEntry).\n\n**Note:**\n\n  It is common practice to set a priority value that is divisible by five.","in":"query","name":"priority","required":true,"schema":{"example":5,"minimum":0,"type":"integer"}},{"description":"Whether the mail exchanger accepts all mail for the domain.\n* `1` — The mail exchanger always accepts mail.\n* `0` — The mail exchanger does **not** always accept mail.","in":"query","name":"alwaysaccept","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"add_mx","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"properties":{"checkmx":{"description":"An object of the mail exchanger's data.","properties":{"changed":{"description":"Whether a change occurred during the function.\n* `1` - Change occurred.\n* `0` - **No** change.","enum":[0,1],"example":1,"type":"integer"},"detected":{"description":"The mail exchanger type.\n* `auto`\n* `local`\n* `secondary`\n* `remote`","enum":["auto","local","secondary","remote"],"example":"auto","type":"string"},"isprimary":{"description":"Whether the mail exchanger is the primary mail exchanger.\n* `1` - Primary.\n* `0` - **Not** primary.","enum":[0,1],"example":0,"type":"integer"},"issecondary":{"description":"Whether the mail exchanger is a secondary exchanger.\n* `1` - Secondary.\n* `0` - **Not** secondary.","enum":[0,1],"example":0,"type":"integer"},"local":{"description":"Whether the mail exchanger is a local exchanger.\n* `1` - Local.\n* `0` - **Not** local.","enum":[0,1],"example":0,"type":"integer"},"mxcheck":{"description":"The mail exchanger type.\n* `auto`\n* `local`\n* `secondary`\n* `remote`","enum":["auto","local","secondary","remote"],"example":"auto","type":"string"},"remote":{"description":"Whether the mail exchanger is a remote exchanger.\n* `1` - Remote.\n* `0` - **Not** remote.","enum":[0,1],"example":0,"type":"integer"},"secondary":{"description":"Whether the mail exchanger is a secondary exchanger.\n* `1` - Secondary.\n* `0` - **Not** secondary.","enum":[0,1],"example":0,"type":"integer"},"warnings":{"description":"Warning messages, if any exist.","items":{"example":"Auto Detect of MX configuration not possible due to non-resolving MX entries. Defaulting to last known setting: local.","type":"string"},"type":"array"}},"type":"object"},"results":{"description":"A message of success, or an error message.\n* A message of success that begins with `Added entry:`.\n* An error message.","example":"Added entry:\\nBind reloading on example using rndc zone: [example.com]\\n","type":"string"},"status":{"description":"Whether the function succeeded.\n* `1` - Success.\n* `0` - Failure.","enum":[0,1],"example":1,"type":"integer"},"statusmsg":{"description":"A message of success, or an error message.\n* A message of success that begins with `Added entry:`.\n* An error message.","example":"Added entry:\\nBind reloading on example using rndc zone: [example.com]\\n","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create mail exchanger record","tags":["Email DNS Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  add_mx \\\n  domain='example.com' \\\n  exchanger='mail.example.com' \\\n  priority='5'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/add_mx?domain=example.com&exchanger=mail.example.com&priority=5"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_add_mx.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_add_mx.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/add_mx/,\n    {\n        'domain' => 'example.com',\n        'exchanger' => 'mail.example.com',\n        'priority' => '5',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_add_mx.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_add_mx.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'add_mx',\n    array (\n        'domain' => 'example.com',\n        'exchanger' => 'mail.example.com',\n        'priority' => '5',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/browse_mailbox":{"get":{"description":"This function lists the mail directory's subdirectories (boxes) and files.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles#roles), the system **disables** this function.\n\n**Notes:**\n\n  If you do not use any input parameters, the function returns a list of items in the cPanel account's main mail directory.","operationId":"browse_mailbox","parameters":[{"description":"An email address, to limit the function's results.","in":"query","name":"account","required":false,"schema":{"example":"user@example.com","format":"email","type":"string"}},{"description":"A mail directory name, to limit results to specific directories.\n\n**Note:**\n\n  If you pass the `default` or `mail` values, the function lists information for all mail directories.","in":"query","name":"dir","required":false,"schema":{"example":"maildir","type":"string"}},{"description":"Whether to include hidden files and directories.\n* `1` — Include hidden items.\n* `0` — Do **not** include hidden items.","in":"query","name":"showdotfiles","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"browse_mailbox","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"depth":{"description":"The directory depth of the item's path.","example":2,"minimum":0,"type":"integer"},"file":{"description":"The item's base name.","example":"archive","type":"string"},"fullpath":{"description":"The item's absolute path.","example":"/home/example/mail/archive","format":"path","type":"string"},"isleaf":{"description":"Whether the item is a file or a directory.\n* `1` - File.\n* `0` - Directory.","enum":[0,1],"example":0,"type":"integer"},"ismailbox":{"description":"Whether the item is a mailbox.\n* `1` - Mailbox.\n* `0` - **Not** a mailbox.","enum":[0,1],"example":0,"type":"integer"},"mtime":{"description":"The item's modification time. A time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) format.","example":1413398866,"format":"unix_timestamp","type":"integer"},"path":{"description":"The item's directory's path.","example":"/home/example/mail","format":"path","type":"string"},"relpath":{"description":"The item's relative path.","example":"/archive","format":"path","type":"string"},"type":{"description":"The item type.\n* `dir` - The item is a directory.\n* `file` - The item is a file.","enum":["dir","file"],"example":"dir","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return mail directory's subdirectories and files","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  browse_mailbox\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/browse_mailbox"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_browse_mailbox.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_browse_mailbox.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/browse_mailbox/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_browse_mailbox.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_browse_mailbox.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'browse_mailbox'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/add_pop":{"get":{"description":"This function creates an email address.\n\n**Important:**\n\n  * When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles), the system **disables** this function.\n  * We recommend that you use the UAPI `UserManager::create_user` function to create an email address instead of this function. This function is incompatible with [the *Reset Password* feature](https://go.cpanel.net/resetpassdocs).\n  * You **must** URI-encode values when using the CLI.","operationId":"add_pop","parameters":[{"description":"The email account username or address.\n* A valid email account username. For example, `user` to create `user@example.com`.\n* A valid email address.\n\n**Note:**\n\n  You **cannot** enter `cpanel` as an account name when you create an email account.","in":"query","name":"email","required":true,"schema":{"example":"user","oneOf":[{"format":"email","type":"string"},{"type":"string"}]}},{"description":"The email account password.","in":"query","name":"password","required":true,"schema":{"example":"123456luggage","type":"string"}},{"description":"The email account's domain. For example, `example.com` to create `user@example.com`.","in":"query","name":"domain","required":false,"schema":{"default":"The cPanel account's main domain.","example":"example.com","format":"domain","type":"string"}},{"description":"The maximum amount of disk space that the new email account may use.\n* A positive integer that represents the maximum amount of disk space, in megabytes (MB).\n* `0` or `unlimited` — The account possesses unlimited disk space.\n\n**Note:**\n\n  * The positive integer value **cannot** exceed the maximum email quota.\n  * The `0` or `unlimited` value is **only** available to users **without** a maximum email account quota.","in":"query","name":"quota","required":false,"schema":{"default":"The defined system value.","example":500,"oneOf":[{"enum":["unlimited"],"type":"string"},{"minimum":0,"type":"integer"}]}},{"description":"Whether to skip the update of the email accounts database's cache.\n* `1` — Skip the update.\n* `0` — Perform the update.","in":"query","name":"skip_update_db","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"The account's password hash.\n\n**Notes:**\n\n  * You can use this parameter instead of the `password` parameter. However, you cannot use both `password` and `password_hash` parameters in the same request.\n  * You can find your server's hash type in the `/etc/sysconfig/authconfig` file.","in":"query","name":"password_hash","required":false,"schema":{"example":"$6$1sOyHP5ZDYp3pGUz$R0TSgfPRHfDjT5PP5RJGv39FhiGTNNPvM7IFpCBjXijMmlMZk9yI8T3LqGuntc9fdKb5eX.lGL7wBS9e4DAWn/","type":"string"}},{"description":"Whether to send client configuration instructions to the account.\n* `1` — Send the instructions.\n* `0` — Do **not** send the instructions.","in":"query","name":"send_welcome_email","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"add_pop","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"The email address. The email account username, a plus character (+), and the email account domain.","example":"user+example.com","type":"string"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create email address","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  add_pop \\\n  email='user' \\\n  password='123456luggage'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/add_pop?email=user&password=123456luggage"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_add_pop.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_add_pop.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/add_pop/,\n    {\n        'email' => 'user',\n        'password' => '123456luggage',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_add_pop.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_add_pop.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'add_pop',\n    array (\n        'email' => 'user',\n        'password' => '123456luggage',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/change_mx":{"get":{"description":"This function creates a Mail Exchanger (MX) record. For more information about MX record settings, read our [Email Routing Configuration](https://go.cpanel.net/whmdocsEmailRoutingConfiguration) documentation.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"change_mx","parameters":[{"description":"The mail exchanger's domain.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"The mail exchanger's name.","in":"query","name":"exchanger","required":true,"schema":{"example":"mail.example.com","format":"domain","type":"string"}},{"description":"The mail exchanger's current name.","in":"query","name":"oldexchanger","required":true,"schema":{"example":"mail.example.com","format":"domain","type":"string"}},{"description":"The mail exchanger's new [priority value](https://go.cpanel.net/whmdocsEditMXEntry).\n\n**Note:**\n\n  Common practice sets a priority value divisible by five.","in":"query","name":"priority","required":true,"schema":{"example":15,"minimum":0,"type":"integer"}},{"description":"The mail exchanger's current priority value. If multiple MX entries match the `oldexchanger` value, the system uses this parameter to find the correct entry.","in":"query","name":"oldpriority","required":false,"schema":{"example":5,"minimum":0,"type":"integer"}},{"description":"Whether the mail exchanger accepts all mail for the domain.\n* `1` — The mail exchanger always accepts mail.\n* `0` — The mail exchanger does **not** always accept mail.","in":"query","name":"alwaysaccept","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"change_mx","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"properties":{"checkmx":{"description":"An object of the mail exchanger's data.","properties":{"changed":{"description":"Whether a change occurred during the function.\n* `1` - Change occurred.\n* `0` - **No** change.","enum":[0,1],"example":1,"type":"integer"},"detected":{"description":"The mail exchanger type.\n* `auto`\n* `local`\n* `secondary`\n* `remote`","enum":["auto","local","secondary","remote"],"example":"auto","type":"string"},"isprimary":{"description":"Whether the mail exchanger is the primary mail exchanger.\n* `1` - Primary.\n* `0` - **Not** primary.","enum":[0,1],"example":0,"type":"integer"},"issecondary":{"description":"Whether the mail exchanger is a secondary exchanger.\n* `1` - Secondary.\n* `0` - **Not** secondary.","enum":[0,1],"example":0,"type":"integer"},"local":{"description":"Whether the mail exchanger is a local exchanger.\n* `1` - Local.\n* `0` - **Not** local.","enum":[0,1],"example":0,"type":"integer"},"mxcheck":{"description":"The mail exchanger type.\n* `auto`\n* `local`\n* `secondary`\n* `remote`","enum":["auto","local","secondary","remote"],"example":"auto","type":"string"},"remote":{"description":"Whether the mail exchanger is a remote exchanger.\n* `1` - Remote.\n* `0` - **Not** remote.","enum":[0,1],"example":0,"type":"integer"},"secondary":{"description":"Whether the mail exchanger is a secondary exchanger.\n* `1` - Secondary.\n* `0` - **Not** secondary.","enum":[0,1],"example":0,"type":"integer"},"warnings":{"description":"Warning messages, if any exist.","items":{"example":"Auto Detect of MX configuration not possible due to non-resolving MX entries. Defaulting to last known setting: local.","type":"string"},"type":"array"}},"type":"object"},"results":{"description":"A message of success, or an error message.\n* A message of success that begins with `Added entry:`.\n* An error message.","example":"Replacing existing entry on line matched old entry and old priority: 51:\\nBind reloading on example using rndc zone: [example.com]","type":"string"},"status":{"description":"Whether the function succeeded.\n* `1` - Success.\n* `0` - Failure.","enum":[0,1],"example":1,"type":"integer"},"statusmsg":{"description":"A message of success, or an error message.\n* A message of success that begins with `Added entry:`.\n* An error message.","example":"Replacing existing entry on line matched old entry and old priority: 51:\\nBind reloading on example using rndc zone: [example.com]","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update mail exchanger record","tags":["Email DNS Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  change_mx \\\n  domain='example.com' \\\n  exchanger='mail.example.com' \\\n  oldexchanger='mail.example.com' \\\n  priority='15'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/change_mx?domain=example.com&exchanger=mail.example.com&oldexchanger=mail.example.com&priority=15"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_change_mx.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_change_mx.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/change_mx/,\n    {\n        'domain' => 'example.com',\n        'exchanger' => 'mail.example.com',\n        'oldexchanger' => 'mail.example.com',\n        'priority' => '15',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_change_mx.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_change_mx.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'change_mx',\n    array (\n        'domain' => 'example.com',\n        'exchanger' => 'mail.example.com',\n        'oldexchanger' => 'mail.example.com',\n        'priority' => '15',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/count_auto_responders":{"get":{"description":"This function returns the number of [autoresponders](https://go.cpanel.net/Autoresponders) for every email address on a cPanel account.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles#roles), the system **disables** this function.","operationId":"count_auto_responders","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"count_auto_responders","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"The number of email autoresponders.\n* `0`\n* A positive integer.","example":1,"minimum":0,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel account's autoresponders total","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  count_auto_responders\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/count_auto_responders"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_count_auto_responders.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_count_auto_responders.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/count_auto_responders/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_count_auto_responders.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_count_auto_responders.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'count_auto_responders'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/Email/check_fastmail":{"get":{"description":"This function checks whether [BlackBerry® FastMail](https://go.cpanel.net/blackberryfastmail) support is enabled.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles#roles), the system **disables** this function.","operationId":"check_fastmail","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"check_fastmail","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"The contents of the server's `/var/cpanel/fastmail` file.\n* A positive value that represents a BlackBerry FastMail version number if it is enabled on the server.\n* A `null` value if BlackBerry FastMail is not enabled on the server.","example":"2","type":"string"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return BlackBerry FastMail support status","tags":["Email","Email Server Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  check_fastmail\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/check_fastmail"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_check_fastmail.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_check_fastmail.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/check_fastmail/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_check_fastmail.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_check_fastmail.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'check_fastmail'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/count_filters":{"get":{"description":"This function returns the number of [email filters](https://go.cpanel.net/cpaneldocsEmailFilters) for every email address on a cPanel account.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles) or the [*IP Blocker*](https://go.cpanel.net/whmdocsFeatureManager) feature, the system **disables** this function. For more information, read our [How to Use Server Profiles](https://go.cpanel.net/howtouseserverprofiles) documentation.","operationId":"count_filters","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"count_filters","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"The number of email filters.\n* `0`\n* A positive integer.","example":1,"minimum":0,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel account's email filters total","tags":["Email","Email Filtering"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  count_filters\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/count_filters"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_count_filters.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_count_filters.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/count_filters/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_count_filters.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_count_filters.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'count_filters'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/Email/count_pops":{"get":{"description":"This function returns the number of [email accounts](https://go.cpanel.net/cpaneldocsEmailAccounts) for a cPanel account.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles#roles), the system **disables** this function.","operationId":"count_pops","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"count_pops","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"The number of email accounts.\n* `0`\n* A positive integer.","example":1,"minimum":0,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel account's email account total","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  count_pops\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/count_pops"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_count_pops.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_count_pops.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/count_pops/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_count_pops.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_count_pops.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'count_pops'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/Email/delete_domain_forwarder":{"get":{"description":"This function deletes a domain-level forwarder.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"delete_domain_forwarder","parameters":[{"description":"The domain name.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"delete_domain_forwarder","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete domain-level forwarder","tags":["Email","Email Forwarding"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  delete_domain_forwarder \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/delete_domain_forwarder?domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_delete_domain_forwarder.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_delete_domain_forwarder.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/delete_domain_forwarder/,\n    {\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_delete_domain_forwarder.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_delete_domain_forwarder.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'delete_domain_forwarder',\n    array (\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/count_lists":{"get":{"description":"This function returns the number of [mailing lists](https://go.cpanel.net/MailingLists) for every email address on a cPanel account.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles#roles), the system **disables** this function.","operationId":"count_lists","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"count_lists","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"The number of mailing lists.\n* `0`\n* A positive integer.","example":1,"minimum":0,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel account's mailing list total","tags":["Email","Mailing Lists"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  count_lists\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/count_lists"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_count_lists.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_count_lists.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/count_lists/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_count_lists.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_count_lists.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'count_lists'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/Email/delete_mx":{"get":{"description":"This function deletes a Mail Exchanger (MX) record. For more information about MX record settings, read our [Email Routing Configuration](https://go.cpanel.net/whmdocsEmailRoutingConfiguration) documentation.\n\n**Important:**\n\n  When you disable the [DNS role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"delete_mx","parameters":[{"description":"The mail exchanger's domain.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"The mail exchanger's name.","in":"query","name":"exchanger","required":true,"schema":{"example":"mail.example.com","type":"string"}},{"description":"The mail exchanger's [priority value](https://go.cpanel.net/whmdocsEditMXEntry). If multiple MX entries match the exchanger value, the system uses this parameter to find the correct entry.","in":"query","name":"priority","required":true,"schema":{"example":15,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"delete_mx","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"properties":{"checkmx":{"description":"An object containing the mail exchanger's data.","properties":{"changed":{"description":"Whether a change occurred during the function.\n* `1` - Change occurred.\n* `0` - **No** change.","enum":[0,1],"example":1,"type":"integer"},"detected":{"description":"The mail exchanger type.\n* `auto`\n* `local`\n* `secondary`\n* `remote`","enum":["auto","local","secondary","remote"],"example":"auto","type":"string"},"isprimary":{"description":"Whether the mail exchanger is the primary mail exchanger.\n* `1` - Primary.\n* `0` - **Not** primary.","enum":[0,1],"example":0,"type":"integer"},"issecondary":{"description":"Whether the mail exchanger is a secondary exchanger.\n* `1` - Secondary.\n* `0` - **Not** secondary.","enum":[0,1],"example":0,"type":"integer"},"local":{"description":"Whether the mail exchanger is a local exchanger.\n* `1` - Local.\n* `0` - **Not** local.","enum":[0,1],"example":0,"type":"integer"},"mxcheck":{"description":"The mail exchanger type.\n* `auto`\n* `local`\n* `secondary`\n* `remote`","enum":["auto","local","secondary","remote"],"example":"auto","type":"string"},"remote":{"description":"Whether the mail exchanger is a remote exchanger.\n* `1` - Remote.\n* `0` - **Not** remote.","enum":[0,1],"example":0,"type":"integer"},"secondary":{"description":"Whether the mail exchanger is a secondary exchanger.\n* `1` - Secondary.\n* `0` - **Not** secondary.","enum":[0,1],"example":0,"type":"integer"},"warnings":{"description":"Warning messages, if any exist.","example":"Auto Detect of MX configuration not possible due to non-resolving MX entries. Defaulting to last known setting: local.","items":{"type":"string"},"type":"string"}},"type":"object"},"results":{"description":"A message of success, or an error message.\n* A message of success that begins with `Removed entry:`.\n* An error message.","example":"Removed entry: example.com. IN MX 15 mail.example.com\nBind reloading on example using rndc zone: [example.com]","type":"string"},"status":{"description":"Whether the function succeeded.\n* `1` - Success.\n* `0` - Failure.","enum":[0,1],"example":1,"type":"integer"},"statusmsg":{"description":"A message of success, or an error message.\n* A message of success that begins with Added entry.\n* An error message.","example":"Removed entry: example.com. IN MX 15 mail.example.com\nBind reloading on example using rndc zone: [example.com]","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete mail exchanger record","tags":["Email DNS Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  delete_mx \\\n  domain='example.com' \\\n  exchanger='mail.example.com' \\\n  priority='15'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/delete_mx?domain=example.com&exchanger=mail.example.com&priority=15"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_delete_mx.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_delete_mx.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/delete_mx/,\n    {\n        'domain' => 'example.com',\n        'exchanger' => 'mail.example.com',\n        'priority' => '15',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_delete_mx.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_delete_mx.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'delete_mx',\n    array (\n        'domain' => 'example.com',\n        'exchanger' => 'mail.example.com',\n        'priority' => '15',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/EmailAuth/apply_dmarc":{"get":{"description":"This function applies a DMARC record to the specified domain(s)","operationId":"EmailAuth::apply_dmarc","parameters":[{"description":"The domain for which to apply the DMARC record.\n\n**Note:**\n\nTo enable multiple domain DMARC records, duplicate or increment the parameter. For example, to enable DMARC records for three domains, perform either of the following actions:\n\n* Use the `domain` parameter three times.\n* Use the `domain`, `domain-1`, and `domain-2` parameters.\n\nIf you do not include this argument, the system applies the DMARC record to all the user's domains.","examples":{"multiple":{"summary":"Enable multiple domains' DMARC records.","value":"domain-1=example1.com domain-2=example2.com domain-3=example3.com"},"multiple-alternative":{"summary":"Enable multiple domains' DMARC records.","value":"domain=example1.com domain=example2.com domain=example3.com"},"single":{"summary":"Enable a single domain's DMARC records.","value":"example.com"}},"in":"query","name":"domain","required":false,"schema":{"format":"domain","type":"string"}},{"description":"The DMARC record to apply to the requested domains.\n\n**Note:**\n\nVisit the following link for more information about the DMARC record specification: https://dmarc.org/resources/specification/","example":"v=DMARC1;p=reject;pct=100;rua=mailto:postmaster@example.com","in":"query","name":"policy","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"apply_dmarc","type":"string"},"module":{"description":"The name of the module called.","example":"EmailAuth","type":"string"},"result":{"properties":{"data":{"description":"An array that contains information about the DMARC records applied to domains.","items":{"properties":{"domain":{"description":"The domain for which the DMARC record was applied.","example":"example.com","format":"domain","type":"string"},"msg":{"description":"The domain's DMARC record status message.","example":"[ADD:TXT@_dmarc.example.com:v=DMARC1; p=reject;]","type":"string"},"status":{"description":"Whether the system applied a DMARC record to the domain.\n* `1` - Applied.\n* `0` - The system did **not** apply a DMARC record.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Apply DMARC records to domains.","tags":["EmailAuth","Email DNS Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  EmailAuth \\\n  apply_dmarc \\\n  domain='example.com' \\\n  policy='v=DMARC1; p=reject;'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/EmailAuth/apply_dmarc?domain=example.com&policy='v=DMARC1; p=reject;'"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file EmailAuth_apply_dmarc.live.pl and put this code into that file.\n# 5) In your browser log in to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/EmailAuth_apply_dmarc.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/EmailAuth/,\n    q/apply_dmarc/,\n    {\n        'domain' => 'example.com',\n        'policy' => 'v=DMARC1; p=reject;'\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html-printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file EmailAuth_apply_dmarc.live.php and put this code into that file.\n// 5) In your browser log in to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/EmailAuth_apply_dmarc.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'EmailAuth',\n    'apply_dmarc',\n    array (\n        'domain' => 'example.com',\n        'policy' => 'v=DMARC1; p=reject;'\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"124"}},"/DNSSEC/export_zone_key":{"get":{"description":"This function exports a DNSSEC security key.\n\n**Important:**\n\nWhen you disable the [DNS](https://go.cpanel.net/serverroles) role, the system **disables** this function.","operationId":"export_zone_key","parameters":[{"description":"The security key's domain.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"The security key's ID.","in":"query","name":"key_id","required":true,"schema":{"example":12345,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"export_zone_key","type":"string"},"module":{"description":"The name of the module called.","example":"DNSSEC","type":"string"},"result":{"properties":{"data":{"properties":{"domain":{"description":"The security key's domain.","example":"example.com","format":"domain","type":"string"},"key_content":{"description":"The content of the key, which includes the algorithm.","example":"Private-key-format: v1.2\nAlgorithm: 8 (RSASHA256)\nModulus: 9i8AlGZkwKJj6HYZX+9OcOyCMQ0L9eHBaTg2Y83cVBSaIyiIWo54QpuiJykiuFYYHihOi+LW8vfU9A9jXLBs7DaeDkXO49OqYxfgD1vwmztJeXCQlmgxqUeD181gtSTNO43uUMkCisZft+OsJ96bdUof1UeJ1+IuSENBr1TZgYjmzBgIkmjdv8T5muPaaDfeOISLJKGOG2gI0xlyQ39ppd3CeB90cpIvFpCGjNC8nGvIqN4oyny6NftcEhaRFudbEhB6t2gI362wS5ohERK1F1rBTt+mqUwszCv46Y6p3Za3PsebWK7fR6ITnsW7KGyn3r8BxpJTHlHMwOtBPosaXw==\nPublicExponent: AQAB\nPrivateExponent: MZO5nCkatSh+0jumVImO1HLsrRAhjnzORHBLk8HLUytq9xWckBAM6+0HtLc2BMVhygD4AHfILdn3CsdmjS4CYXeGUP2B8qOXtqkCOFWdmMVRwKEInSGSjrKWPIlhplko84tbqO0yE9xrPk8dRlIwIGizDHKBsfYct/TDb5m4y7rvEHcBSm2DZz7AQL1qqC/WYI54qxHFXTId+nKsYMx/alRUV3AOSL20VSgL56VcM1luFS76ylDIWEOrQVyTFCtEcHvw3FLIOEVCM/CAErLFNlFdXHnYcRYnG/oXcsPW0DjpPNrqx8iaAOuhYFd/pu9CvKQnxYLLqXByOkSUIO3ggQ==\nPrime1: /mtiBD3gJ5Yu5ARsLew4eohRAobl4c3Bt9Gw62wmHiOJfgjbnY91H/bxc/ilnQh92yZUfxfm5z6FXEqluh0ZN3BOQTwzUEuTT9Pn00FhRfemL0UMpHn0BkoXCLwjs1XRyI0hXTOhGhH7XVczuYw/S7kWT5Cmfo4MODZ6cooR8SE=\nPrime2: 97aFfZxJcTYTKkZTc7yeUQVWTtKF25L780TRuCiG83hTSNKlmuWE2bAU/Cl2CX2NdW5sBmO5z9fEI5rA8LhuWHlKF82cXg1h50CsXkaAhFKrThMmb6SRSjIksxlz7rtK777z4En/V9v3l1yKcQ5eSQYQRHg1cCkn6NNlZPZ2G38=\nExponent1: LoHarQPSken2MGBOliZ0PJHmnRujsh82pi+Cs8ZVQXUlkRB1dNvggTNW9+gf/hCrUQA0ufbYkrTvE+vhV6AyF9xDsdEbYDYwe4s0+X0eFvgqPMHWicpxPSUWCNa7f/DUJGEIFE13yZg35twl7GkiuOjglzLN/Jxix3PN9loe5YE=\nExponent2: Mya4iAimzb7p1DfzcZnIY1ijyuEEDSRb7I8Qc2PDAjGdmRMOaV7twPnwS2XQXwNTG6Wyntsm+nlGokeJgevDtXdOSn4FxRIkXllnfow2a5yajSO9Mx6bdePG2kjuPKTmQ3195JnDJYRhqxrL566c351l7I2aE1AcUqKcdG3EU8c=\nCoefficient: T4dFDz5pQhVUQSjV0hhKHHZ1wBxiXdZeCFIfbyypWEdxGXdX2lIN264u9cGQhI+iExTEjZCaYASMBzOqnIhkHhj0M1DGYrhRCdTpgxmDwdcHniRl/XMxPGqpmsP4WFCBxmIbr3SdnqoiPMXix0SjWkHTisq5i09DBMNGIGQyqS8=\n\n","type":"string"},"key_id":{"description":"The security key's ID.","example":12345,"minimum":1,"type":"integer"},"key_tag":{"description":"The security key's internal identifier.","example":51640,"minimum":1,"type":"integer"},"key_type":{"description":"The security key's signing type.\n\n* `CSK` - Combined Signing Key.\n* `KSK` - Key Signing Key.\n* `ZSK` - Zone Signing Key.","enum":["CSK","KSK","ZSK"],"example":"KSK","type":"string"},"success":{"description":"Whether the function succeeded.\n\n* `1` - The function succeeded.\n* `0` - The function failed.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Export DNSSEC security key","tags":["DNSSEC","DNS Security"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DNSSEC \\\n  export_zone_key \\\n  domain='example.com' \\\n  key_id='12345'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DNSSEC/export_zone_key?domain=example.com&key_id=12345"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DNSSEC_export_zone_key.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DNSSEC_export_zone_key.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DNSSEC/,\n    q/export_zone_key/,\n    {\n        'domain' => 'example.com',\n        'key_id' => '12345',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DNSSEC_export_zone_key.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DNSSEC_export_zone_key.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DNSSEC',\n    'export_zone_key',\n    array (\n        'domain' => 'example.com',\n        'key_id' => '12345',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 84"}},"/DNSSEC/enable_dnssec":{"get":{"description":"This function enables DNSSEC on the domain.\n\n**Note:**\n\n * After you enable DNSSEC on the domain, you **must** add the DNS records to your registrar.\n * You **cannot** modify the DNSSEC security key. To make any changes, you **must** disable (and delete) and re-create the DNSSEC security key.\n\n**Important:**\n\n  When you disable the [DNS role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"enable_dnssec","parameters":[{"description":"The domain on which to enable DNSSEC.\n\n**Note:**\n\n To enable DNSSEC on multiple domains, increment the parameter name. For example: `domain-0`, `domain-1`, `domain-2`.","examples":{"multiple":{"summary":"To enable DNSSEC on multiple domains.","value":"domain-0=example0.com&domain-1=example1.com&domain-2=example2.com"},"single":{"summary":"To enable DNSSEC on a single domain.","value":"example.com"}},"in":"query","name":"domain","required":true,"schema":{"format":"domain","type":"string"}},{"description":"Whether the domain will use [Next Secure Record](https://tools.ietf.org/html/rfc4470) (NSEC) or NSEC3 semantics.\n\n* `1` — Use NSEC3 semantics.\n* `0` — Use NSEC semantics.\n\n**Note:**\n\n If you use NSEC semantics (`0`), the system ignores the other NSEC3 options.","in":"query","name":"use_nsec3","required":false,"schema":{"default":1,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether the system will create records for all delegations.\n\n* `1` — Create records for all delegations.\n* `0` — Create records only for secure delegations.\n\n**Note:**\n\n **Only** select `1` if you **must** create records for all delegations.","in":"query","name":"nsec3_opt_out","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"The number of times that the system rehashes the first resource record hash operation.\n\nA positive integer less than `501`.","in":"query","name":"nsec3_iterations","required":false,"schema":{"default":7,"example":7,"maximum":500,"minimum":1,"type":"integer"}},{"description":"Whether NSEC3 will operate in Narrow or Inclusive mode.\n\nIn Narrow mode, PowerDNS sends out white lies about the next secure record. Rather than query the resource record in the database, PowerDNS sends the hash plus `1` as the next secure record.\n\n* `1` — Narrow mode.\n* `0` — Inclusive mode.","in":"query","name":"nsec3_narrow","required":false,"schema":{"default":1,"enum":[0,1],"example":1,"type":"integer"}},{"description":"A hexadecimal string that the system appends to the domain name before it applies the hash function to the name. For more information about the salt value, read the [RFC 5155](https://tools.ietf.org/html/rfc5155#section-3.1.5) documentation.\n\nIf you do not declare a value, the system defaults to a random 64-bit value.","in":"query","name":"nsec3_salt","required":false,"schema":{"example":"1A2B3C4D5E6F","format":"hex","maxLength":255,"type":"string"}},{"description":"The algorithm that the system uses to generate the security key.\n\n* `5` — RSA/SHA-1\n* `6` — DSA-NSEC3-SHA1\n* `7` — RSASHA1-NSEC3-SHA1\n* `8` — RSA/SHA-256\n* `10` — RSA/SHA-512\n* `13` — ECDSA Curve P-256 with SHA-256\n* `14` — ECDSA Curve P-384 with SHA-384\n\n**Note:**\n\n We recommend that you use `ECDSA Curve P-256 with SHA-256` if your registrar supports it.","in":"query","name":"algo_num","required":false,"schema":{"default":8,"example":8,"maximum":255,"minimum":0,"type":"integer"}},{"description":"The manner in which the system creates the security key.\n\n* `simple` — Use a single key for both KSK and ZSK. Use this value when the `algo_nom` parameter is greater than `8`.\n* `classic` — Use separate keys for KSK and ZSK. Use this value when the `algo_nom` parameter is equal to or less than `8`.","in":"query","name":"key_setup","required":false,"schema":{"default":"classic","enum":["simple","classic"],"example":"classic","type":"string"}},{"description":"Whether to activate the newly-created key.\n\n* `1` — Activate the key.\n* `0` — Do **not** activate the key.","in":"query","name":"active","required":false,"schema":{"default":1,"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"enable_dnssec","type":"string"},"module":{"description":"The name of the module called.","example":"DNSSEC","type":"string"},"result":{"properties":{"data":{"example":{"enabled":{"example.com":{"enabled":1,"new_key_id":"1","nsec_version":"NSEC3"}}},"properties":{"enabled":{"description":"An object containing information about the domains for which the system enabled DNSSEC.","properties":{"additionalProperties":{"description":"Information about the domain for which the system\nenabled DNSSEC.\n\n**Note:**\n\nThis return's name is the `domain` parameter's value.","properties":{"enabled":{"description":"Whether the system enabled DNSSEC.\n\n* `1` — The system enabled DNSSEC.\n* `0` — The system failed to enable DNSSEC.","enum":[1,0],"type":"integer"},"new_key_id":{"description":"The assigned security key ID.","example":1,"type":"integer"},"nsec_version":{"description":"The version of DNSSEC the system used.\n\n* `NSEC3`\n* `NSEC`","enum":["NSEC3","NSEC"],"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable DNSSEC","tags":["DNSSEC","DNS Security"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DNSSEC \\\n  enable_dnssec \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DNSSEC/enable_dnssec?domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DNSSEC_enable_dnssec.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DNSSEC_enable_dnssec.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DNSSEC/,\n    q/enable_dnssec/,\n    {\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DNSSEC_enable_dnssec.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DNSSEC_enable_dnssec.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DNSSEC',\n    'enable_dnssec',\n    array (\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 60"}},"/DNSSEC/import_zone_key":{"get":{"description":"This function imports a DNSSEC security key.\n\n**Important:**\n\nWhen you disable the [DNS role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"import_zone_key","parameters":[{"description":"The security key's domain.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"The security key's type.\n\n* `ksk`\n* `zsk`","in":"query","name":"key_type","required":true,"schema":{"enum":["ksk","zsk"],"example":"ksk","type":"string"}},{"description":"The security key data that the [`pdnsutil`](https://doc.powerdns.com/authoritative/manpages/pdnsutil.1.html)\nutility's `export-zone-key` call returns.","in":"query","name":"key_data","required":true,"schema":{"example":"Private-key-format:%20v1.2%0AAlgorithm:%2013%20\$ECDSAP256SHA256\$%0APrivateKey:%20xCM281KtWE9oCsUX8fP1hDZ02/X7JCjp4QZA/DZjfX0=%0A%0A","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"import_zone_key","type":"string"},"module":{"description":"The name of the module called.","example":"DNSSEC","type":"string"},"result":{"properties":{"data":{"example":{"domain":"example.com","new_key_id":"1","success":1},"properties":{"domain":{"description":"The domain for which the system imported the zone key.","example":"example.com","format":"domain","type":"string"},"error":{"description":"An error message that describes why the system could not import the security key.\n\n**Note:**\n\nThe function **only** displays this return when the `success` return is a `0` value.","example":"Error: Invalid key_id or domain specified: No such key present for domain.","type":"string"},"new_key_id":{"description":"The security key's ID.","example":"1","type":"string"},"success":{"description":"Whether the system imported the security key.\n\n* `1` - The system imported the security key.\n* `0` - The system **failed** to import the security key.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add DNSSEC security key","tags":["DNSSEC","DNS Security"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DNSSEC \\\n  import_zone_key \\\n  domain='example.com' \\\n  key_type='ksk' \\\n  key_data=$'Private-key-format:%20v1.2%0AAlgorithm:%2013%20\\\$ECDSAP256SHA256\\\$%0APrivateKey:%20xCM281KtWE9oCsUX8fP1hDZ02/X7JCjp4QZA/DZjfX0=%0A%0A'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DNSSEC/import_zone_key?domain=example.com&key_type=ksk&key_data=Private-key-format%3a%2520v1.2%250AAlgorithm%3a%252013%2520%5c%28ECDSAP256SHA256%5c%29%250APrivateKey%3a%2520xCM281KtWE9oCsUX8fP1hDZ02%2fX7JCjp4QZA%2fDZjfX0%3d%250A%250A"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DNSSEC_import_zone_key.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DNSSEC_import_zone_key.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DNSSEC/,\n    q/import_zone_key/,\n    {\n        'domain' => 'example.com',\n        'key_type' => 'ksk',\n        'key_data' => 'Private-key-format:%20v1.2%0AAlgorithm:%2013%20\$ECDSAP256SHA256\$%0APrivateKey:%20xCM281KtWE9oCsUX8fP1hDZ02/X7JCjp4QZA/DZjfX0=%0A%0A',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DNSSEC_import_zone_key.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DNSSEC_import_zone_key.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DNSSEC',\n    'import_zone_key',\n    array (\n        'domain' => 'example.com',\n        'key_type' => 'ksk',\n        'key_data' => 'Private-key-format:%20v1.2%0AAlgorithm:%2013%20\$ECDSAP256SHA256\$%0APrivateKey:%20xCM281KtWE9oCsUX8fP1hDZ02/X7JCjp4QZA/DZjfX0=%0A%0A',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 84"}},"/Team/cancel_expire":{"get":{"description":"This function stops a team user from expiring.","operationId":"cancel_expire","parameters":[{"description":"The username of the team user.","in":"query","name":"user","required":true,"schema":{"example":"teamUser","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"expire_team_user","type":"string"},"module":{"description":"The name of the module called.","example":"Team","type":"string"},"result":{"properties":{"data":{"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Stop a team user from expiring","tags":["Team Users"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Team \\\n  cancel_expire \\\n  user='teamUser'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Team/cancel_expire?user=teamUser"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account, where theme-name represents\n# jupiter.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Team_cancel_expire.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Team_cancel_expire.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Team/,\n    q/cancel_expire/,\n    {\n        'user' => 'teamUser',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account, where theme-name represents\n// jupiter.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Team_cancel_expire.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Team_cancel_expire.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Team',\n    'cancel_expire',\n    array (\n        'user' => 'teamUser',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}\n"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":110}},"/Email/export_lists":{"get":{"description":"This function exports a cPanel account's Mailman mailing lists into a CSV file.\nThis file is located in mail/exported_lists under the user's home directory.","operationId":"export_lists","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"export_lists","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Export cPanel account's Mailman mailing lists to a file","tags":["Email","Mailing Lists"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  export_lists\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/export_lists"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account, where theme-name represents\n# jupiter.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_export_lists.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_export_lists.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/export_lists/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account, where theme-name represents\n// jupiter.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_export_lists.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_export_lists.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'export_lists'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}\n"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.114"}},"/Email/count_forwarders":{"get":{"description":"This function returns the number of [forwarders](https://go.cpanel.net/Forwarders) for every email address on a cPanel account.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles#roles), the system **disables** this function.","operationId":"count_forwarders","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"count_forwarders","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"The number of email forwarders.\n* `0`\n* A positive integer.","example":1,"minimum":0,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel account's mail forwarder total","tags":["Email","Email Forwarding"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  count_forwarders\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/count_forwarders"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_count_forwarders.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_count_forwarders.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/count_forwarders/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_count_forwarders.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_count_forwarders.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'count_forwarders'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/Team/reinstate_team_user":{"get":{"description":"This function reinstates a team user by removing any suspended or expired statuses. The reason field is also cleared.","operationId":"reinstate_team_user","parameters":[{"description":"The username of the team user.","in":"query","name":"user","required":true,"schema":{"example":"teamUser","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"reinstate_team_user","type":"string"},"module":{"description":"The name of the module called.","example":"Team","type":"string"},"result":{"properties":{"data":{"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Reinstate a team user","tags":["Team Users"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Team \\\n  reinstate_team_user \\\n  user='teamUser'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Team/reinstate_team_user?user=teamUser"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account, where theme-name represents\n# jupiter.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Team_reinstate_team_user.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Team_reinstate_team_user.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Team/,\n    q/reinstate_team_user/,\n    {\n        'user' => 'teamUser',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account, where theme-name represents\n// jupiter.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Team_reinstate_team_user.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Team_reinstate_team_user.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Team',\n    'reinstate_team_user',\n    array (\n        'user' => 'teamUser',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}\n"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":108}},"/Team/set_expire":{"get":{"description":"This function expires a team user after a specified amount of time.\n\nIf the team user already has an expire date set, it's replaced with a new date and reason.","operationId":"set_expire","parameters":[{"description":"The username of the team user.","in":"query","name":"user","required":true,"schema":{"example":"teamUser","type":"string"}},{"description":"The reason for expiration.","in":"query","name":"reason","required":false,"schema":{"example":"teamUser gave a two week notice.","type":"string"}},{"description":"The epoch time on which the team user account expires, or the offset from the current time, in days. Integers are treated as Unix Epoch Time unless followed by 'days'.","examples":{"offset":{"value":"120days"},"unix-timestamp":{"value":1649948169}},"in":"query","name":"date","required":true,"schema":{"oneOf":[{"type":"integer"},{"type":"string"}]}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_expire","type":"string"},"module":{"description":"The name of the module called.","example":"Team","type":"string"},"result":{"properties":{"data":{"description":"The unix timestamp that represents when the team user expires.","type":"integer","format":"unix-timestamp","example":1674575562},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Set a team user to expire","tags":["Team Users"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Team \\\n  set_expire \\\n  user='teamUser' \\\n  date='120days'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Team/set_expire?user=teamUser&date=120days"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account, where theme-name represents\n# jupiter.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Team_set_expire.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Team_set_expire.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Team/,\n    q/set_expire/,\n    {\n        'user' => 'teamUser',\n        'date' => '120days',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account, where theme-name represents\n// jupiter.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Team_set_expire.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Team_set_expire.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Team',\n    'set_expire',\n    array (\n        'user' => 'teamUser',\n        'date' => '120days',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}\n"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":110}},"/EmailAuth/remove_dmarc":{"get":{"description":"This function removes the DMARC record for domains.","operationId":"EmailAuth::remove_dmarc","parameters":[{"description":"The domain from which to remove the DMARC record.\n\n**Note:**\n\nIf you do not include this argument, the system will remove **all** DMARC records from **all** domains owned by the user.\n\nTo remove multiple domain DMARC records, duplicate the parameter name. For example, use the `domain=example.com`, `domain=example2.com`, and `domain=example3.com` parameters.","examples":{"multiple":{"summary":"Multiple domains.","value":"domain=example.com&domain=example2.com&domain=example.com"},"single":{"summary":"A single domain.","value":"example.com"}},"in":"query","name":"domain","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"remove_dmarc","type":"string"},"module":{"description":"The name of the module called.","example":"EmailAuth","type":"string"},"result":{"properties":{"data":{"description":"An array of objects that contain information about the removed DMARC records.","items":{"properties":{"domain":{"description":"The domain for which the DMARC record was removed.","example":"example.com","format":"domain","type":"string"},"msg":{"description":"Information about the removed DMARC record.","example":"[REMOVE:TXT@_dmarc.example.com:v=DMARC1; p=reject;]","type":"string"},"status":{"description":"Whether the system removed the domain's DMARC record.\n* `1` - The system removed the domain's DMARC record.\n* `0` - The system did **not** remove the domain's DMARC record.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove DMARC record from domain(s)","tags":["EmailAuth","Email DNS Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  EmailAuth \\\n  remove_dmarc \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/EmailAuth/remove_dmarc?domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file EmailAuth_remove_dmarc.live.pl and put this code into that file.\n# 5) In your browser log in to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/EmailAuth_remove_dmarc.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/EmailAuth/,\n    q/remove_dmarc/,\n    {\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html-printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file EmailAuth_remove_dmarc.live.php and put this code into that file.\n// 5) In your browser log in to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/EmailAuth_remove_dmarc.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'EmailAuth',\n    'remove_dmarc',\n    array (\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html-printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"124"}},"/leika_get_config":{"get":{"summary":"Retrieve configuration data from the Leika module.","description":"This function retrieves configuration data from the Leika module.\nIf no `item` parameter is provided, the entire configuration is returned.\nIf specific item parameters are provided, only those keys are returned. If a value returned is undefined then either the item does not exist or it is explicitly set to null.\n","operationId":"leika_get_config","parameters":[{"name":"item","in":"query","description":"The configuration item(s) to retrieve. Pass multiple `item` parameters for multiple keys.","required":false,"schema":{"type":"string"},"examples":{"cpanel.key1":{"value":"cpanel.key1","description":"Retrieve the value for the `key1` configuration key within the `cpanel` section of the configuration."},"webmail.key3.subkey1":{"value":"webmail.key3.subkey1","description":"Retrieve the value for the nested key `key3.subkey1` within the `webmail` section of the configuration."}}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","description":"The requested configuration data.","example":{"cpanel.key1":"enabled","webmail.key3":{"subkey1":"active","subkey2":"inactive"}}},"metadata":{"type":"object","description":"Metadata about the API response.","properties":{"command":{"type":"string","description":"The method name called.","example":"leika_get_config"},"reason":{"type":"string","description":"The reason for success or failure.","example":"OK"},"result":{"type":"integer","description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.\n","example":1},"version":{"type":"integer","description":"The version of the API function.","example":1}}}}}}}}},"tags":["Leika"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi Leika leika_get_config item='key1' item='key3'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/execute/Leika/leika_get_config?item=key1&item=key3\n"}]}},"/DNSSEC/export_zone_dnskey":{"get":{"description":"This function exports a domain's DNSKEY record value.\n\n**Important:**\n\nWhen you disable the [_DNS_ role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"export_zone_dnskey","parameters":[{"description":"The domain from which to fetch the DNSKEY record value.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"The DNSSEC record's ID.","in":"query","name":"key_id","required":true,"schema":{"example":12345,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"export_zone_dnskey","type":"string"},"module":{"description":"The name of the module called.","example":"DNSSEC","type":"string"},"result":{"properties":{"data":{"properties":{"dnskey":{"description":"The DNSKEY record value.","example":"AwEAAch8SGW4vE6PjFWA9rbUm0AfTq+gJ0HC/nLu+2axdWHBIStt9lsOzKDorAr4vlmhlJzEzA62s96xp6mZ7XHUyWnkFwLs8obo6upL2in4h1ToOxzVl3lTs8O+kWtDq5/h1nwFlPDs9zpLJhlkTCtx2OTGbvimEYeqwPolUuSQR/Yb","type":"string"},"key_id":{"description":"The DNSSEC record's ID.","example":12345,"minimum":1,"type":"integer"},"success":{"description":"Whether the DNSKEY record exported successfully.\n\n* `1` - The system exported the record successfully.\n* `0` - The system failed to export the record.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Export DNSKEY record value","tags":["DNSSEC","DNS Security"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DNSSEC \\\n  export_zone_dnskey \\\n  domain='example.com' \\\n  key_id='12345'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DNSSEC/export_zone_dnskey?domain=example.com&key_id=12345"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DNSSEC_export_zone_dnskey.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DNSSEC_export_zone_dnskey.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DNSSEC/,\n    q/export_zone_dnskey/,\n    {\n        'domain' => 'example.com',\n        'key_id' => '12345',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DNSSEC_export_zone_dnskey.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DNSSEC_export_zone_dnskey.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DNSSEC',\n    'export_zone_dnskey',\n    array (\n        'domain' => 'example.com',\n        'key_id' => '12345',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 88"}},"/LogManager/delete_archive":{"get":{"description":"Delete a specific log archive file from the authenticated user's `~/logs` directory.","operationId":"LogManager_delete_archive","parameters":[{"description":"The log archive filename to delete. Requirements:\n* Must reside in the user's `~/logs` directory.\n* Must end with `.gz`.\n* Must not contain path traversal characters.\n","in":"query","name":"file","required":true,"schema":{"example":"example.com-Aug-2024.gz","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"delete_archive","type":"string"},"module":{"description":"The name of the module called.","example":"LogManager","type":"string"},"result":{"properties":{"data":{},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.\n","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete a log archive file","tags":["LogManager","Logs"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  LogManager \\\n  delete_archive \\\n  file=example.com-Aug-2024.gz\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/LogManager/delete_archive?file=example.com-Aug-2024.gz"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file LogManager_delete_archive.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/LogManager_delete_archive.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/LogManager/,\n    q/delete_archive/,\n    {\n        'file' => 'example.com-Aug-2024.gz',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    print to_json($data);\n}\nelse {\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file LogManager_delete_archive.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/LogManager_delete_archive.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'LogManager',\n    'delete_archive',\n    array (\n        'file' => 'example.com-Aug-2024.gz',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    print to_json($data);\n}\nelse {\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 136"}},"/DNSSEC/fetch_ds_records":{"get":{"description":"This function fetches a domain's Delegation of Signing (DS) records.\n\n**Important:**\n\nWhen you disable the [DNS role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"fetch_ds_records","parameters":[{"description":"The domain from which to fetch DS records.\n\n**Note:**\n\n To enable DNSSEC on multiple domains, increment the parameter name. For example: `domain-0`, `domain-1`, `domain-2`.","examples":{"multiple":{"summary":"To fetch DS records on multiple domains.","value":"domain-0=example0.com&domain-1=example1.com&domain-2=example2.com"},"single":{"summary":"To fetch DS records on a single domain.","value":"example.com"}},"in":"query","name":"domain","required":true,"schema":{"format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"fetch_ds_records","type":"string"},"module":{"description":"The name of the module called.","example":"DNSSEC","type":"string"},"result":{"properties":{"data":{"example":{"example.com":{"keys":{"33930":{"active":1,"algo_desc":"RSA/SHA-256","algo_num":"8","algo_tag":"RSASHA256","bits":1024,"created":"1590002705","flags":256,"key_id":2,"key_tag":33930,"key_type":"ZSK","privatekey":"Private-key-format: v1.2\nAlgorithm: 8 (RSASHA256)\nModulus: wcZl882v587qKmt3M7+y6u+kzSgCvfgyiSGQHE2EulDcAnfEmz/ryanXMveHGBsO4L/GynYYUUsGvD2jHK1ITh8CeISiqmbUmPolf9HLQgwcT5pVcvwJ0Wmzpw5Ukmx67N7TTX+yieI5OyflP23GnJYQ5EQUzBu/DhdxhL90hYU=\nPublicExponent: AQAB\nPrivateExponent: EnoBdKrTMA5Jw7u1hQitXbt2Al3jTQvifbLmk9xMYJufLtkOtSL2L6dzLpftmL3TwFho8xspnG7D+KUD7ZMURrwxnLlqTttaL2PeaYJdQ184ezuflExppkDkdTEOqcIUuSylfAbyIdeGkVFuWr0cdjM9OFKMAkoYaVeAUP0SYU0=\nPrime1: 4eslxBBwyvXzmFqKx5TTiHfU7EHIAxUru3ykOMqD2tVMHbRAq5AMKZL6ZhuTXk8mnGppEfC6qqNKnf3VT5jLxw==\nPrime2: 25OUAsWWAJrQ4uLytsXoSbjHsVyh61DgZ4S4n2Mv7RsSHt0Q/VcuyvHXuAKb8Y0XCYczZBtEW+ZoPte/HHnsUw==\nExponent1: Xkb4AqLtvvT2i8y0/2avA9MmCtXEtuydzGbOTVjNv4OlePvgxPee67aHQhcd34xeS4XohPEVpOHx4I6t9sKHvw==\nExponent2: ulZDBRcodNrs6Z4u22yX8/gbfyhdQJUh2reG9bv2sAB/wEJaaKPT0eXqav3L2PKfCjbyJcH+AP9G+A2e4UuWgQ==\nCoefficient: mynNLSgStpQMktIEdysefyOg5jpXE3VeDZF6fbEOUg+E2ZnLBkLu4KPrriCwfl+cLagwgzx2M6wV/1QWkm8vPQ=="},"nsec_details":{"nsec3_hash_algo_desc":"SHA-1","nsec3_hash_algo_num":"1","nsec3_iterations":"3","nsec3_narrow":1,"nsec3_opt_out":"0","nsec3_salt":"fa1ac2c1rd7fbab4","nsec_version":"NSEC3"}}}},"properties":{"additionalProperties":{"description":"An object containing the domain's DS record information.\n\n**Note:**\n\nThe return's name is the domain's name.","properties":{"keys":{"description":"The DS keys on the requested domain.","properties":{"additionalProperties":{"description":"The information related to the domain's DNSSEC record.\n\n**Note:**\n\nThe return's name is the `key_tag` return's integer value.","properties":{"active":{"description":"Whether the DS key is active.\n\n* `1` - Active.\n* `0` - Inactive.","enum":[0,1],"example":1,"type":"integer"},"algo_desc":{"description":"A description of the algorithm\nthat the DS key uses.","example":"RSA/SHA-256","type":"string"},"algo_num":{"description":"The algorithm the system generated for the security key.\n\n* `5` - RSA/SHA-1\n* `6` - DSA-NSEC3-SHA1\n* `7` - RSASHA1-NSEC3-SHA1\n* `8` - RSA/SHA-256\n* `10` - RSA/SHA-512\n* `13` - ECDSA Curve P-256 with SHA-256\n* `14` - ECDSA Curve P-384 with SHA-384","enum":[5,6,7,8,10,13,14],"example":8,"type":"integer"},"algo_tag":{"description":"The short-form reference to the algorithm.","example":"RSASHA256","type":"string"},"bits":{"description":"The DS key's size, in bits.","example":2048,"minimum":1,"multipleOf":64,"type":"integer"},"created":{"description":"The key's creation time.","example":1590002705,"format":"unix_timestamp","type":"integer"},"digests":{"description":"The information that\n the registrar uses to populate the DS records.","items":{"properties":{"algo_desc":{"description":"A description of the algorithm\n that the DS key uses.","example":"SHA-256","type":"string"},"algo_num":{"description":"A IETF-recognized DNSSEC Algorithm Number.","example":2,"minimum":1,"type":"integer"},"digest":{"description":"The actual digest in the DS record.","example":"4de3e58f1238fb7fc7caa84389ef6fa27d42572c35f1152c7f2ea3b899400019","type":"string"}},"type":"object"},"type":"array"},"flags":{"description":"An integer that determines the `key_type` value.\n\n* `256` - A Zone Signing Key (ZSK).\n* `257` - A Combined Signing Key (CSK) or Key Signing Key (KSK).","enum":[256,257],"example":257,"type":"integer"},"key_id":{"description":"PowerDNS's internal identifier.","example":1,"minimum":1,"type":"integer"},"key_tag":{"description":"The DS key's identification number.","example":34519,"minimum":1,"type":"integer"},"key_type":{"description":"The DS key's signing type.\n* `CSK` - Combined Signing Key.\n* `KSK` - Key Signing Key.\n* `ZSK` - Zone Signing Key.","enum":["CSK","KSK","ZSK"],"example":"KSK","type":"string"},"privatekey":{"description":"The DS key's private key, in ISC format.","example":"Private-key-format: v1.2\nAlgorithm: 8 (RSASHA256)\nModulus: wcZl882v587qKmt3M7+y6u+kzSgCvfgyiSGQHE2EulDcAnfEmz/ryanXMveHGBsO4L/GynYYUUsGvD2jHK1ITh8CeISiqmbUmPolf9HLQgwcT5pVcvwJ0Wmzpw5Ukmx67N7TTX+yieI5OyflP23GnJYQ5EQUzBu/DhdxhL90hYU=\nPublicExponent: AQAB\nPrivateExponent: EnoBdKrTMA5Jw7u1hQitXbt2Al3jTQvifbLmk9xMYJufLtkOtSL2L6dzLpftmL3TwFho8xspnG7D+KUD7ZMURrwxnLlqTttaL2PeaYJdQ184ezuflExppkDkdTEOqcIUuSylfAbyIdeGkVFuWr0cdjM9OFKMAkoYaVeAUP0SYU0=\nPrime1: 4eslxBBwyvXzmFqKx5TTiHfU7EHIAxUru3ykOMqD2tVMHbRAq5AMKZL6ZhuTXk8mnGppEfC6qqNKnf3VT5jLxw==\nPrime2: 25OUAsWWAJrQ4uLytsXoSbjHsVyh61DgZ4S4n2Mv7RsSHt0Q/VcuyvHXuAKb8Y0XCYczZBtEW+ZoPte/HHnsUw==\nExponent1: Xkb4AqLtvvT2i8y0/2avA9MmCtXEtuydzGbOTVjNv4OlePvgxPee67aHQhcd34xeS4XohPEVpOHx4I6t9sKHvw==\nExponent2: ulZDBRcodNrs6Z4u22yX8/gbfyhdQJUh2reG9bv2sAB/wEJaaKPT0eXqav3L2PKfCjbyJcH+AP9G+A2e4UuWgQ==\nCoefficient: mynNLSgStpQMktIEdysefyOg5jpXE3VeDZF6fbEOUg+E2ZnLBkLu4KPrriCwfl+cLagwgzx2M6wV/1QWkm8vPQ==","type":"string"}},"type":"object"}},"type":"object"},"nsec_details":{"description":"An object containing the [Next Secure Record](https://tools.ietf.org/html/rfc4470) (NSEC) information for the selected domain.\n\n**Note:**\n\n If the domain uses NSEC semantics, only the `nsec_version` return appears in the object.","properties":{"nsec3_hash_algo_desc":{"description":"A description of the NSEC3 key's algorithm.","example":"SHA-1","type":"string"},"nsec3_hash_algo_num":{"description":"The DNSSEC Digest Algorithm Number.","example":1,"type":"integer"},"nsec3_iterations":{"description":"The number of times that the system rehashes the first hash operation.","example":12,"type":"integer"},"nsec3_narrow":{"description":"Whether NSEC3 will operate in Narrow or Inclusive mode.\n\n* `1` - Narrow mode.\n* `0` - Inclusive mode.\n\n**Note:**\n\n For more information about these modes, read [PowerDNS's DNSSEC documentation](https://doc.powerdns.com/authoritative/dnssec/intro.html).","enum":[0,1],"example":1,"type":"integer"},"nsec3_opt_out":{"description":"Whether NSEC3 will create records for all delegations or only for secure delegations.\n\n* `1` - Create records for all delegations.\n* `0` - Create records only for secure delegations.","enum":[0,1],"example":1,"type":"integer"},"nsec3_salt":{"description":"The salt value that PowerDNS uses in the hashes.\n\n**Note:**\n\n For more information about the salt value, read [RFC 5155](https://tools.ietf.org/html/rfc5155#section-3.1.5).","example":"fa1ac2c1rd7fbab4","format":"hex","type":"string"},"nsec_version":{"description":"Whether the domain uses NSEC or [Next Secure Record version 3](https://tools.ietf.org/html/rfc5155) (NSEC3) [Domain Name Security Extensions](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions) (DNSSEC) semantics.\n\n* `NSEC`\n* `NSEC3`","enum":["NSEC","NSEC3"],"example":"NSEC","type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return domain's DS records","tags":["DNSSEC","DNS Security"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DNSSEC \\\n  fetch_ds_records \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DNSSEC/fetch_ds_records?domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DNSSEC_fetch_ds_records.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DNSSEC_fetch_ds_records.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DNSSEC/,\n    q/fetch_ds_records/,\n    {\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DNSSEC_fetch_ds_records.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DNSSEC_fetch_ds_records.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DNSSEC',\n    'fetch_ds_records',\n    array (\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/DNSSEC/remove_zone_key":{"get":{"description":"This function removes a DNSSEC security key.\n\n**Important:**\n\nWhen you disable the [DNS role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"remove_zone_key","parameters":[{"description":"The security key's domain.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"The security key's ID.","in":"query","name":"key_id","required":true,"schema":{"example":1,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"remove_zone_key","type":"string"},"module":{"description":"The name of the module called.","example":"DNSSEC","type":"string"},"result":{"properties":{"data":{"example":{"domain":"example.com","key_id":"12","success":1},"properties":{"domain":{"description":"The domain for which the system removed a security key.","example":"example.com","format":"domain","type":"string"},"error":{"description":"An error message that describes why the system could not remove the security key.\n\n**Note:**\n\nThe function **only** displays this return when the `success` return is a `0` value.","example":"Error: Invalid key_id or domain specified: No such key present for domain.","type":"string"},"key_id":{"description":"The security key's ID.","example":"1","type":"string"},"success":{"description":"Whether the system removed the security key.\n\n* `1` — The system removed the security key.\n* `0` — The system failed to remove the security key.","enum":[1,0],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove DNSSEC security key","tags":["DNSSEC","DNS Security"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DNSSEC \\\n  remove_zone_key \\\n  domain='example.com' \\\n  key_id='1'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DNSSEC/remove_zone_key?domain=example.com&key_id=1"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DNSSEC_remove_zone_key.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DNSSEC_remove_zone_key.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DNSSEC/,\n    q/remove_zone_key/,\n    {\n        'domain' => 'example.com',\n        'key_id' => '1',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DNSSEC_remove_zone_key.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DNSSEC_remove_zone_key.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DNSSEC',\n    'remove_zone_key',\n    array (\n        'domain' => 'example.com',\n        'key_id' => '1',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 84"}},"/EmailAuth/validate_current_dmarcs":{"get":{"description":"This function checks the validity of the current DMARC record for one or more domains.","operationId":"EmailAuth::validate_current_dmarcs","parameters":[{"description":"The domain for which to check the DMARC record.\n\n**Note:**\n\nIf you do not include this argument, the system will validate DMARC records for all domains owned by the user.","examples":{"multiple":{"summary":"Check DMARC records for multiple domains.","value":"domain=example.com,domain=another.com,domain=yetanother.com"},"single":{"summary":"Check DMARC records for a single domain.","value":"domain=example.com"}},"in":"query","name":"domain","required":false,"schema":{"format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"validate_current_dmarcs","type":"string"},"module":{"description":"The name of the module called.","example":"EmailAuth","type":"string"},"result":{"properties":{"data":{"description":"An array that contains information about the\ndomain's DMARC records. ","items":{"properties":{"domain":{"description":"The target domain of the DMARC policy.","example":"example.com","format":"domain","type":"string"},"error":{"description":"A message that details either why the DNS lookup failed, or if there is a SPF/DKIM failure.\n\n**Note:**\n\nThis will be set to `MALFORMED` if there is a syntax issue with this domain's SPF and DKIM records.","example":"(XID 4krw35) DNS returned SERVFAIL (code 2)\nin response to the system's query for _dmarc.example.com\nTXT records.","type":"string"},"record":{"description":"The domain's DMARC TXT record.","example":"v=DMARC1; p=none;","type":"string"},"state":{"description":"The domain's DMARC record status.\nPossible values:\n\n* `VALID` - A DMARC policy is set for the domain, along with valid SPF and DKIM records for the domain and IP address.\n* `MALFORMED` - A DMARC record is set, but it did not pass a syntax check.\n* `DKIM_SPF_ERROR` - A DMARC record exists; however, both the DKIM and SPF records for this domain did not pass validation.\n* `DKIM_ERROR` - A DMARC record exists; however, the DKIM record for this domain did not pass validation.\n* `SPF_ERROR` - A DMARC record exists; however, the SPF record for this domain did not pass validation.\n* `MISSING` - No DMARC record exists for the domain at the DMARC subdomain location.\n* `DNS_ERROR` - A DNS error prevented validation of the DMARC record.","enum":["VALID","MALFORMED","DKIM_SPF_ERROR","DKIM_ERROR","SPF_ERROR","MISSING","DNS_ERROR"],"example":"VALID","type":"string"},"subdomain":{"description":"The domain that the function used to check\nthe DMARC record. This will be the value of\nthe `domain` parameter with a `_dmarc` prefix.","example":"_dmarc.example.com","format":"domain","type":"string"},"suggested":{"description":"The recommended DMARC policy.","example":"v=DMARC1; p=none;","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` - Success.\n- `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Validate domains' DMARC records","tags":["EmailAuth","Email DNS Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  EmailAuth \\\n  validate_current_dmarcs \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/EmailAuth/validate_current_dmarcs?domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file EmailAuth_validate_current_dmarcs.live.pl and put this code into that file.\n# 5) In your browser log in to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/EmailAuth_validate_current_dmarcs.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/EmailAuth/,\n    q/validate_current_dmarcs/,\n    {\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file EmailAuth_validate_current_dmarcs.live.php and put this code into that file.\n// 5) In your browser log in to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/EmailAuth_validate_current_dmarcs.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'EmailAuth',\n    'validate_current_dmarcs',\n    array (\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 124"}},"/Email/delete_forwarder":{"get":{"description":"This function deletes an email forwarder.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"delete_forwarder","parameters":[{"description":"The forwarder's email address.","in":"query","name":"address","required":true,"schema":{"example":"user@example.com","format":"email","type":"string"}},{"description":"The forwarder's destination.\n* A valid email address.\n* A script location.\n* A system account.","in":"query","name":"forwarder","required":true,"schema":{"example":"fwdtome@example.com","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"delete_forwarder","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete email account's email forwarder","tags":["Email","Email Forwarding"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  delete_forwarder \\\n  address='user@example.com' \\\n  forwarder='fwdtome@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/delete_forwarder?address=user%40example.com&forwarder=fwdtome%40example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_delete_forwarder.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_delete_forwarder.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/delete_forwarder/,\n    {\n        'address' => 'user@example.com',\n        'forwarder' => 'fwdtome@example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_delete_forwarder.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_delete_forwarder.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'delete_forwarder',\n    array (\n        'address' => 'user@example.com',\n        'forwarder' => 'fwdtome@example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/delete_list":{"get":{"description":"This function deletes a Mailman mailing list.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"delete_list","parameters":[{"description":"The mailing list.","in":"query","name":"list","required":true,"schema":{"example":"mylist","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"delete_list","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete mailing list","tags":["Email","Mailing Lists"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  delete_list \\\n  list='mylist'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/delete_list?list=mylist"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_delete_list.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_delete_list.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/delete_list/,\n    {\n        'list' => 'mylist',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_delete_list.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_delete_list.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'delete_list',\n    array (\n        'list' => 'mylist',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/disable_spam_assassin":{"get":{"description":"This function disables Apache SpamAssassin™ for a cPanel account.\n\n**Important:**\n\n  When you disable the [*Spam Filter* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"disable_spam_assassin","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"disable_spam_assassin","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":["Apache SpamAssassin™ has been disabled."],"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Disable Apache SpamAssassin for cPanel account","tags":["Email","Spam Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  disable_spam_assassin\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/disable_spam_assassin"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_disable_spam_assassin.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_disable_spam_assassin.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/disable_spam_assassin/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_disable_spam_assassin.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_disable_spam_assassin.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'disable_spam_assassin'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/delete_held_messages":{"get":{"description":"This function deletes all outbound email messages held in the mail queue for the specified email account.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"delete_held_messages","parameters":[{"description":"The email address to query.","in":"query","name":"email","required":true,"schema":{"example":"username@example.com","format":"email","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"delete_held_messages","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"The number of held outbound email messages deleted from the mail queue.\n\n**Note:**\n\n  This function returns a `0` value when no messages exist in the queue.","example":0,"minimum":0,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete email account's outgoing messages","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  delete_held_messages \\\n  email='username@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/delete_held_messages?email=username%40example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_delete_held_messages.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_delete_held_messages.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/delete_held_messages/,\n    {\n        'email' => 'username@example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_delete_held_messages.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_delete_held_messages.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'delete_held_messages',\n    array (\n        'email' => 'username@example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 74"}},"/Email/disable_filter":{"get":{"description":"This function disables an email filter.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"disable_filter","parameters":[{"description":"The email address that owns the filter.","in":"query","name":"account","required":true,"schema":{"example":"user@example.com","format":"email","type":"string"}},{"description":"The filter's name.","in":"query","name":"filtername","required":true,"schema":{"example":"coffee","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"disable_filter","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"properties":{"filtername":{"description":"The filter's name. The filtername input parameter's value.","example":"coffee","type":"string"},"updated":{"description":"Whether the function updated the filter.\n* `1` - Updated,\n* `0` - Did **not** update.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Disable email filter for email account","tags":["Email","Email Filtering"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  disable_filter \\\n  account='user@example.com' \\\n  filtername='coffee'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/disable_filter?account=user%40example.com&filtername=coffee"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_disable_filter.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_disable_filter.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/disable_filter/,\n    {\n        'account' => 'user@example.com',\n        'filtername' => 'coffee',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_disable_filter.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_disable_filter.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'disable_filter',\n    array (\n        'account' => 'user@example.com',\n        'filtername' => 'coffee',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/disable_mailbox_autocreate":{"get":{"description":"This function disables the system's ability to automatically create mailboxes for a cPanel account.\n\n**Note:**\n\n  When you **enable** the UAPI's `Email::enable_mailbox_autocreate` function, the system automatically creates mailboxes. The system creates a new mailbox when it receives an email address in [plus address format](https://en.wikipedia.org/wiki/Email_address#Sub-addressing) and that mailbox does **not** exist. For example, receiving an email from the `user+newmailbox@example.com` address creates the `newmailbox` mailbox if the `newmailbox` mailbox does not exist.","operationId":"disable_mailbox_autocreate","parameters":[{"description":"The email account address for which to disable mailbox autocreation.","in":"query","name":"email","required":true,"schema":{"example":"username@example.com","format":"email","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"disable_mailbox_autocreate","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"Whether the function disabled mailbox autocreation for the cPanel account.\n* `1` - Mailbox autocreation disabled.\n* `0` - Mailbox autocreation is **not** disabled.","enum":[0,1],"example":1,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Disable cPanel account mailbox autocreation","tags":["Email","Email Server Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  disable_mailbox_autocreate \\\n  email='username@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/disable_mailbox_autocreate?email=username%40example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_disable_mailbox_autocreate.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_disable_mailbox_autocreate.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/disable_mailbox_autocreate/,\n    {\n        'email' => 'username@example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_disable_mailbox_autocreate.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_disable_mailbox_autocreate.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'disable_mailbox_autocreate',\n    array (\n        'email' => 'username@example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 78"}},"/Email/disable_spam_autodelete":{"get":{"description":"This function disables the Apache SpamAssassin™ auto-delete spam feature.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"disable_spam_autodelete","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"disable_spam_autodelete","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"properties":{"spam_auto_delete":{"description":"Whether the auto-delete spam feature is disabled. `0` is the **only** possible value.","enum":[0],"example":0,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Disable spam box filtering auto-delete","tags":["Email","Spam Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  disable_spam_autodelete\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/disable_spam_autodelete"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_disable_spam_autodelete.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_disable_spam_autodelete.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/disable_spam_autodelete/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_disable_spam_autodelete.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_disable_spam_autodelete.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'disable_spam_autodelete'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/disable_spam_box":{"get":{"description":"This function disables spam box filtering for a cPanel account. When you disable spam box filtering, the system sends all messages to the account's inbox.\n\n**Notes:**\n\n  * This function **requires** that your hosting provider enables Apache SpamAssassin™ on the server.\n  * To **enable** spam box filtering, use the UAPI `Email::enable_spam_box` function.\n  * For more information, read our [Spam Filters](https://go.cpanel.net/cpaneldocsSpamFilters) documentation.\n\n**Important:**\n\n  When you disable the [*Spam Filter* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"disable_spam_box","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"disable_spam_box","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Disable spam box filtering for cPanel account","tags":["Email","Spam Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  disable_spam_box\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/disable_spam_box"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_disable_spam_box.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_disable_spam_box.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/disable_spam_box/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_disable_spam_box.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_disable_spam_box.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'disable_spam_box'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 70"}},"/Email/edit_pop_quota":{"get":{"description":"This function changes an email address's quota.","operationId":"edit_pop_quota","parameters":[{"description":"The email account username.","in":"query","name":"email","required":true,"schema":{"example":"user","type":"string"}},{"description":"The email account's domain. Defaults to the cPanel account's main domain.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"The maximum amount of disk space that the new email account may use. Defaults to the system value.\n* A positive integer that represents the maximum amount of disk space, in megabytes (MB).\n\n**Note:**\n\nYou **cannot** enter a value that exceeds the maximum email quota.\n* `0` or `unlimited` — The account possesses unlimited disk space.\n\nIf the email account's quota value is set higher (or unlimited) than\nthe account's max quota, the account's max quota will be applied instead\nof the value entered.\n\n**Note:**\n\nThis value is only available to users without a maximum email account quota.","in":"query","name":"quota","required":false,"schema":{"example":"500","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"edit_pop_quota","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update email account's quota","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  edit_pop_quota \\\n  email='user' \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/edit_pop_quota?email=user&domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_edit_pop_quota.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_edit_pop_quota.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/edit_pop_quota/,\n    {\n        'email' => 'user',\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_edit_pop_quota.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_edit_pop_quota.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'edit_pop_quota',\n    array (\n        'email' => 'user',\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/dispatch_client_settings":{"get":{"description":"This function sends an email account's client settings to an email address.\n\n**Important:**\n\nWhen you disable the [Receive Mail role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"dispatch_client_settings","parameters":[{"description":"The email address to send client settings.","in":"query","name":"to","required":true,"schema":{"example":"user@example.com","format":"email","type":"string"}},{"description":"The email account username or address for which to send client settings.","example":"username","in":"query","name":"account","required":true,"schema":{"oneOf":[{"example":"username","format":"username","type":"string"},{"example":"username@example.com","format":"email","type":"string"}]}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"dispatch_client_settings","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Send email client settings to an email address","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  dispatch_client_settings \\\n  to='user@example.com' \\\n  account='username'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/dispatch_client_settings?to=user%40example.com&account=username"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_dispatch_client_settings.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_dispatch_client_settings.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/dispatch_client_settings/,\n    {\n        'to' => 'user@example.com',\n        'account' => 'username',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_dispatch_client_settings.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_dispatch_client_settings.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'dispatch_client_settings',\n    array (\n        'to' => 'user@example.com',\n        'account' => 'username',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 62"}},"/Email/enable_filter":{"get":{"description":"This function enables an email filter.\n\n**Important:**\n\n  When you disable the [Receive Mail role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"enable_filter","parameters":[{"description":"The email address that owns the filter.","in":"query","name":"account","required":true,"schema":{"example":"username@example.com","format":"email","type":"string"}},{"description":"The filter's name.","in":"query","name":"filtername","required":true,"schema":{"example":"coffee","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"enable_filter","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"properties":{"filtername":{"description":"The filter's name.","example":"coffee","type":"string"},"updated":{"description":"Whether the function updated the filter.\n* `1` - Updated.\n* `0` - Did **not** update.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable email filter for email account","tags":["Email","Email Filtering"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  enable_filter \\\n  account='username@example.com' \\\n  filtername='coffee'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/enable_filter?account=username%40example.com&filtername=coffee"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_enable_filter.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_enable_filter.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/enable_filter/,\n    {\n        'account' => 'username@example.com',\n        'filtername' => 'coffee',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_enable_filter.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_enable_filter.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'enable_filter',\n    array (\n        'account' => 'username@example.com',\n        'filtername' => 'coffee',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/enable_spam_box":{"get":{"description":"This function enables spam box filtering for a cPanel account. When you enable spam box filtering, the system sends messages marked as spam to a spam folder.\n\n**Notes:**\n\n* This function **requires** that your hosting provider enables Apache SpamAssassin on the server.\n* To **disable** spam box filtering, use the UAPI `Email::disable_spam_box` function.\n* For more information, read our [Spam Filters](https://go.cpanel.net/cpaneldocsSpamFilters) documentation.\n\n**Important:**\n\nWhen you disable the [Spam Filter](https://go.cpanel.net/serverroles) role, the system **disables** this function.","operationId":"enable_spam_box","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"enable_spam_box","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable spam box filtering for cPanel account","tags":["Email","Spam Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  enable_spam_box\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/enable_spam_box"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_enable_spam_box.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_enable_spam_box.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/enable_spam_box/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_enable_spam_box.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_enable_spam_box.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'enable_spam_box'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 70"}},"/Email/enable_mailbox_autocreate":{"get":{"description":"This function allows the system to automatically create mailboxes for a cPanel account. The system will create a new mailbox when it receives an email address in plus address format and that mailbox does not exist. For example, receiving an email from the user+newmailbox@example.com address creates the newmailbox mailbox if the newmailbox mailbox does not exist.\n\n**Note:**\n\n  To disable this functionality, use the UAPI Email::disable_mailbox_autocreate function.","operationId":"enable_mailbox_autocreate","parameters":[{"description":"The email account for which to enable mailbox autocreation.","in":"query","name":"email","required":true,"schema":{"example":"username@example.com","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"enable_mailbox_autocreate","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"Whether the function enabled mailbox autocreation for the cPanel account.\n- 1  Mailbox autocreation enabled.\n- 0  Mailbox autocreation is not enabled.","enum":[0,1],"example":1,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable cPanel account mailbox autocreation","tags":["Email","Email Server Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  enable_mailbox_autocreate \\\n  email='username@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/enable_mailbox_autocreate?email=username%40example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_enable_mailbox_autocreate.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_enable_mailbox_autocreate.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/enable_mailbox_autocreate/,\n    {\n        'email' => 'username@example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_enable_mailbox_autocreate.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_enable_mailbox_autocreate.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'enable_mailbox_autocreate',\n    array (\n        'email' => 'username@example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 78"}},"/Email/hold_outgoing":{"get":{"description":"This function sets Exim's queue to not send outgoing mail from an email account.\n\n**Notes:**\n\n* To send all mail from the queue, use the UAPI `Email::release_outgoing` function.\n* To reject outgoing mail and not place mail in a queue, use the UAPI `Email::suspend_outgoing` function.\n* This function does **not** hold local outgoing mail.","operationId":"hold_outgoing","parameters":[{"description":"The email account's username.","in":"query","name":"email","required":true,"schema":{"example":"username@example.com","format":"email","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"hold_outgoing","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Stop email account's outgoing mail","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  hold_outgoing \\\n  email='username@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/hold_outgoing?email=username%40example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_hold_outgoing.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_hold_outgoing.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/hold_outgoing/,\n    {\n        'email' => 'username@example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_hold_outgoing.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_hold_outgoing.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'hold_outgoing',\n    array (\n        'email' => 'username@example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 70"}},"/Email/fetch_charmaps":{"get":{"description":"This function lists the available character encodings.\n\n**Important:**\n\nWhen you disable the [Receive Mail role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"fetch_charmaps","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"fetch_charmaps","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"map":{"description":"A [character encoding](https://en.wikipedia.org/wiki/Character_encoding) that cPanel supports.","example":"utf-8","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return server's supported character encodings","tags":["Email","Email Server Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  fetch_charmaps\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/fetch_charmaps"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_fetch_charmaps.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_fetch_charmaps.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/fetch_charmaps/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_fetch_charmaps.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_fetch_charmaps.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'fetch_charmaps'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/enable_spam_assassin":{"get":{"description":"This function enables Apache SpamAssassin™ for the account.\n\n**Important:**\n\nWhen you disable the [Spam Filter role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"enable_spam_assassin","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"enable_spam_assassin","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable Apache SpamAssassin for cPanel account","tags":["Email","Spam Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  enable_spam_assassin\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/enable_spam_assassin"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_enable_spam_assassin.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_enable_spam_assassin.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/enable_spam_assassin/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_enable_spam_assassin.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_enable_spam_assassin.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'enable_spam_assassin'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/fts_rescan_mailbox":{"get":{"description":"This function requests that the IMAP Full-Text Search Indexing (powered by Apache Solr™) plugin rescan an email account.\n\n**Note:**\n\nTo enable this function, you **must** install the *IMAP Full-Text Search Indexing (powered by Apache Solr™)* plugin in WHM's [*Manage Plugins*](https://go.cpanel.net/whmdocsManagePlugins) interface (*WHM >> Home >> cPanel >> Manage Plugins*). For more information, read our [install_dovecot_fts script](https://go.cpanel.net/installdovecotftsscript) documentation.\n\n**Important:**\n\nWhen you disable the [Receive Mail role](https://go.cpanel.net/serverroles), the system disables this function.","operationId":"fts_rescan_mailbox","parameters":[{"description":"The email user's account name.\n\n**Note:**\n\nIf you do not enter an email address, the function rescans the default email account.","in":"query","name":"account","required":true,"schema":{"example":"username@example.com","format":"email","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"fts_rescan_mailbox","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"Whether the system started the rescan.\n* `1` - Success.\n* `0` - Failure.","enum":[0,1],"example":1,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Start IMAP Full-Text Search scan for email account","tags":["Email","Email Server Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  fts_rescan_mailbox \\\n  account='username@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/fts_rescan_mailbox?account=username%40example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_fts_rescan_mailbox.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_fts_rescan_mailbox.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/fts_rescan_mailbox/,\n    {\n        'account' => 'username@example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_fts_rescan_mailbox.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_fts_rescan_mailbox.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'fts_rescan_mailbox',\n    array (\n        'account' => 'username@example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 70"}},"/Email/generate_mailman_otp":{"get":{"description":"This function generates a one-time password (OTP) for a mailing list.\n\n**Note:**\n\nThe generated password expires after one use.\n\n**Important:**\n\nWhen you disable the [Receive Mail role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"generate_mailman_otp","parameters":[{"description":"The mailing list.","in":"query","name":"list","required":true,"schema":{"example":"mylist","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"generate_mailman_otp","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"The new one-time password.","example":"LfFYLPRT_UoS4EDi9lGKuOFK8FaWQsozzPYn8WjM3","type":"string"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create one-time password for a mailing list","tags":["Email","Mailing Lists"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  generate_mailman_otp \\\n  list='mylist'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/generate_mailman_otp?list=mylist"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_generate_mailman_otp.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_generate_mailman_otp.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/generate_mailman_otp/,\n    {\n        'list' => 'mylist',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_generate_mailman_otp.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_generate_mailman_otp.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'generate_mailman_otp',\n    array (\n        'list' => 'mylist',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/get_charsets":{"get":{"description":"This function lists character encodings that the mail server supports.\n\n**Important:**\n\nWhen you disable the [Receive Mail role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"get_charsets","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_charsets","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"An array of [character encodings](https://en.wikipedia.org/wiki/Character_encoding) that the mail server supports.","items":{"example":"utf-8","type":"string"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return mail server's supported character encodings","tags":["Email","Email Server Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  get_charsets\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/get_charsets"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_get_charsets.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_get_charsets.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/get_charsets/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_get_charsets.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_get_charsets.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'get_charsets'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/get_auto_responder":{"get":{"description":"This function retrieves autoresponder information.\n\n**Important:**\n\nWhen you disable the [Receive Mail role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"get_auto_responder","parameters":[{"description":"The email account name.","in":"query","name":"email","required":true,"schema":{"example":"user","format":"username","type":"string"}},{"description":"The autoresponder's [character set](https://en.wikipedia.org/wiki/Character_encoding).","in":"query","name":"temp_charset","required":false,"schema":{"default":"utf-8","example":"utf-8","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_auto_responder","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"properties":{"body":{"description":"The contents of the autoresponder message's `Body` section.","example":"This is an autoresponder message.","type":"string"},"charset":{"description":"The autoresponder's [character set](https://en.wikipedia.org/wiki/Character_encoding).","example":"UTF-8","type":"string"},"from":{"description":"The contents of the autoresponder message's `From` field.","example":"User Name","type":"string"},"interval":{"description":"The amount of time, in hours, that the server waits between autoresponder messages to the same address.\n\n**Note:**\n\nA value of `0` indicates that the system sends a message for each email received.","example":24,"minimum":0,"type":"integer"},"is_html":{"description":"Whether the body of the autoresponder message begins with an [HTML content type declaration](https://en.wikipedia.org/wiki/Character_encodings_in_HTML#Specifying_the_document.27s_character_encoding).\n- `1` - Includes an HTML content type declaration.\n- `0` - Does **not** include an HTML content type declaration.","enum":[0,1],"example":1,"type":"integer"},"start":{"description":"When the autoresponder becomes enabled in Unix time.","example":1410277881,"format":"unix_timestamp","type":"integer"},"stop":{"description":"When the autoresponder becomes disabled in Unix time.","example":1410300000,"format":"unix_timestamp","type":"integer"},"subject":{"description":"The contents of the autoresponder message's `Subject` field.","example":"Autoresponder Subject","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return email account's autoresponder information","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  get_auto_responder \\\n  email='user'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/get_auto_responder?email=user"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_get_auto_responder.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_get_auto_responder.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/get_auto_responder/,\n    {\n        'email' => 'user',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_get_auto_responder.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_get_auto_responder.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'get_auto_responder',\n    array (\n        'email' => 'user',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/get_client_settings":{"get":{"description":"This function retrieves an email account's client settings.\n\n**Important:**\n\nWhen you disable the [Receive Mail role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"get_client_settings","parameters":[{"description":"The email address for which to send client settings.\n\n**Note:**\n\nThis parameter defaults to the [system default email account](https://go.cpanel.net/systemdefaultemailaccount). ","in":"query","name":"account","required":false,"schema":{"example":"username@example.com","format":"email","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_client_settings","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"properties":{"account":{"description":"The account's email address.","example":"username@example.com","format":"email","type":"string"},"activesync_available":{"description":"Whether the account supports ActiveSync.\n* `1` — Supported.\n* `0` — **Not** supported.","enum":[1,0],"example":1,"type":"integer"},"activesync_host":{"description":"The account's ActiveSync hostname.\n\nThis return **only** appears if `activesync_available` is `1`.","example":"mail.example.com","format":"domain","type":"string"},"activesync_port":{"description":"The account's ActiveSync SSL/TLS port.\n\nThis return **only** appears if `activesync_available` is `1`.","example":2091,"maximum":65535,"minimum":1,"type":"integer"},"activesync_username":{"description":"The account's ActiveSync username.\n\nThis return **only** appears if `activesync_available` is `1`.","example":"username@example.com","format":"email","type":"string"},"display":{"description":"The account's display name.","example":"username@example.com","format":"email","type":"string"},"domain":{"description":"The account's domain name.","example":"domain.com","format":"domain","type":"string"},"from_archiving":{"description":"Whether the account is a mail archive.\n* `1` — The account is a mail archive.\n* `0` — The account is **not** a mail archive.","enum":[1,0],"example":0,"type":"integer"},"has_plaintext_authentication":{"description":"Whether the account supports plaintext authentication.\n\n* `1` — Supported.\n* `0` — **Not** supported.","enum":[1,0],"example":1,"type":"integer"},"inbox_host":{"description":"The account's hostname.","example":"mail.example.com","format":"domain","type":"string"},"inbox_insecure_port":{"description":"The account's insecure inbound port.","example":143,"maximum":65535,"minimum":1,"type":"integer"},"inbox_port":{"description":"The account's secure inbound port.","example":993,"maximum":65535,"minimum":1,"type":"integer"},"inbox_service":{"description":"The service type that the account uses.\n* `imap`\n* `pop`","enum":["imap","pop"],"example":"imap","type":"string"},"inbox_username":{"description":"The account's username.","example":"username@example.com","format":"email","type":"string"},"mail_domain":{"description":"The account's mail hostname.","example":"mail.example.com","format":"domain","type":"string"},"smtp_host":{"description":"The account's outbound SMTP hostname.","example":"mail.example.com","format":"domain","type":"string"},"smtp_insecure_port":{"description":"The account's insecure outbound SMTP port.","example":25,"maximum":65535,"minimum":1,"type":"integer"},"smtp_port":{"description":"The account's secure outbound SMTP port.","example":465,"maximum":65535,"minimum":1,"type":"integer"},"smtp_username":{"description":"The account's SMTP username.","example":"username@example.com","format":"email","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return email account's client settings","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  get_client_settings\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/get_client_settings"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_get_client_settings.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_get_client_settings.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/get_client_settings/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_get_client_settings.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_get_client_settings.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'get_client_settings'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 62"}},"/Email/get_default_email_quota":{"get":{"description":"This function retrieves the account's default email quota size, in bytes format.\n\n**Important:**\n\nWhen you disable the [Receive Mail](https://go.cpanel.net/serverroles) role, the system **disables** this function.","operationId":"get_default_email_quota","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_default_email_quota","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"The default email quota in bytes.\n\nThe value will either be:\n* The system's default quota value (32 gigabytes).\n* The account's quota value, if it is less than the system's default value.","example":34359738368,"minimum":0,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return email account's default email quota","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  get_default_email_quota\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/get_default_email_quota"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_get_default_email_quota.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_get_default_email_quota.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/get_default_email_quota/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_get_default_email_quota.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_get_default_email_quota.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'get_default_email_quota'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.48"}},"/Email/get_disk_usage":{"get":{"description":"This function retrieves the disk space that an email account uses.\n\n**Important:**\n\nWhen you disable the [Receive Mail role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"get_disk_usage","parameters":[{"description":"The email account username.","in":"query","name":"user","required":true,"schema":{"example":"user","format":"username","type":"string"}},{"description":"The email account's domain.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_disk_usage","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"properties":{"diskused":{"description":"The disk space that the email account uses.\n* A positive floating-point value that represents the disk space, used in megabytes (MB).\n* `0` - The account posesses an unlimited disk quota.","example":399.6,"type":"number"},"domain":{"description":"The email account's domain.","example":"example.com","format":"domain","type":"string"},"login":{"description":"The email address or the main account username.","example":"user@example.com","format":"email","type":"string"},"user":{"description":"The email account's username.","example":"user","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return email account's disk usage","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  get_disk_usage \\\n  user='user' \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/get_disk_usage?user=user&domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_get_disk_usage.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_get_disk_usage.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/get_disk_usage/,\n    {\n        'user' => 'user',\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_get_disk_usage.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_get_disk_usage.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'get_disk_usage',\n    array (\n        'user' => 'user',\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/get_filter":{"get":{"description":"This function retrieves an email filter's information.\n\n**Important:**\n\nWhen you disable the [Receive Mail](https://go.cpanel.net/serverroles) role, the system **disables** this function.","operationId":"get_filter","parameters":[{"description":"The email address that owns the filter.","in":"query","name":"account","required":true,"schema":{"example":"user@example.com","format":"email","type":"string"}},{"description":"The filter's name.","in":"query","name":"filtername","required":true,"schema":{"example":"coffee","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_filter","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"properties":{"actions":{"description":"An array of objects that contains the filter's actions.","items":{"properties":{"action":{"description":"The filter's action.\n* `deliver` -  The filter sends mail to the destination address.\n* `fail` -  The filter forces a delivery failure.\n* `finish` -  The filter stops message processing.\n* `save` -  The filter saves mail to the destination file.\n* `pipe` -  The filter sends mail to the destination application.","enum":["deliver","fail","finish","save","pipe"],"type":"string"},"dest":{"description":"The destination to which the filter sends mail.\n\nA destination can be one of the following.\n* A file path.\n* An application path.\n* A valid email address.","oneOf":[{"example":"/dev/null","format":"path","type":"string"},{"example":"example@test.com","format":"email","type":"string"}]},"number":{"description":"The filter's position in the order of the account's filters.","example":1,"minimum":1,"type":"integer"}},"type":"object"},"type":"array"},"filtername":{"description":"The filter's name.","example":"coffee","type":"string"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}},"type":"object"},"rules":{"description":"An array of objects that contains the filter's rules.","items":{"properties":{"match":{"description":"The filter's match type.\n\n* `is`\n* `matches`\n* `contains`\n* `does not contain`\n* `begins`\n* `does not begin`\n* `ends`\n* `does not end`\n* `does not match`\n* `is above`\n* `is not above`\n* `is below`\n* `is not below`","enum":["is","matches","contains","does not contain","begins","does not begin","ends","does not end","does not match","is above","is not above","is below","is not below"],"example":"contains","type":"string"},"number":{"description":"The filter's position in the order of the account's filters.","example":1,"minimum":1,"type":"integer"},"opt":{"description":"The connection between multiple conditions.\n* `and` -  Match both conditions.\n* `or` -  Match either condition.\n* `null` -  There is only one condition.","enum":["and","or","null"],"example":"or","type":"string"},"part":{"description":"The queried email section.\n* `$header_from:` -  Matches against the From: section.\n* `$header_subject:` -  Matches against the Subject: section.\n* `$header_to:` -  Matches against the To: section.\n* `$reply_address:` -  Matches against the Reply To: section.\n* `$message_body` -  Matches against the message's body.\n* `$message_headers` -  Matches against the message's headers.\n* `foranyaddress $h_to:,$h_cc:,$h_bcc:` -  Matches against all message recipients.\n* `not delivered` -  Matches if the message is not queued for delivery.\n* `error_message` -  Matches if the incoming message bounced.","enum":["$header_from:","$header_subject:","$header_to:","$reply_address:","$message_body","$message_headers","foranyaddress $h_to:,$h_cc:,$h_bcc:","not delivered","error_message"],"example":"$message_body","type":"string"},"val":{"description":"The matched value.","example":"coconut","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return email filter's information","tags":["Email","Email Filtering"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  get_filter \\\n  account='user@example.com' \\\n  filtername='coffee'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/get_filter?account=user%40example.com&filtername=coffee"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_get_filter.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_get_filter.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/get_filter/,\n    {\n        'account' => 'user@example.com',\n        'filtername' => 'coffee',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_get_filter.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_get_filter.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'get_filter',\n    array (\n        'account' => 'user@example.com',\n        'filtername' => 'coffee',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/get_default_email_quota_mib":{"get":{"description":"This function retrieves the account's default email quota size in [mebibytes](https://en.wikipedia.org/wiki/Mebibyte) (MiB).\n\n**Important:**\n\nWhen you disable the [Receive Mail](https://go.cpanel.net/serverroles) role, the system **disables** this function.","operationId":"get_default_email_quota_mib","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_default_email_quota_mib","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"The default email quota in [mebibytes](https://en.wikipedia.org/wiki/Mebibyte) (MiB).\n\nThe value will either be:\n* The system's default quota value (32 gigabytes).\n* The account's quota value, if it is less than the system's default value.","example":32768,"maximum":4294967296,"minimum":0,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return email account's default email quota in MiB","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  get_default_email_quota_mib\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/get_default_email_quota_mib"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_get_default_email_quota_mib.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_get_default_email_quota_mib.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/get_default_email_quota_mib/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_get_default_email_quota_mib.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_get_default_email_quota_mib.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'get_default_email_quota_mib'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.48"}},"/Email/get_lists_total_disk_usage":{"get":{"description":"This function returns the total disk usage for the [mailing lists](https://go.cpanel.net/cpaneldocsMailingLists) of a cPanel account.\n\n**Important:**\n\nWhen you disable the [Receive Mail role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"get_lists_total_disk_usage","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_lists_total_disk_usage","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"The total disk usage for the [mailing lists](https://go.cpanel.net/MailingLists) of a cPanel account, in bytes.","example":1024,"minimum":0,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel account's mailing list disk usage","tags":["Email","Mailing Lists"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  get_lists_total_disk_usage\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/get_lists_total_disk_usage"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_get_lists_total_disk_usage.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_get_lists_total_disk_usage.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/get_lists_total_disk_usage/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_get_lists_total_disk_usage.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_get_lists_total_disk_usage.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'get_lists_total_disk_usage'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/Email/get_mailbox_autocreate":{"get":{"description":"This function checks whether a cPanel account will automatically create mailboxes when it receives an email address in [plus address format](https://en.wikipedia.org/wiki/Email_address#Sub-addressing).\n\n**Note:**\n\nTo enable or disable this functionality, use the UAPI's `Email::enable_mailbox_autocreate` and `Email::disable_mailbox_autocreate` functions.","operationId":"get_mailbox_autocreate","parameters":[{"description":"The email account address to query.","in":"query","name":"email","required":true,"schema":{"example":"username@example.com","format":"email","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_mailbox_autocreate","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"Whether the cPanel account can automatically create mailboxes.\n* `1` — The cPanel account can automatically create mailboxes.\n* `0` — The cPanel account **cannot** automatically create mailboxes.","enum":[0,1],"example":1,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel account's mailbox autocreate status","tags":["Email","Email Server Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  get_mailbox_autocreate \\\n  email='username@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/get_mailbox_autocreate?email=username%40example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_get_mailbox_autocreate.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_get_mailbox_autocreate.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/get_mailbox_autocreate/,\n    {\n        'email' => 'username@example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_get_mailbox_autocreate.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_get_mailbox_autocreate.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'get_mailbox_autocreate',\n    array (\n        'email' => 'username@example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 78"}},"/Email/get_mailman_delegates":{"get":{"description":"This function lists a mailing list's administrators.\n\n**Important:**\n\nWhen you disable the [Receive Mail](https://go.cpanel.net/serverroles) role, the system **disables** this function.","operationId":"get_mailman_delegates","parameters":[{"description":"The name of a Mailman mailing list on the cPanel account.","in":"query","name":"list","required":true,"schema":{"example":"mylist","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_mailman_delegates","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"properties":{"delegates":{"description":"An array of the mailing list's administrators.","items":{"example":"secondadmin@example.com","format":"email","type":"string"},"type":"array"},"metadata":{"properties":{"transformed":{}},"type":"object"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return mailing list administrators","tags":["Email","Mailing Lists"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  get_mailman_delegates \\\n  list='mylist'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/get_mailman_delegates?list=mylist"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_get_mailman_delegates.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_get_mailman_delegates.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/get_mailman_delegates/,\n    {\n        'list' => 'mylist',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_get_mailman_delegates.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_get_mailman_delegates.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'get_mailman_delegates',\n    array (\n        'list' => 'mylist',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/get_main_account_disk_usage":{"get":{"description":"This function returns the disk space that the main account uses.\n\n**Important:**\n\nWhen you disable the [Receive Mail role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"get_main_account_disk_usage","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_main_account_disk_usage","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"The current amount of disk space that the main email account uses.","example":"3076 bytes","type":"string"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return primary email account's disk usage","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  get_main_account_disk_usage\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/get_main_account_disk_usage"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_get_main_account_disk_usage.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_get_main_account_disk_usage.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/get_main_account_disk_usage/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_get_main_account_disk_usage.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_get_main_account_disk_usage.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'get_main_account_disk_usage'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/get_held_message_count":{"get":{"description":"This function returns the count of outbound email messages held in the mail queue for the specified email account.\n\n**Important:**\n\nWhen you disable the [Receive Mail role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"get_held_message_count","parameters":[{"description":"The email address to query.","in":"query","name":"email","required":false,"schema":{"example":"username@example.com","format":"email","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_held_message_count","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"The number of messages currently held in the mail queue.","example":0,"minimum":0,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return email account's outgoing message count","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  get_held_message_count\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/get_held_message_count"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_get_held_message_count.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_get_held_message_count.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/get_held_message_count/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_get_held_message_count.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_get_held_message_count.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'get_held_message_count'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 74"}},"/Email/get_main_account_disk_usage_bytes":{"get":{"description":"This function returns the disk space that the cPanel account uses.\n\n**Important:**\n\nWhen you disable the [Receive Mail](https://go.cpanel.net/serverroles) role, the system **disables** this function.","operationId":"get_main_account_disk_usage_bytes","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_main_account_disk_usage_bytes","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"The current amount of disk space that the main email account uses, in bytes.","example":3076,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return primary email account's disk usage in bytes","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  get_main_account_disk_usage_bytes\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/get_main_account_disk_usage_bytes"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_get_main_account_disk_usage_bytes.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_get_main_account_disk_usage_bytes.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/get_main_account_disk_usage_bytes/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_get_main_account_disk_usage_bytes.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_get_main_account_disk_usage_bytes.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'get_main_account_disk_usage_bytes'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 64"}},"/Email/get_max_email_quota":{"get":{"description":"This function retrieves the account's maximum email quota size, in bytes format.\n\n**Important:**\n\n  When you disable the [Receive Mail](https://go.cpanel.net/serverroles) role, the system **disables** this function.","operationId":"get_max_email_quota","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_max_email_quota","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"The account's maximum email quota, in bytes format. The function will\nreturn one of the following values:\n\n* The system's default maximum quota (4 [Pebibytes](https://en.wikipedia.org/wiki/Pebibyte)).\n* The account's quota value, if it is **less** than the default\nsystem quota value.","example":4503599627370496,"maximum":4503599627370496,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return email account's max quota size","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  get_max_email_quota\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/get_max_email_quota"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_get_max_email_quota.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_get_max_email_quota.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/get_max_email_quota/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_get_max_email_quota.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_get_max_email_quota.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'get_max_email_quota'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.48"}},"/Email/get_max_email_quota_mib":{"get":{"description":"This function retrieves the account's maximum email account quota size, in\n[Mebibytes (MiB)](https://en.wikipedia.org/wiki/Mebibyte) format.\n\n**Important:**\n\nWhen you disable the [Receive Mail role](https://go.cpanel.net/howtouseserverprofiles#roles),\nthe system **disables** this function.","operationId":"get_max_email_quota_mib","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_max_email_quota_mib","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"The account's maximum email account quota size, in Mebibytes (MiB).","example":4294967296,"maximum":4294967296,"minimum":0,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return email account's max quota size in MiB","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  get_max_email_quota_mib\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/get_max_email_quota_mib"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_get_max_email_quota_mib.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_get_max_email_quota_mib.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/get_max_email_quota_mib/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_get_max_email_quota_mib.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_get_max_email_quota_mib.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'get_max_email_quota_mib'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.48"}},"/Email/get_pop_quota":{"get":{"description":"This function retrieves an email account's quota.\n\n**Important:**\n\nWhen you disable the [Receive Mail](https://go.cpanel.net/serverroles) role, the system **disables** this function.","operationId":"get_pop_quota","parameters":[{"description":"The email account username.  For example, user if the email address is user@example.com.","in":"query","name":"email","required":true,"schema":{"example":"user","type":"string"}},{"description":"The email account's domain. This parameter defaults to the cPanel account's main domain.","in":"query","name":"domain","required":false,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"Whether to return the quota as bytes.\n\n* `1` — Return the quota as bytes.\n* `0` — Return the quota as megabytes (MB).","in":"query","name":"as_bytes","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_pop_quota","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"The email account's quota.\n\n**Note:**\n\nThis value's unit of measure depends on the `as_bytes` input parameter's value.","example":262144000,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return email account's quota","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  get_pop_quota \\\n  email='user'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/get_pop_quota?email=user"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_get_pop_quota.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_get_pop_quota.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/get_pop_quota/,\n    {\n        'email' => 'user',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_get_pop_quota.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_get_pop_quota.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'get_pop_quota',\n    array (\n        'email' => 'user',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/get_spam_settings":{"get":{"description":"This function retrieves the Apache SpamAssassin™ settings for the account.\n\n**Important:**\n\nWhen you disable the [SpamFilter role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"get_spam_settings","parameters":[{"description":"Retrieve a specific user account's SpamAssassin settings.\n\n**Note:**\n\nIf you do **not** specify this parameter, the function returns the settings for [the default email account](https://go.cpanel.net/DefaultAddress).","in":"query","name":"account","required":false,"schema":{"example":"username@example.com","format":"email","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_spam_settings","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"properties":{"cpuser_spam_auto_delete":{"description":"The cPanel user's account-wide spam filter setting\n\n* `1` - Enabled.\n* `0` - Not enabled.\n\n**NOTE:**\n\nThis key **only** appears if the `account` parameter is passed **and** the account does **not** have a custom setting","enum":[0,1],"example":1,"nullable":true,"type":"integer"},"cpuser_spam_auto_delete_score":{"description":"The cPanel user's account-wide spam filter threshold score. For more information, see `Email::add_spam_filter`.\n\n**NOTE:**\n\nThis key **only** appears if the `account` parameter is passed **and** the account does **not** have a custom setting","example":8,"minimum":0,"nullable":true,"type":"integer"},"rewrites_subjects":{"description":"Whether the user's spam filter rewrites the subject lines of spam messages.\n\n* `1` -  Rewrite.\n* `0` -  No rewrites.","enum":[0,1],"example":1,"type":"integer"},"spam_as_acl":{"description":"Whether the user's spam filter uses Apache SpamAssassin as an ACL.\n\n**NOTE:**\n\nThe value of this parameter is **always** `1`\n* `1` -  SpamAssassin is an ACL.","enum":[1],"example":1,"type":"integer"},"spam_auto_delete":{"description":"Whether the user's autodelete function is enabled.\n\n* `1` -  Enabled.\n* `0` -  Not enabled.\n\n**NOTE::**\n\nThis key does **not** appear if the `cpuser_spam_auto_delete` key appears","enum":[0,1],"example":0,"nullable":true,"type":"integer"},"spam_auto_delete_score":{"description":"Displays the user's spam filter threshold.  For more information, see `Email::add_spam_filter`.\n\n**Note:**\n\nThis key does **not** appear if the `cpuser_spam_auto_delete_score` key appears","example":8,"minimum":0,"nullable":true,"type":"integer"},"spam_box_enabled":{"description":"Whether the user's spam box is enabled.\n\n* `1` -  Enabled.\n* `0` -  Not enabled.","enum":[0,1],"example":0,"type":"integer"},"spam_enabled":{"description":"Whether the server's global spam filtering is enabled.\n\n* `1` -  Enabled.\n* `0` -  Not enabled.\n\n**Note:**\n\n This value will **only** return `0` if the cPanel user disables Apache SpamAssassin.","enum":[0,1],"example":1,"type":"integer"},"spam_status_changeable":{"description":"Whether the server allows cPanel users to configure Apache SpamAssassin settings.\n\n* `1` -  Allowed.\n* `0` -  Not allowed.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return email account Apache SpamAssassin settings","tags":["Email","Spam Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  get_spam_settings\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/get_spam_settings"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_get_spam_settings.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_get_spam_settings.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/get_spam_settings/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_get_spam_settings.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_get_spam_settings.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'get_spam_settings'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/get_webmail_settings":{"get":{"description":"This function retrieves an email account's Webmail settings.\n\n**Important:**\n\nWhen you disable the [_Receive Mail_ role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"get_webmail_settings","parameters":[{"description":"The email account.\n\n**Note:**\n\nIf you do **not** specify a value, the function retrieves settings for the cPanel account's default mail account.","in":"query","name":"account","required":false,"schema":{"oneOf":[{"example":"user@example.com","format":"email","type":"string"},{"example":"user","format":"username","type":"string"}]}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_webmail_settings","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"properties":{"domain":{"description":"The email account's mail server hostname.","example":"mail.example.com","format":"domain","type":"string"},"has_maildir":{"description":"Whether `Maildir` is enabled for the email account.\n\n* `1` — Enabled.\n\nIt is not possible to disable `Maildir`.","enum":[1],"example":1,"type":"integer"},"user":{"description":"The email account.","oneOf":[{"example":"user@example.com","format":"email","type":"string"},{"example":"user","format":"username","type":"string"}]}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return email account's Webmail settings","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  get_webmail_settings\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/get_webmail_settings"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_get_webmail_settings.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_get_webmail_settings.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/get_webmail_settings/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_get_webmail_settings.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_get_webmail_settings.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'get_webmail_settings'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/has_plaintext_authentication":{"get":{"description":"This function checks whether plaintext authentication is enabled on the Dovecot mail server.\n\n**Important:**\n\n  When you disable the [Receive Mail role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"has_plaintext_authentication","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"has_plaintext_authentication","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"Whether plaintext authentication is enabled on the Dovecot mail server.\n* `1` - Enabled.\n* `0` - Disabled.","enum":[0,1],"example":1,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return whether plaintext authentication is enabled","tags":["Email","Email Server Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  has_plaintext_authentication\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/has_plaintext_authentication"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_has_plaintext_authentication.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_has_plaintext_authentication.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/has_plaintext_authentication/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_has_plaintext_authentication.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_has_plaintext_authentication.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'has_plaintext_authentication'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 56"}},"/Email/passwd_list":{"get":{"description":"This function changes a mailing list's password.\n\n**Important:**\n\nWhen you disable the [_Receive Mail_](https://go.cpanel.net/serverroles) role, the system **disables** this function.","operationId":"passwd_list","parameters":[{"description":"The full name (including the domain) of a Mailman mailing list on the cPanel account.","in":"query","name":"list","required":true,"schema":{"example":"mylist@example.com","type":"string"}},{"description":"The new password.","in":"query","name":"password","required":true,"schema":{"example":"12345luggage","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"passwd_list","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update mailing list password","tags":["Email","Mailing Lists"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  passwd_list \\\n  list='mylist@example.com' \\\n  password='12345luggage'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/passwd_list?list=mylist%40example.com&password=12345luggage"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_passwd_list.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_passwd_list.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/passwd_list/,\n    {\n        'list' => 'mylist@example.com',\n        'password' => '12345luggage',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_passwd_list.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_passwd_list.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'passwd_list',\n    array (\n        'list' => 'mylist@example.com',\n        'password' => '12345luggage',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/has_delegated_mailman_lists":{"get":{"description":"This function checks an account's administrative privileges on mailing lists.\n\n**Important:**\n\nWhen you disable the [Receive Mail role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"has_delegated_mailman_lists","parameters":[{"description":"The email address.","in":"query","name":"delegate","required":true,"schema":{"example":"user@example.com","format":"email","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"has_delegated_mailman_lists","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"Whether the email address has administrative privileges on one or more mailing lists on the cPanel account.\n* `1` — The email address has administrative privileges.\n* `0` — The email address does **not** have administrative privileges.","enum":[0,1],"example":1,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return email account's mailing list privileges","tags":["Email","Mailing Lists"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  has_delegated_mailman_lists \\\n  delegate='user@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/has_delegated_mailman_lists?delegate=user%40example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_has_delegated_mailman_lists.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_has_delegated_mailman_lists.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/has_delegated_mailman_lists/,\n    {\n        'delegate' => 'user@example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_has_delegated_mailman_lists.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_has_delegated_mailman_lists.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'has_delegated_mailman_lists',\n    array (\n        'delegate' => 'user@example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/list_mxs":{"get":{"description":"This function lists Mail Exchanger (MX) records.\n\n**Important:**\n\n  When you disable the [*DNS* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"list_mxs","parameters":[{"description":"The domain to query. If you do **not** use this parameter, the function returns MX records for all of the cPanel account's domains.","in":"query","name":"domain","required":false,"schema":{"example":"example.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_mxs","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"alwaysaccept":{"description":"Whether the domain's highest-priority mail exchanger accepts local mail.\n* `1` - Accept local mail.\n* `0` - Does **not** accept local mail.","enum":[0,1],"example":1,"type":"integer"},"detected":{"description":"The domain's highest-priority mail exchanger's type.\n* `auto`\n* `local`\n* `remote`\n* `secondary`","enum":["auto","local","remote","secondary"],"example":"local","type":"string"},"domain":{"description":"The domain name.","example":"example.com","format":"domain","type":"string"},"entries":{"description":"An array of objects that contains information about mail exchangers.","items":{"properties":{"domain":{"description":"The mail exchanger's domain.","example":"example.com","format":"domain","type":"string"},"entrycount":{"description":"The mail exchanger's order in the list of priorities. For example, the mail exchanger with the highest priority returns `1`, and the next highest priority returns `2`.","example":1,"minimum":1,"type":"integer"},"mx":{"description":"The mail exchanger's name.","example":"mx.example.com","format":"domain","type":"string"},"priority":{"description":"The mail exchanger's [priority value](https://go.cpanel.net/whmdocsEditMXEntry).","example":5,"minimum":0,"type":"integer"},"row":{"description":"Whether the mail exchanger is an odd or an even entry.\n* `even`\n* `odd`","enum":["even","odd"],"example":"odd","type":"string"}},"type":"object"},"type":"array"},"local":{"description":"Whether the domain's highest priority mail exchanger is a local mail exchanger.\n* `1` - Local.\n* `0` - **Not** local.","enum":[0,1],"example":1,"type":"integer"},"mx":{"description":"The domain's highest-priority mail exchanger's name.","example":"mx.example.com","format":"domain","type":"string"},"mxcheck":{"description":"The domain's highest-priority mail exchanger's type.\n* `auto`\n* `local`\n* `remote`\n* `secondary`","enum":["auto","local","remote","secondary"],"example":"auto","type":"string"},"remote":{"description":"Whether the domain's highest-priority mail exchanger is remote.\n* `1` - Remote.\n* `0` - **Not** remote.","enum":[0,1],"example":0,"type":"integer"},"secondary":{"description":"Whether the domain's highest-priority mail exchanger is secondary.\n* `1` - Secondary.\n* `0` - **Not** secondary.","enum":[0,1],"example":0,"type":"integer"},"status":{"description":"Whether the function succeeded.\n* `1` - Success.\n* `0` - Failure.","enum":[0,1],"example":1,"type":"integer"},"statusmsg":{"description":"A success or error message message.\n* A success message.\n* An error message.","example":"Fetched MX List","type":"string"}},"type":"object"},"properties":{},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return mail exchanger records","tags":["Email DNS Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  list_mxs\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/list_mxs"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_list_mxs.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_list_mxs.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/list_mxs/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_list_mxs.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_list_mxs.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'list_mxs'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/list_auto_responders":{"get":{"description":"This function lists a domain's autoresponders.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"list_auto_responders","parameters":[{"description":"The domain name.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"A [Perl Compatible Regular Expression (PCRE)](https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions) that filters the results.","in":"query","name":"regex","required":false,"schema":{"example":"user","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_auto_responders","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"email":{"description":"The autoresponder's email address.","example":"user@example.com","format":"email","type":"string"},"subject":{"description":"The contents of the autoresponder message's `Subject:` field.","example":"Autoresponder Subject","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return domain's autoresponders","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  list_auto_responders \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/list_auto_responders?domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_list_auto_responders.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_list_auto_responders.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/list_auto_responders/,\n    {\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_list_auto_responders.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_list_auto_responders.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'list_auto_responders',\n    array (\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/list_default_address":{"get":{"description":"This function retrieves a domain's default address.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"list_default_address","parameters":[{"description":"The domain. If you do not specify a value, the function lists default addresses for all of the cPanel account's domains.","in":"query","name":"domain","required":false,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"The user whose default addresses to list.","in":"query","name":"user","required":true,"schema":{"example":"user","format":"username","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_default_address","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"An object of data for a domain.","items":{"properties":{"defaultaddress":{"description":"The domain's default address.\n* An email account username - The system forwards unroutable mail to this address.\n* `:fail:` - The system bounces unroutable mail back to the sender, and sends a failure message.\n* `:blackhole:` - The system deletes unroutable mail without a failure message.\n* The path to an application - The system pipes unroutable mail to this application.","example":"user","type":"string"},"domain":{"description":"The domain name.","example":"example.com","format":"domain","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return domain's default email address","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  list_default_address \\\n  user='user'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/list_default_address?user=user"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_list_default_address.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_list_default_address.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/list_default_address/,\n    {\n        'user' => 'user',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_list_default_address.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_list_default_address.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'list_default_address',\n    array (\n        'user' => 'user',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/list_domain_forwarders":{"get":{"description":"This function lists domain-level forwarders.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"list_domain_forwarders","parameters":[{"description":"The domain name to query. If you do not use this parameter, the function returns all domain-level forwarders on the cPanel account.","in":"query","name":"domain","required":false,"schema":{"example":"example.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_domain_forwarders","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"An array of objects containing domain forwarder information.","items":{"properties":{"dest":{"description":"The forwarded domain.","example":"example.com","format":"domain","type":"string"},"forward":{"description":"The destination domain.","example":"forwardtome.com","format":"domain","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return domain-level forwarders","tags":["Email","Email Forwarding"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  list_domain_forwarders\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/list_domain_forwarders"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_list_domain_forwarders.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_list_domain_forwarders.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/list_domain_forwarders/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_list_domain_forwarders.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_list_domain_forwarders.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'list_domain_forwarders'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/list_filters":{"get":{"description":"This function lists account-level mail filters. For more information about Exim filters, read [Exim’s documentation](http://www.exim.org/exim-html-3.30/doc/html/filter.html).\n\n**Important**:\n\n  When you disable the [Mail Receive role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"list_filters","parameters":[{"description":"The email address or cPanel account username for which to return a list of filters. If you do not specify this value, the function lists all of the cPanel account’s account-level filters.","in":"query","name":"account","required":false,"schema":{"oneOf":[{"example":"user@example.com","format":"email","type":"string"},{"example":"username","format":"username","type":"string"}]}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_filters","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"actions":{"description":"An array of objects that descibe each of the filter’s actions.","items":{"properties":{"action":{"description":"The filter’s action.\n\nSome common ones include:\n\n* `deliver` — The filter sends mail to the dest address.\n* `fail` — The filter forces a delivery failure.\n* `finish` — The filter stops message processing.\n* `save` — The filter saves mail to the dest file.\n* `pipe` — The filter sends mail to the dest application.\n\nFor more information, read [Exim’s _Filter commands_ documentation](http://www.exim.org/exim-html-3.30/doc/html/filter_11.html).","type":"string"},"dest":{"description":"The destination to which the filter sends mail.\n* A file path.\n* An application path.\n* A valid email address.","example":"/dev/null","type":"string"}},"type":"object"},"type":"array"},"enabled":{"description":"Whether the filter is enabled.","type":"integer"},"filtername":{"description":"The filter’s name.","example":"coffee","type":"string"},"rules":{"description":"An array of objects that descibe each of the filter’s rules.","items":{"properties":{"match":{"description":"The filter’s match type.","enum":["is","matches","contains","does not contain","begins","does not begin","ends","does not end","does not match","is above","is not above","is below","is not below"],"example":"contains","type":"string"},"opt":{"description":"The connection between multiple conditions.\n  * `and` — Match both conditions.\n  * `or` — Match either condition.\n  * `null` — Only one condition exists.","enum":["and","or","null"],"example":"or","type":"string"},"part":{"description":"The queried email section.\n\nSome common ones include:\n\n* `$header_from:` — Matches against the `From:` section.\n* `$header_subject:` — Matches against the `Subject:` section.\n* `$header_to:` — Matches against the `To:` section.\n* `$reply_address:` — Matches against the `Reply To:` section.\n* `$message_body` — Matches against the message’s body.\n* `$message_headers` — Matches against the message’s headers.\n* `foranyaddress $h_to:,$h_cc:,$h_bcc:` —  Matches against all message recipients.\n* `not delivered` — Matches if the system has not queued the message for delivery.\n* `error_message` — Matches if the incoming message bounced.\n\nFor more options, read [Exim’s documentation](https://exim.org/exim-html-3.30/doc/html/filter.html).","example":"$message_body","type":"string"},"val":{"description":"The matched value. A string value.","example":"coconut","type":"string"}},"type":"object"},"type":"array"},"unescaped":{"deprecated":true,"type":"boolean"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return account-level email filters","tags":["Email","Email Filtering"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  list_filters\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/list_filters"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_list_filters.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_list_filters.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/list_filters/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_list_filters.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_list_filters.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'list_filters'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/list_filters_backups":{"get":{"description":"This function lists all of the cPanel account's domains that use domain-level filters.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"list_filters_backups","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_filters_backups","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"An array of objects that contains information about domains with domain-level filters.","items":{"properties":{"domain":{"description":"A domain with a domain-level filter.","example":"example.com","format":"domain","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return domains with domain-level email filters","tags":["Email","Email Filtering"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  list_filters_backups\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/list_filters_backups"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_list_filters_backups.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_list_filters_backups.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/list_filters_backups/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_list_filters_backups.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_list_filters_backups.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'list_filters_backups'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/list_forwarders":{"get":{"description":"This function lists a domain's forwarders.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"list_forwarders","parameters":[{"description":"The domain.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"A [Perl Compatible Regular Expression (PCRE)](https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions) that filters the results. If you do **not** use this parameter, the function returns results for all of the account's filters.","in":"query","name":"regex","required":false,"schema":{"example":"user","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_forwarders","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"dest":{"description":"The forwarded address.","example":"forwarded@example.com","format":"email","type":"string"},"forward":{"description":"The forwarded mail's destination.","example":"user@example.com","format":"email","type":"string"},"html_dest":{"description":"The forwarded address in an HTML-compatible format.","example":"forwarded@example.com","format":"email","type":"string"},"html_forward":{"description":"The forwarded mail's destination in an HTML-compatible format.","example":"user@example.com","format":"email","type":"string"},"uri_dest":{"description":"The forwarded address in a URI-encoded format.","example":"forwarded%40example.com","type":"string"},"uri_forward":{"description":"The forwarded mail's destination in a URI-encoded format.","example":"user%40example.com","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return domain's forwarders","tags":["Email","Email Forwarding"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  list_forwarders \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/list_forwarders?domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_list_forwarders.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_list_forwarders.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/list_forwarders/,\n    {\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_list_forwarders.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_list_forwarders.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'list_forwarders',\n    array (\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/list_lists":{"get":{"description":"This function lists the account's Mailman mailing lists.","operationId":"list_lists","parameters":[{"description":"A [Perl Compatible Regular Expression (PCRE)](https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions) that filters the results.","in":"query","name":"regex","required":false,"schema":{"example":"user","type":"string"}},{"description":"The domain to query. If you do **not** use this parameter, the function lists mailing lists for all of the cPanel account's domains.","in":"query","name":"domain","required":false,"schema":{"example":"example.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_lists","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"accesstype":{"description":"The level of access that users have to the mailing list.\n* `private` - The list has **all** of the following settings:\n  * The list has private archives.\n  * The administrator **must** approve subscriptions.\n  * The Mailman directory page does **not** display the list.\n* `public` - The list has **any** of the following settings:\n  * The list has public archives.\n  * Anyone can subscribe.\n  * The Mailman directory page displays the list.","enum":["private","public"],"example":"public","type":"string"},"advertised":{"description":"Whether the Mailman directory page displays the list.\n* `1` - The Mailman directory page displays the list.\n* `0` - The Mailman directory page does not display the list.","enum":[0,1],"example":1,"type":"integer"},"archive_private":{"description":"Whether the mailing list archive is `private`.\n* `1` - The mailing list archive is `private`.\n* `0` - The mailing list archive is `public`.","enum":[0,1],"example":0,"type":"integer"},"desthost":{"description":"The IP address or domain name that handles mail for the mailing list's domain.\n* A valid hostname.\n* An IPv4 address.\n\n**Note:**\n\n  If the function **cannot** resolve the IP address to a hostname, it will return the IP address.","example":"172.16.254.1","oneOf":[{"format":"domain","type":"string"},{"format":"ipv4","type":"string"}]},"diskused":{"description":"The disk space that the mailing list currently uses, measured in megabytes (MB).","example":20379,"minimum":0,"type":"integer"},"humandiskused":{"description":"The disk space that the mailing list uses, in human-readable format.","example":"19.9\\u00a0KB","type":"string"},"list":{"description":"The mailing list name and domain.","example":"list@example.com","format":"email","type":"string"},"listadmin":{"description":"The mailing list's administrators' email addresses. A comma-separated list of email addresses.","example":"admin@example.com,admin2@example.com","type":"string"},"listid":{"description":"The mailing list's name and domain. The mailing list name, an underscore (_), and the domain.","example":"list_example.com","type":"string"},"subscribe_policy":{"description":"The level of control that the mailing list administrator has over new subscribers.\n* `1` - Anyone can subscribe. The system sends a confirmation email.\n* `2` - The administrator **must** approve subscriptions. The system does **not** send a confirmation email.\n* `3` - The administrator **must** approve subscriptions. The system sends a confirmation email.","enum":[1,2,3],"example":1,"type":"integer"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel account's mailing lists","tags":["Email","Mailing Lists"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  list_lists\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/list_lists"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_list_lists.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_list_lists.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/list_lists/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_list_lists.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_list_lists.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'list_lists'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/list_mail_domains":{"get":{"description":"This function lists the account's mail domains.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles), the system **disables** this function.\n\n**Note:**\n\n  This function **always** returns the account's main domain first.","operationId":"list_mail_domains","parameters":[{"description":"The name of the domain that the function returns with the `select `output parameter. If you do **not** use this parameter, the function will **not** return the `select` parameter with any domains.","in":"query","name":"select","required":false,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"Whether to list `www.` addresses.\n* `1` — List `www.` addresses.\n* `0` — Do **not** list `www.` addresses.\nFor example, if you specify `1`, the function's output would include both `example.com` and `www.example.com`. If you specify `0`, the output would include **only** `example.com`.","in":"query","name":"add_www","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to list wildcard addresses.\n* `1` — List wildcard addresses.\n* `0` — Do **not** list wildcard addresses.\nFor example, if you specify `1`, the function's output would include both `example.com` and `*.example.com`. If you specify `0`, the output would include **only** `example.com`.","in":"query","name":"include_wildcard","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_mail_domains","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"domain":{"description":"The domain name.","example":"example.com","format":"domain","type":"string"},"select":{"default":1,"description":"The domain that you specified in the `select` input parameter. The function **only** returns this value if you included the `select` parameter when you called the function.\n\n**Note:**\n\n  Because this value **only** appears if you included the `select` input parameter, The value **always** defaults to `1`.","example":1,"type":"integer"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel account's mail domains","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  list_mail_domains\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/list_mail_domains"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_list_mail_domains.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_list_mail_domains.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/list_mail_domains/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_list_mail_domains.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_list_mail_domains.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'list_mail_domains'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/list_forwarders_backups":{"get":{"description":"This function lists the domains with domain-level forwarders.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"list_forwarders_backups","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_forwarders_backups","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"domain":{"description":"domain that uses a domain-level filter.","example":"example.com","format":"domain","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return domains with domain-level forwarders","tags":["Email","Email Forwarding"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  list_forwarders_backups\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/list_forwarders_backups"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_list_forwarders_backups.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_list_forwarders_backups.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/list_forwarders_backups/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_list_forwarders_backups.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_list_forwarders_backups.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'list_forwarders_backups'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/SSL/install_ssl":{"get":{"description":"This function installs an SSL certificate.\n\n**Note:**\n\nDue to their inherent complexities, SSL-related functions often present problems for third-party developers. For the additional steps required to successfully call this function, read our [Call UAPI's SSL::install_ssl Function in Custom Code](https://go.cpanel.net/tutorial-call-uapis-ssl-install-ssl-function-in-custom-code) documentation.\n\n**Important:**\n\nWhen you disable the *Calendars and Contacts*, *Receive Mail*, *Web Disk*, *Webmail*, and *Web Server* [roles](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"install_ssl","parameters":[{"description":"The domain name.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"The certificate to install.\n\n**Note:**\n\n* You **must** URI-encode this value.\n* You can use a Perl command to URI-encode your SSL certificate for this parameter.\nFor example, you can use the following string, where `CERT.FILE` is the SSL certificate file:\n\n  ```$(perl -MURI::Escape -ne 'print uri_escape($_);' CERT.FILE)```","in":"query","name":"cert","required":true,"schema":{"example":"-----BEGIN%20CERTIFICATE-----%0AMIIEEzCCAvugAwIBAgIJALF%2FjFpw6p1bMA0GCSqGSIb3DQEBBQUAMIGfMRYwFAYD%0AVQQDEw10ZXN0c2ltb24uY29tMRYwFAYDVQQLEw1Eb2N1bWVudGF0aW9uMQswCQYD%0AVQQGEwJVUzEoMCYGCSqGSIb3DQEJARYZbGF1cmVuY2Uuc2ltb25AY3BhbmVsLm5l%0AdDEUMBIGA1UEChMLY1BhbmVsIEluYy4xDjAMBgNVBAgTBVRleGFzMRAwDgYDVQQH%0AEwdIb3VzdG9uMB4XDTEzMDUxNzE2MTMwN1oXDTE0MDUxNzE2MTMwN1owgZ8xFjAU%0ABgNVBAMTDXRlc3RzaW1vbi5jb20xFjAUBgNVBAsTDURvY3VtZW50YXRpb24xCzAJ%0ABgNVBAYTAlVTMSgwJgYJKoZIhvcNAQkBFhlsYXVyZW5jZS5zaW1vbkBjcGFuZWwu%0AbmV0MRQwEgYDVQQKEwtjUGFuZWwgSW5jLjEOMAwGA1UECBMFVGV4YXMxEDAOBgNV%0ABAcTB0hvdXN0b24wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDRO0AP%0AN5XtjDqkEyJ6ctfYqUtt9yUXyRuCETFjW6opNLSmZSHeF6L2aZka646lhj02CFyl%0AkzsNSxysN66tY%2BWZcTmvgPisJdQFpFvjroJZgDjYRV0QqokKdRy%2F5BU0%2BtHXoYpj%0A9JOQlbvEWxiGR3R80sL1ma4AfSE6Gv8M%2FPULTadan51eHaikXqjOXdPJQKuWP3g9%0AFnIuf38WRYwzGrre88qsZrpsMrADX5dotHWgqAf7Tap6xfA4CUAgQo9tldariuVi%0ABz%2BsRJ%2FSjgxnhw1HYWGttBuBZFhMpdHpPnTJ7DIFMd%2FFN5gG%2Ftah30SapWpo35Ux%0A3BpJcdUjtazy82K5AgMBAAGjUDBOMB0GA1UdDgQWBBQAlv7%2FtALOYb7zAXbYG2%2B9%0AAMI3xjAfBgNVHSMEGDAWgBQAlv7%2FtALOYb7zAXbYG2%2B9AMI3xjAMBgNVHRMEBTAD%0AAQH%2FMA0GCSqGSIb3DQEBBQUAA4IBAQCxzpe71Hc7Es0dqIN7bhIFYIIgcr6wxM6a%0Aa9d%2BQG%2BQPH0x0KAqV8EgUbZysvyxEF0bPxW3ZAr1Is1wk80PMuU3bToFFVbFFIIr%0AHRNfKLGvxiMXnZA1c6L4N0lowvXHgZxTTUXtDFLXyrcwrLsvUErEV7rbizuxqfPw%0AcaRtXn4uc%2Bt6HYuW7yWesBauCWnJNiKbjN%2FF%2BuCTurN3QMAeWf3ZJtsfkAgk8dyq%0AR%2F83a3kDtSPrpt%2BjX%2BqdjKEpRtQ5Qpm6XT2gCOQPgnfiUtOCH419pp922P%2FAAGc%2B%0AZUhYoWcRWKw%2Fy6gI7Ru%2B%2B9%2B8%2BwkadL9EbKMZxhVwD5qVm4ZlWK2a%5Cr%5Cn%0A-----END%20CERTIFICATE-----","format":"pem-certificate","type":"string"}},{"description":"The certificate's key.\n\n**Note:**\n\n* You **must** URI-encode this value.\n* You can use a Perl command to URI-encode your SSL certificate for this parameter.\nFor example, you can use the following string, where `KEY.FILE` is the SSL certificate file:\n\n  ```$(perl -MURI::Escape -ne 'print uri_escape($_);' KEY.FILE)```","in":"query","name":"key","required":true,"schema":{"example":"-----BEGIN%20RSA%20PRIVATE%20KEY-----%0AMIIEpAIBAAKCAQEA4AVM6J4Qg3DIFWr%2FeJ5GRmIATYsJIepKbrDy70sq%2BudcO8R8%0Axxak0oMZ%2F9mUdpjSNK%2FfLVTuCO0kxTfQ9VUWJllX7ThD6Zh9ZvlC%2Fnf%2FOEZLm3Zb%0ABgu8rbC8E9wuDOkKbJLnINgdhtowIydLK2MJ%2B%2Bq62bFV89jkHWTMcKyyqHENo3h%0Ac%2Blkpd9vnp8rZTinaVb7nX26uQqAFZYRo%2BWU0G%2FNPsq40QVSMoqPxyEz4qXo0hvu%0AIlCXmzFZq%2F6fCVPEKPLhQgMmpdBkMz4dVOazREfqXdjMD2%2BQXSNiA1AwWr8l0r4r%0AtzlxEYDJIR41yXp0xMl3KoolxMyvLBqZy32niQIDAQABAoIBAQCmbGmhWmPsMeoC%0At1WJFxQgD4goE0U6k%2BKt7vjbOt14Pk6v%2FB2yjaju1wSGpO59WLS4%2FXrwI2se6IXr%0Amba7u3VUEgWXLriNHoLy7%2FSMNTs%2BZEKhAMG36eNe3tVdT7busTag31r6sEMGGwCs%0AIwpU%2Bazosk0oylWLEX%2Fm%2FuHWEs1eaIEWWWtgHB%2BKZrrP7Rr9RYfVQ144DxmOxS3C%0Aa9%2BmST62WqAVPR6POWGEfZqnZl%2FePWZPcQYbFrhwnnefNoYBl%2FbnLZBo8rbNWxAq%0AOEOuKfkrBzglKG%2F39WKPw8rj4JIVzY0yOuFCW6xCDWRkOrhU8Ol%2F3FvwDa3uJpkp%0AmgPr4TgxAoGBAPGPLmxSuOYR97mDAXxrs037F2GCbqWvI6m7%2FezWe9yn%2BbMpjSIW%0Afsgtq4FsyqzPueEkDdQWi3xh6nu2WI%2F1Tl875opGAqEIJMqss%2Fu11tnva5wzu1cC%0AL6H85A5%2BHMOBvP3sm6CObKcVw92h7kxynVIUJJWhjfeZMN8gBFFpKIVFAoGBAO1p%0AtXBmXLC%2FYKKvtHI3M16%2FZopvM8ZqU2HcAHaw214Refw9JJ%2Fe3%2FxTNfSerVTyCAQO%0A1AdWTzJKBN8jmSYv1Mk1D3RpQPNR7wVzi46KR081AU41uMpqIGVOwHtyVnW%2FZfLr%0Ac1DLIK8Cx8aHfoxffwzoMO5SEQSooeZfOLhsfDN1AoGBAKQTUEINsj%2B75psgbAr6%0AELGgItJ9yPBLVRr%2BcUzEpx9LDWVvjMihpP4NX1gq8EOPWT%2BewLHVmmsjCyV6xw8J%0AXXF8e2xif3in0m3D%2FwCzE7u2T06rKM3B017hKnrZmGoHnrqPU2osM4sOUpshWX6d%0Av1Q4EF1%2BfbK3YCW%2BVpCBsB9NAoGAQo%2BuhNLODee56iKkzpjXWCsFTq6ar3hD5F3P%0A63buKdNwhd2GlSPhXFbf%2B7M5GWW6BZk6rMvv7EOAVice2uvyFm8%2F4%2F1WbmF8R%2BT7%0ALX1rPLO5p%2Fm701QpvP11TabiwqRkqtSEQhSRF0AKTojSW%2FyyHCZFAawUhV%2FZ9EKi%0AHmKb97kCgYAyzmFc2it0HqnsOnRybop603nqMtWGTQO4cxa93HUDpYajuK2K3Dfr%0AxUj6lG3z%2FoKJGGE2JqgZ6LBAhNJtJWJu2ox3pKGE63QjLJnVwb8y1NFYpe%2FcrbLe%0APuBwIR0L7drXxfv7O5btY7h6QI2d1%2FUIAQPAWbxLoTM%2BndQ%2FuPEdfA%3D%3D%0A-----END%20RSA%20PRIVATE%20KEY-----","format":"pem-private-key","type":"string"}},{"description":"The Certificate Authority (CA) bundle data, if the certificate requires it.\n\n**Note:**\n\n* You **must** URI-encode this value.\n* You can use a Perl command to URI-encode your SSL certificate for this parameter.\nFor example, you can use the following string, where `CABUNDLE.FILE` is the SSL certificate file:\n\n  ```$(perl -MURI::Escape -ne 'print uri_escape($_);' CABUNDLE.FILE)```","in":"query","name":"cabundle","required":false,"schema":{"example":"-----BEGIN%20CERTIFICATE-----%0AMIIB%2BjCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD%0AVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv%0Ab3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV%0AUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU%0AcnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k%2B625h8cXyv%0ARLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz%2BiCWaEVh43KRuH6X4M%0AypqfpX%2F1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt%2F5%0A1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz%0AdcZfHeFhVYAA1IFLezEPI2PnPfMD%2BfQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl%0AIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4%2F5ODFlitppK%2BULdjG%2BBqXH%2F9Apy%0AbW1EDp3zdHSo1TRJ6V6e6bR64eVaH4QwnNOfpSXY%0A-----END%20CERTIFICATE-----","format":"pem-certificate","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"install_ssl","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"properties":{"action":{"description":"The action that the function used to install the certificate.","example":"update","type":"string"},"cert_id":{"description":"The certificate ID.","example":"example_com_bbe7e_16e2d_1369007999_1d87a0cdb540f5aae607b10e9a1a82fb","type":"string"},"domain":{"description":"The domain that the certificate covers.","example":"example.com","format":"domain","type":"string"},"extra_certificate_domains":{"description":"The domains that require extra certificates for mail and other services.","items":{"example":"ssl.example.com","format":"domain","type":"string"},"type":"array"},"html":{"description":"The results, in HTML format.","example":"The SSL certificate is now installed onto the domain \"example.com\" using the IP address \"192.168.0.1\".\nThe existing virtual host was updated with the new certificate. Apache is restarting in the background.","type":"string"},"ip":{"description":"The domain's IP address.","example":"192.168.0.1","oneOf":[{"format":"ipv4","type":"string"},{"format":"ipv6","type":"string"}]},"key_id":{"description":"The key ID.","example":"bbe7e_16e2d_df7539f280eb1ecf6c1096190e41ada7","type":"string"},"message":{"description":"The results, in text format.","example":"The SSL certificate is now installed onto the domain \"example.com\" using the IP address \"192.168.0.1\".\nThe existing virtual host was updated with the new certificate.\nApache is restarting in the background.","type":"string"},"statusmsg":{"description":"The results.","example":"The SSL certificate is now installed onto the domain \"example.com\" using the IP address \"192.168.0.1\".\nThe existing virtual host was updated with the new certificate.\nApache is restarting in the background.\nThe SSL certificate is now installed onto the domain \"example.com\" using the IP address \"192.168.0.1\".\nThe existing virtual host was updated with the new certificate.\nApache is restarting in the background","type":"string"},"user":{"description":"The domain's owner.","example":"example","format":"username","type":"string"},"warning_domains":{"description":"The domains that the certificate does not cover.","items":{"example":"warning.com","format":"domain","type":"string"},"type":"array"},"working_domains":{"description":"The domains that the certificate covers.","items":{"example":"example.com","format":"domain","type":"string"},"type":"array"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Install SSL certificate","tags":["SSL","SSL Certificate Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty --user=username SSL install_ssl domain='example.com' cert='-----BEGIN%20CERTIFICATE-----%0AMIIEEzCCAvugAwIBAgIJALF%2FjFpw6p1bMA0GCSqGSIb3DQEBBQUAMIGfMRYwFAYD%0AVQQDEw10ZXN0c2ltb24uY29tMRYwFAYDVQQLEw1Eb2N1bWVudGF0aW9uMQswCQYD%0AVQQGEwJVUzEoMCYGCSqGSIb3DQEJARYZbGF1cmVuY2Uuc2ltb25AY3BhbmVsLm5l%0AdDEUMBIGA1UEChMLY1BhbmVsIEluYy4xDjAMBgNVBAgTBVRleGFzMRAwDgYDVQQH%0AEwdIb3VzdG9uMB4XDTEzMDUxNzE2MTMwN1oXDTE0MDUxNzE2MTMwN1owgZ8xFjAU%0ABgNVBAMTDXRlc3RzaW1vbi5jb20xFjAUBgNVBAsTDURvY3VtZW50YXRpb24xCzAJ%0ABgNVBAYTAlVTMSgwJgYJKoZIhvcNAQkBFhlsYXVyZW5jZS5zaW1vbkBjcGFuZWwu%0AbmV0MRQwEgYDVQQKEwtjUGFuZWwgSW5jLjEOMAwGA1UECBMFVGV4YXMxEDAOBgNV%0ABAcTB0hvdXN0b24wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDRO0AP%0AN5XtjDqkEyJ6ctfYqUtt9yUXyRuCETFjW6opNLSmZSHeF6L2aZka646lhj02CFyl%0AkzsNSxysN66tY%2BWZcTmvgPisJdQFpFvjroJZgDjYRV0QqokKdRy%2F5BU0%2BtHXoYpj%0A9JOQlbvEWxiGR3R80sL1ma4AfSE6Gv8M%2FPULTadan51eHaikXqjOXdPJQKuWP3g9%0AFnIuf38WRYwzGrre88qsZrpsMrADX5dotHWgqAf7Tap6xfA4CUAgQo9tldariuVi%0ABz%2BsRJ%2FSjgxnhw1HYWGttBuBZFhMpdHpPnTJ7DIFMd%2FFN5gG%2Ftah30SapWpo35Ux%0A3BpJcdUjtazy82K5AgMBAAGjUDBOMB0GA1UdDgQWBBQAlv7%2FtALOYb7zAXbYG2%2B9%0AAMI3xjAfBgNVHSMEGDAWgBQAlv7%2FtALOYb7zAXbYG2%2B9AMI3xjAMBgNVHRMEBTAD%0AAQH%2FMA0GCSqGSIb3DQEBBQUAA4IBAQCxzpe71Hc7Es0dqIN7bhIFYIIgcr6wxM6a%0Aa9d%2BQG%2BQPH0x0KAqV8EgUbZysvyxEF0bPxW3ZAr1Is1wk80PMuU3bToFFVbFFIIr%0AHRNfKLGvxiMXnZA1c6L4N0lowvXHgZxTTUXtDFLXyrcwrLsvUErEV7rbizuxqfPw%0AcaRtXn4uc%2Bt6HYuW7yWesBauCWnJNiKbjN%2FF%2BuCTurN3QMAeWf3ZJtsfkAgk8dyq%0AR%2F83a3kDtSPrpt%2BjX%2BqdjKEpRtQ5Qpm6XT2gCOQPgnfiUtOCH419pp922P%2FAAGc%2B%0AZUhYoWcRWKw%2Fy6gI7Ru%2B%2B9%2B8%2BwkadL9EbKMZxhVwD5qVm4ZlWK2a%5Cr%5Cn%0A-----END%20CERTIFICATE-----' key='-----BEGIN%20RSA%20PRIVATE%20KEY-----%0AMIIEpAIBAAKCAQEA4AVM6J4Qg3DIFWr%2FeJ5GRmIATYsJIepKbrDy70sq%2BudcO8R8%0Axxak0oMZ%2F9mUdpjSNK%2FfLVTuCO0kxTfQ9VUWJllX7ThD6Zh9ZvlC%2Fnf%2FOEZLm3Zb%0ABgu8rbC8E9wuDOkKbJLnINgdhtowIydLK2MJ%2B%2Bq62bFV89jkHWTMcKyyqHENo3h%0Ac%2Blkpd9vnp8rZTinaVb7nX26uQqAFZYRo%2BWU0G%2FNPsq40QVSMoqPxyEz4qXo0hvu%0AIlCXmzFZq%2F6fCVPEKPLhQgMmpdBkMz4dVOazREfqXdjMD2%2BQXSNiA1AwWr8l0r4r%0AtzlxEYDJIR41yXp0xMl3KoolxMyvLBqZy32niQIDAQABAoIBAQCmbGmhWmPsMeoC%0At1WJFxQgD4goE0U6k%2BKt7vjbOt14Pk6v%2FB2yjaju1wSGpO59WLS4%2FXrwI2se6IXr%0Amba7u3VUEgWXLriNHoLy7%2FSMNTs%2BZEKhAMG36eNe3tVdT7busTag31r6sEMGGwCs%0AIwpU%2Bazosk0oylWLEX%2Fm%2FuHWEs1eaIEWWWtgHB%2BKZrrP7Rr9RYfVQ144DxmOxS3C%0Aa9%2BmST62WqAVPR6POWGEfZqnZl%2FePWZPcQYbFrhwnnefNoYBl%2FbnLZBo8rbNWxAq%0AOEOuKfkrBzglKG%2F39WKPw8rj4JIVzY0yOuFCW6xCDWRkOrhU8Ol%2F3FvwDa3uJpkp%0AmgPr4TgxAoGBAPGPLmxSuOYR97mDAXxrs037F2GCbqWvI6m7%2FezWe9yn%2BbMpjSIW%0Afsgtq4FsyqzPueEkDdQWi3xh6nu2WI%2F1Tl875opGAqEIJMqss%2Fu11tnva5wzu1cC%0AL6H85A5%2BHMOBvP3sm6CObKcVw92h7kxynVIUJJWhjfeZMN8gBFFpKIVFAoGBAO1p%0AtXBmXLC%2FYKKvtHI3M16%2FZopvM8ZqU2HcAHaw214Refw9JJ%2Fe3%2FxTNfSerVTyCAQO%0A1AdWTzJKBN8jmSYv1Mk1D3RpQPNR7wVzi46KR081AU41uMpqIGVOwHtyVnW%2FZfLr%0Ac1DLIK8Cx8aHfoxffwzoMO5SEQSooeZfOLhsfDN1AoGBAKQTUEINsj%2B75psgbAr6%0AELGgItJ9yPBLVRr%2BcUzEpx9LDWVvjMihpP4NX1gq8EOPWT%2BewLHVmmsjCyV6xw8J%0AXXF8e2xif3in0m3D%2FwCzE7u2T06rKM3B017hKnrZmGoHnrqPU2osM4sOUpshWX6d%0Av1Q4EF1%2BfbK3YCW%2BVpCBsB9NAoGAQo%2BuhNLODee56iKkzpjXWCsFTq6ar3hD5F3P%0A63buKdNwhd2GlSPhXFbf%2B7M5GWW6BZk6rMvv7EOAVice2uvyFm8%2F4%2F1WbmF8R%2BT7%0ALX1rPLO5p%2Fm701QpvP11TabiwqRkqtSEQhSRF0AKTojSW%2FyyHCZFAawUhV%2FZ9EKi%0AHmKb97kCgYAyzmFc2it0HqnsOnRybop603nqMtWGTQO4cxa93HUDpYajuK2K3Dfr%0AxUj6lG3z%2FoKJGGE2JqgZ6LBAhNJtJWJu2ox3pKGE63QjLJnVwb8y1NFYpe%2FcrbLe%0APuBwIR0L7drXxfv7O5btY7h6QI2d1%2FUIAQPAWbxLoTM%2BndQ%2FuPEdfA%3D%3D%0A-----END%20RSA%20PRIVATE%20KEY-----'"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/install_ssl?domain=example.com&cert=-----BEGIN%20CERTIFICATE-----%0aMIIEEzCCAvugAwIBAgIJALF%2fjFpw6p1bMA0GCSqGSIb3DQEBBQUAMIGfMRYwFAYD%0aVQQDEw10ZXN0c2ltb24uY29tMRYwFAYDVQQLEw1Eb2N1bWVudGF0aW9uMQswCQYD%0aVQQGEwJVUzEoMCYGCSqGSIb3DQEJARYZbGF1cmVuY2Uuc2ltb25AY3BhbmVsLm5l%0adDEUMBIGA1UEChMLY1BhbmVsIEluYy4xDjAMBgNVBAgTBVRleGFzMRAwDgYDVQQH%0aEwdIb3VzdG9uMB4XDTEzMDUxNzE2MTMwN1oXDTE0MDUxNzE2MTMwN1owgZ8xFjAU%0aBgNVBAMTDXRlc3RzaW1vbi5jb20xFjAUBgNVBAsTDURvY3VtZW50YXRpb24xCzAJ%0aBgNVBAYTAlVTMSgwJgYJKoZIhvcNAQkBFhlsYXVyZW5jZS5zaW1vbkBjcGFuZWwu%0abmV0MRQwEgYDVQQKEwtjUGFuZWwgSW5jLjEOMAwGA1UECBMFVGV4YXMxEDAOBgNV%0aBAcTB0hvdXN0b24wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDRO0AP%0aN5XtjDqkEyJ6ctfYqUtt9yUXyRuCETFjW6opNLSmZSHeF6L2aZka646lhj02CFyl%0akzsNSxysN66tY%2bWZcTmvgPisJdQFpFvjroJZgDjYRV0QqokKdRy%2f5BU0%2btHXoYpj%0a9JOQlbvEWxiGR3R80sL1ma4AfSE6Gv8M%2fPULTadan51eHaikXqjOXdPJQKuWP3g9%0aFnIuf38WRYwzGrre88qsZrpsMrADX5dotHWgqAf7Tap6xfA4CUAgQo9tldariuVi%0aBz%2bsRJ%2fSjgxnhw1HYWGttBuBZFhMpdHpPnTJ7DIFMd%2fFN5gG%2ftah30SapWpo35Ux%0a3BpJcdUjtazy82K5AgMBAAGjUDBOMB0GA1UdDgQWBBQAlv7%2ftALOYb7zAXbYG2%2b9%0aAMI3xjAfBgNVHSMEGDAWgBQAlv7%2ftALOYb7zAXbYG2%2b9AMI3xjAMBgNVHRMEBTAD%0aAQH%2fMA0GCSqGSIb3DQEBBQUAA4IBAQCxzpe71Hc7Es0dqIN7bhIFYIIgcr6wxM6a%0aa9d%2bQG%2bQPH0x0KAqV8EgUbZysvyxEF0bPxW3ZAr1Is1wk80PMuU3bToFFVbFFIIr%0aHRNfKLGvxiMXnZA1c6L4N0lowvXHgZxTTUXtDFLXyrcwrLsvUErEV7rbizuxqfPw%0acaRtXn4uc%2bt6HYuW7yWesBauCWnJNiKbjN%2fF%2buCTurN3QMAeWf3ZJtsfkAgk8dyq%0aR%2f83a3kDtSPrpt%2bjX%2bqdjKEpRtQ5Qpm6XT2gCOQPgnfiUtOCH419pp922P%2fAAGc%2b%0aZUhYoWcRWKw%2fy6gI7Ru%2b%2b9%2b8%2bwkadL9EbKMZxhVwD5qVm4ZlWK2a%5cr%5cn%0a-----END%20CERTIFICATE-----&key=-----BEGIN%20RSA%20PRIVATE%20KEY-----%0aMIIEpAIBAAKCAQEA4AVM6J4Qg3DIFWr%2feJ5GRmIATYsJIepKbrDy70sq%2budcO8R8%0axxak0oMZ%2f9mUdpjSNK%2ffLVTuCO0kxTfQ9VUWJllX7ThD6Zh9ZvlC%2fnf%2fOEZLm3Zb%0aBgu8rbC8E9wuDOkKbJLnINgdhtowIydLK2MJ%2b%2bq62bFV89jkHWTMcKyyqHENo3h%0ac%2blkpd9vnp8rZTinaVb7nX26uQqAFZYRo%2bWU0G%2fNPsq40QVSMoqPxyEz4qXo0hvu%0aIlCXmzFZq%2f6fCVPEKPLhQgMmpdBkMz4dVOazREfqXdjMD2%2bQXSNiA1AwWr8l0r4r%0atzlxEYDJIR41yXp0xMl3KoolxMyvLBqZy32niQIDAQABAoIBAQCmbGmhWmPsMeoC%0at1WJFxQgD4goE0U6k%2bKt7vjbOt14Pk6v%2fB2yjaju1wSGpO59WLS4%2fXrwI2se6IXr%0amba7u3VUEgWXLriNHoLy7%2fSMNTs%2bZEKhAMG36eNe3tVdT7busTag31r6sEMGGwCs%0aIwpU%2bazosk0oylWLEX%2fm%2fuHWEs1eaIEWWWtgHB%2bKZrrP7Rr9RYfVQ144DxmOxS3C%0aa9%2bmST62WqAVPR6POWGEfZqnZl%2fePWZPcQYbFrhwnnefNoYBl%2fbnLZBo8rbNWxAq%0aOEOuKfkrBzglKG%2f39WKPw8rj4JIVzY0yOuFCW6xCDWRkOrhU8Ol%2f3FvwDa3uJpkp%0amgPr4TgxAoGBAPGPLmxSuOYR97mDAXxrs037F2GCbqWvI6m7%2fezWe9yn%2bbMpjSIW%0afsgtq4FsyqzPueEkDdQWi3xh6nu2WI%2f1Tl875opGAqEIJMqss%2fu11tnva5wzu1cC%0aL6H85A5%2bHMOBvP3sm6CObKcVw92h7kxynVIUJJWhjfeZMN8gBFFpKIVFAoGBAO1p%0atXBmXLC%2fYKKvtHI3M16%2fZopvM8ZqU2HcAHaw214Refw9JJ%2fe3%2fxTNfSerVTyCAQO%0a1AdWTzJKBN8jmSYv1Mk1D3RpQPNR7wVzi46KR081AU41uMpqIGVOwHtyVnW%2fZfLr%0ac1DLIK8Cx8aHfoxffwzoMO5SEQSooeZfOLhsfDN1AoGBAKQTUEINsj%2b75psgbAr6%0aELGgItJ9yPBLVRr%2bcUzEpx9LDWVvjMihpP4NX1gq8EOPWT%2bewLHVmmsjCyV6xw8J%0aXXF8e2xif3in0m3D%2fwCzE7u2T06rKM3B017hKnrZmGoHnrqPU2osM4sOUpshWX6d%0av1Q4EF1%2bfbK3YCW%2bVpCBsB9NAoGAQo%2buhNLODee56iKkzpjXWCsFTq6ar3hD5F3P%0a63buKdNwhd2GlSPhXFbf%2b7M5GWW6BZk6rMvv7EOAVice2uvyFm8%2f4%2f1WbmF8R%2bT7%0aLX1rPLO5p%2fm701QpvP11TabiwqRkqtSEQhSRF0AKTojSW%2fyyHCZFAawUhV%2fZ9EKi%0aHmKb97kCgYAyzmFc2it0HqnsOnRybop603nqMtWGTQO4cxa93HUDpYajuK2K3Dfr%0axUj6lG3z%2foKJGGE2JqgZ6LBAhNJtJWJu2ox3pKGE63QjLJnVwb8y1NFYpe%2fcrbLe%0aPuBwIR0L7drXxfv7O5btY7h6QI2d1%2fUIAQPAWbxLoTM%2bndQ%2fuPEdfA%3d%3d%0a-----END%20RSA%20PRIVATE%20KEY-----"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_install_ssl.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_install_ssl.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/install_ssl/,\n    {\n        'domain' => 'example.com',\n        'cert' => '-----BEGIN CERTIFICATE-----\nMIIEEzCCAvugAwIBAgIJALF/jFpw6p1bMA0GCSqGSIb3DQEBBQUAMIGfMRYwFAYD\nVQQDEw10ZXN0c2ltb24uY29tMRYwFAYDVQQLEw1Eb2N1bWVudGF0aW9uMQswCQYD\nVQQGEwJVUzEoMCYGCSqGSIb3DQEJARYZbGF1cmVuY2Uuc2ltb25AY3BhbmVsLm5l\ndDEUMBIGA1UEChMLY1BhbmVsIEluYy4xDjAMBgNVBAgTBVRleGFzMRAwDgYDVQQH\nEwdIb3VzdG9uMB4XDTEzMDUxNzE2MTMwN1oXDTE0MDUxNzE2MTMwN1owgZ8xFjAU\nBgNVBAMTDXRlc3RzaW1vbi5jb20xFjAUBgNVBAsTDURvY3VtZW50YXRpb24xCzAJ\nBgNVBAYTAlVTMSgwJgYJKoZIhvcNAQkBFhlsYXVyZW5jZS5zaW1vbkBjcGFuZWwu\nbmV0MRQwEgYDVQQKEwtjUGFuZWwgSW5jLjEOMAwGA1UECBMFVGV4YXMxEDAOBgNV\nBAcTB0hvdXN0b24wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDRO0AP\nN5XtjDqkEyJ6ctfYqUtt9yUXyRuCETFjW6opNLSmZSHeF6L2aZka646lhj02CFyl\nkzsNSxysN66tY+WZcTmvgPisJdQFpFvjroJZgDjYRV0QqokKdRy/5BU0+tHXoYpj\n9JOQlbvEWxiGR3R80sL1ma4AfSE6Gv8M/PULTadan51eHaikXqjOXdPJQKuWP3g9\nFnIuf38WRYwzGrre88qsZrpsMrADX5dotHWgqAf7Tap6xfA4CUAgQo9tldariuVi\nBz+sRJ/Sjgxnhw1HYWGttBuBZFhMpdHpPnTJ7DIFMd/FN5gG/tah30SapWpo35Ux\n3BpJcdUjtazy82K5AgMBAAGjUDBOMB0GA1UdDgQWBBQAlv7/tALOYb7zAXbYG2+9\nAMI3xjAfBgNVHSMEGDAWgBQAlv7/tALOYb7zAXbYG2+9AMI3xjAMBgNVHRMEBTAD\nAQH/MA0GCSqGSIb3DQEBBQUAA4IBAQCxzpe71Hc7Es0dqIN7bhIFYIIgcr6wxM6a\na9d+QG+QPH0x0KAqV8EgUbZysvyxEF0bPxW3ZAr1Is1wk80PMuU3bToFFVbFFIIr\nHRNfKLGvxiMXnZA1c6L4N0lowvXHgZxTTUXtDFLXyrcwrLsvUErEV7rbizuxqfPw\ncaRtXn4uc+t6HYuW7yWesBauCWnJNiKbjN/F+uCTurN3QMAeWf3ZJtsfkAgk8dyq\nR/83a3kDtSPrpt+jX+qdjKEpRtQ5Qpm6XT2gCOQPgnfiUtOCH419pp922P/AAGc+\nZUhYoWcRWKw/y6gI7Ru++9+8+wkadL9EbKMZxhVwD5qVm4ZlWK2a\\r\\n\n-----END CERTIFICATE-----',\n        'key' => '-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEA4AVM6J4Qg3DIFWr/eJ5GRmIATYsJIepKbrDy70sq+udcO8R8\nxxak0oMZ/9mUdpjSNK/fLVTuCO0kxTfQ9VUWJllX7ThD6Zh9ZvlC/nf/OEZLm3Zb\nBgu8rbC8E9wuDOkKbJLnINgdhtowIydLK2MJ++q62bFV89jkHWTMcKyyqHENo3h\nc+lkpd9vnp8rZTinaVb7nX26uQqAFZYRo+WU0G/NPsq40QVSMoqPxyEz4qXo0hvu\nIlCXmzFZq/6fCVPEKPLhQgMmpdBkMz4dVOazREfqXdjMD2+QXSNiA1AwWr8l0r4r\ntzlxEYDJIR41yXp0xMl3KoolxMyvLBqZy32niQIDAQABAoIBAQCmbGmhWmPsMeoC\nt1WJFxQgD4goE0U6k+Kt7vjbOt14Pk6v/B2yjaju1wSGpO59WLS4/XrwI2se6IXr\nmba7u3VUEgWXLriNHoLy7/SMNTs+ZEKhAMG36eNe3tVdT7busTag31r6sEMGGwCs\nIwpU+azosk0oylWLEX/m/uHWEs1eaIEWWWtgHB+KZrrP7Rr9RYfVQ144DxmOxS3C\na9+mST62WqAVPR6POWGEfZqnZl/ePWZPcQYbFrhwnnefNoYBl/bnLZBo8rbNWxAq\nOEOuKfkrBzglKG/39WKPw8rj4JIVzY0yOuFCW6xCDWRkOrhU8Ol/3FvwDa3uJpkp\nmgPr4TgxAoGBAPGPLmxSuOYR97mDAXxrs037F2GCbqWvI6m7/ezWe9yn+bMpjSIW\nfsgtq4FsyqzPueEkDdQWi3xh6nu2WI/1Tl875opGAqEIJMqss/u11tnva5wzu1cC\nL6H85A5+HMOBvP3sm6CObKcVw92h7kxynVIUJJWhjfeZMN8gBFFpKIVFAoGBAO1p\ntXBmXLC/YKKvtHI3M16/ZopvM8ZqU2HcAHaw214Refw9JJ/e3/xTNfSerVTyCAQO\n1AdWTzJKBN8jmSYv1Mk1D3RpQPNR7wVzi46KR081AU41uMpqIGVOwHtyVnW/ZfLr\nc1DLIK8Cx8aHfoxffwzoMO5SEQSooeZfOLhsfDN1AoGBAKQTUEINsj+75psgbAr6\nELGgItJ9yPBLVRr+cUzEpx9LDWVvjMihpP4NX1gq8EOPWT+ewLHVmmsjCyV6xw8J\nXXF8e2xif3in0m3D/wCzE7u2T06rKM3B017hKnrZmGoHnrqPU2osM4sOUpshWX6d\nv1Q4EF1+fbK3YCW+VpCBsB9NAoGAQo+uhNLODee56iKkzpjXWCsFTq6ar3hD5F3P\n63buKdNwhd2GlSPhXFbf+7M5GWW6BZk6rMvv7EOAVice2uvyFm8/4/1WbmF8R+T7\nLX1rPLO5p/m701QpvP11TabiwqRkqtSEQhSRF0AKTojSW/yyHCZFAawUhV/Z9EKi\nHmKb97kCgYAyzmFc2it0HqnsOnRybop603nqMtWGTQO4cxa93HUDpYajuK2K3Dfr\nxUj6lG3z/oKJGGE2JqgZ6LBAhNJtJWJu2ox3pKGE63QjLJnVwb8y1NFYpe/crbLe\nPuBwIR0L7drXxfv7O5btY7h6QI2d1/UIAQPAWbxLoTM+ndQ/uPEdfA==\n-----END RSA PRIVATE KEY-----',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_install_ssl.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_install_ssl.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'install_ssl',\n    array (\n        'domain' => 'example.com',\n        'cert' => '-----BEGIN CERTIFICATE-----\nMIIEEzCCAvugAwIBAgIJALF/jFpw6p1bMA0GCSqGSIb3DQEBBQUAMIGfMRYwFAYD\nVQQDEw10ZXN0c2ltb24uY29tMRYwFAYDVQQLEw1Eb2N1bWVudGF0aW9uMQswCQYD\nVQQGEwJVUzEoMCYGCSqGSIb3DQEJARYZbGF1cmVuY2Uuc2ltb25AY3BhbmVsLm5l\ndDEUMBIGA1UEChMLY1BhbmVsIEluYy4xDjAMBgNVBAgTBVRleGFzMRAwDgYDVQQH\nEwdIb3VzdG9uMB4XDTEzMDUxNzE2MTMwN1oXDTE0MDUxNzE2MTMwN1owgZ8xFjAU\nBgNVBAMTDXRlc3RzaW1vbi5jb20xFjAUBgNVBAsTDURvY3VtZW50YXRpb24xCzAJ\nBgNVBAYTAlVTMSgwJgYJKoZIhvcNAQkBFhlsYXVyZW5jZS5zaW1vbkBjcGFuZWwu\nbmV0MRQwEgYDVQQKEwtjUGFuZWwgSW5jLjEOMAwGA1UECBMFVGV4YXMxEDAOBgNV\nBAcTB0hvdXN0b24wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDRO0AP\nN5XtjDqkEyJ6ctfYqUtt9yUXyRuCETFjW6opNLSmZSHeF6L2aZka646lhj02CFyl\nkzsNSxysN66tY+WZcTmvgPisJdQFpFvjroJZgDjYRV0QqokKdRy/5BU0+tHXoYpj\n9JOQlbvEWxiGR3R80sL1ma4AfSE6Gv8M/PULTadan51eHaikXqjOXdPJQKuWP3g9\nFnIuf38WRYwzGrre88qsZrpsMrADX5dotHWgqAf7Tap6xfA4CUAgQo9tldariuVi\nBz+sRJ/Sjgxnhw1HYWGttBuBZFhMpdHpPnTJ7DIFMd/FN5gG/tah30SapWpo35Ux\n3BpJcdUjtazy82K5AgMBAAGjUDBOMB0GA1UdDgQWBBQAlv7/tALOYb7zAXbYG2+9\nAMI3xjAfBgNVHSMEGDAWgBQAlv7/tALOYb7zAXbYG2+9AMI3xjAMBgNVHRMEBTAD\nAQH/MA0GCSqGSIb3DQEBBQUAA4IBAQCxzpe71Hc7Es0dqIN7bhIFYIIgcr6wxM6a\na9d+QG+QPH0x0KAqV8EgUbZysvyxEF0bPxW3ZAr1Is1wk80PMuU3bToFFVbFFIIr\nHRNfKLGvxiMXnZA1c6L4N0lowvXHgZxTTUXtDFLXyrcwrLsvUErEV7rbizuxqfPw\ncaRtXn4uc+t6HYuW7yWesBauCWnJNiKbjN/F+uCTurN3QMAeWf3ZJtsfkAgk8dyq\nR/83a3kDtSPrpt+jX+qdjKEpRtQ5Qpm6XT2gCOQPgnfiUtOCH419pp922P/AAGc+\nZUhYoWcRWKw/y6gI7Ru++9+8+wkadL9EbKMZxhVwD5qVm4ZlWK2a\\r\\n\n-----END CERTIFICATE-----',\n        'key' => '-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEA4AVM6J4Qg3DIFWr/eJ5GRmIATYsJIepKbrDy70sq+udcO8R8\nxxak0oMZ/9mUdpjSNK/fLVTuCO0kxTfQ9VUWJllX7ThD6Zh9ZvlC/nf/OEZLm3Zb\nBgu8rbC8E9wuDOkKbJLnINgdhtowIydLK2MJ++q62bFV89jkHWTMcKyyqHENo3h\nc+lkpd9vnp8rZTinaVb7nX26uQqAFZYRo+WU0G/NPsq40QVSMoqPxyEz4qXo0hvu\nIlCXmzFZq/6fCVPEKPLhQgMmpdBkMz4dVOazREfqXdjMD2+QXSNiA1AwWr8l0r4r\ntzlxEYDJIR41yXp0xMl3KoolxMyvLBqZy32niQIDAQABAoIBAQCmbGmhWmPsMeoC\nt1WJFxQgD4goE0U6k+Kt7vjbOt14Pk6v/B2yjaju1wSGpO59WLS4/XrwI2se6IXr\nmba7u3VUEgWXLriNHoLy7/SMNTs+ZEKhAMG36eNe3tVdT7busTag31r6sEMGGwCs\nIwpU+azosk0oylWLEX/m/uHWEs1eaIEWWWtgHB+KZrrP7Rr9RYfVQ144DxmOxS3C\na9+mST62WqAVPR6POWGEfZqnZl/ePWZPcQYbFrhwnnefNoYBl/bnLZBo8rbNWxAq\nOEOuKfkrBzglKG/39WKPw8rj4JIVzY0yOuFCW6xCDWRkOrhU8Ol/3FvwDa3uJpkp\nmgPr4TgxAoGBAPGPLmxSuOYR97mDAXxrs037F2GCbqWvI6m7/ezWe9yn+bMpjSIW\nfsgtq4FsyqzPueEkDdQWi3xh6nu2WI/1Tl875opGAqEIJMqss/u11tnva5wzu1cC\nL6H85A5+HMOBvP3sm6CObKcVw92h7kxynVIUJJWhjfeZMN8gBFFpKIVFAoGBAO1p\ntXBmXLC/YKKvtHI3M16/ZopvM8ZqU2HcAHaw214Refw9JJ/e3/xTNfSerVTyCAQO\n1AdWTzJKBN8jmSYv1Mk1D3RpQPNR7wVzi46KR081AU41uMpqIGVOwHtyVnW/ZfLr\nc1DLIK8Cx8aHfoxffwzoMO5SEQSooeZfOLhsfDN1AoGBAKQTUEINsj+75psgbAr6\nELGgItJ9yPBLVRr+cUzEpx9LDWVvjMihpP4NX1gq8EOPWT+ewLHVmmsjCyV6xw8J\nXXF8e2xif3in0m3D/wCzE7u2T06rKM3B017hKnrZmGoHnrqPU2osM4sOUpshWX6d\nv1Q4EF1+fbK3YCW+VpCBsB9NAoGAQo+uhNLODee56iKkzpjXWCsFTq6ar3hD5F3P\n63buKdNwhd2GlSPhXFbf+7M5GWW6BZk6rMvv7EOAVice2uvyFm8/4/1WbmF8R+T7\nLX1rPLO5p/m701QpvP11TabiwqRkqtSEQhSRF0AKTojSW/yyHCZFAawUhV/Z9EKi\nHmKb97kCgYAyzmFc2it0HqnsOnRybop603nqMtWGTQO4cxa93HUDpYajuK2K3Dfr\nxUj6lG3z/oKJGGE2JqgZ6LBAhNJtJWJu2ox3pKGE63QjLJnVwb8y1NFYpe/crbLe\nPuBwIR0L7drXxfv7O5btY7h6QI2d1/UIAQPAWbxLoTM+ndQ/uPEdfA==\n-----END RSA PRIVATE KEY-----',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/list_pops":{"get":{"description":"This function lists the cPanel account's email accounts.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"list_pops","parameters":[{"description":"A [Perl Compatible Regular Expression (PCRE)](https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions) that filters the results.","in":"query","name":"regex","required":false,"schema":{"example":"user","type":"string"}},{"description":"Whether to skip the email database's validation check.\n* `1` — Skip the validation check.\n* `0` — Run the validation check.","in":"query","name":"no_validate","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to exclude the cPanel account's main account from the results.\n* `1` — Exclude the main account.\n* `0` — Include the main account.","in":"query","name":"skip_main","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_pops","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"An object of data for an email address on the cPanel account.","items":{"properties":{"email":{"description":"An email address.\n* A valid email address on the cPanel account.\n* The cPanel account username, for the main account.","example":"user@example.com","oneOf":[{"format":"email","type":"string"},{"format":"username","type":"string"}]},"login":{"description":"The email account login.\n* A valid email address on the cPanel account.\n* `Main Account`, for the main account.","example":"user@example.com","oneOf":[{"format":"email","type":"string"},{"enum":["Main Account"],"type":"string"}]},"suspended_incoming":{"description":"Whether incoming email for the email account is suspended.\n* `1` - Suspended.\n* `0` - Not suspended.","enum":[0,1],"example":0,"type":"integer"},"suspended_login":{"description":"Whether logins for the email account are suspended.\n* `1` - Suspended.\n* `0` - Not suspended.","enum":[0,1],"example":0,"type":"integer"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return email accounts","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  list_pops\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/list_pops"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_list_pops.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_list_pops.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/list_pops/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_list_pops.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_list_pops.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'list_pops'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/list_pops_with_disk":{"get":{"description":"This function lists the cPanel account's email accounts with disk information.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"list_pops_with_disk","parameters":[{"description":"A domain name to filter the results by. If you do **not** use this parameter, the function returns **all** of the cPanel account's email addresses.","in":"query","name":"domain","required":false,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"The cPanel user account to query. If you do **not** use this parameter, the function returns the email addresses for **all** cPanel accounts that the user owns.\n\n**Note:**\n\n To retrieve information for a single email address, add the domain parameter. For example, `email=user&domain=example.com` will return information for the email address `user@example.com`.","in":"query","name":"email","required":false,"schema":{"example":"user","format":"username","type":"string"}},{"description":"Whether to display restriction status for each of the email addresses.\n* `1` — Display.\n* `0` — Do **not** display.","in":"query","name":"get_restrictions","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"An image to display for email addresses with an unlimited quota. If you specify an `infinityimg` value, the function returns HTML code to display that image as the `diskquota` parameter's value.","in":"query","name":"infinityimg","required":false,"schema":{"example":"images/myimg.jpg","type":"string"}},{"description":"Whether to return the `∞` character for email addresses with an unlimited quota.\n* `1` — Return the `∞` character for unlimited `diskquota` values.\n* `0` — Return the string `unlimited` for unlimited `diskquota` values.\n\n**Note:**\n\n If you specify `1` for this parameter **and** the `infinityimg` parameter, the function ignores **this** parameter and returns HTML code for unlimited `diskquota` values.","in":"query","name":"infinitylang","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"The maximum number of email addresses to return. If you do not use this parameter, the function returns an unlimited number of email addresses.","in":"query","name":"maxaccounts","required":false,"schema":{"default":"unlimited","example":500,"minimum":1,"type":"integer"}},{"description":"Whether to skip the collection of disk usage information.\n* `1` — Do **not** collect.\n* `0` — Collect.","in":"query","name":"no_disk","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"Whether to skip email database validation.\n* `1` — Skip validation.\n* `0` — Perform the validation.","in":"query","name":"no_validate","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"A [Perl Compatible Regular Expression (PCRE)](https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions) that filters the results. For example, `/^[a-z0-9_-]{6,18}$/` matches the local portion of an email address, if it contains between six and 18 characters.","in":"query","name":"regex","required":false,"schema":{"default":"An empty string","example":"/^[a-z0-9_-]{6,18}$/","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_pops_with_disk","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"An array of objects containing data for each email address.","items":{"properties":{"_diskquota":{"description":"The disk quota.\n* A positive value that represents the disk quota, in bytes.\n* `0` - The account possesses an unlimited disk quota.","example":0,"minimum":0,"type":"integer"},"_diskused":{"description":"The disk space that the email account uses.\n* A positive value that represents the used disk space, in bytes.\n* `0` - The account possesses an unlimited disk quota.","example":483,"minimum":0,"type":"integer"},"diskquota":{"description":"The email account's disk quota.\n* A positive value that represents the email address's quota, in megabytes (MB).\n* `unlimited`, `∞`, or HTML code to display an infinity image - The email account has an unlimited quota.\n\n**Note:**\n\n  The `infinityimg` and `infinitylang` parameters determine the unlimited value for this return.","example":"unlimited","oneOf":[{"minimum":0,"type":"integer"},{"type":"string"}]},"diskused":{"description":"The disk space that the email account uses.\n* A positive floating-point value that represents the used disk space, in megabytes (MB).\n* `0` - The account possesses an unlimited disk quota.","example":0,"minimum":0,"type":"integer"},"diskusedpercent":{"description":"The percentage of disk space that the email account uses.\n* A positive value.\n* `0` - The account has an unlimited disk quota.","example":0,"minimum":0,"type":"integer"},"diskusedpercent20":{"description":"The percentage of disk space that the email account uses.\n* A positive value.\n* `0` - The account possesses an unlimited disk quota.","example":0,"minimum":0,"type":"integer"},"diskusedpercent_float":{"description":"The floating-point value from which the function derives the `diskusedpercent` return.\n* A floating-point value.\n* `0` - Unlimited or disabled disk quota.\n\n**Note:**\n\n The `diskusedpercent_float` number can contain scientific notation values. For example, `1.20494365692139e-05`.","example":0,"minimum":0,"type":"number"},"domain":{"description":"The email account's domain. For example, `example.com` if the email address is `user@example.com`.","example":"example.com","format":"domain","type":"string"},"email":{"description":"The email address, or the string `Main Account`.\n* A valid email address.\n* `Main Account`","example":"user@example.com","oneOf":[{"format":"email","type":"string"},{"enum":["Main Account"],"type":"string"}]},"has_suspended":{"description":"Whether the email account possesses one of the following suspension parameters: `suspended_login` `suspended_incoming` `suspended_outgoing` `hold_outgoing`\n* `1` - The email account has a suspension.\n* `0` - The email account does **not** have a suspension.\n\n**Note:**\n\n  The function **only** returns this value if you pass the `get_restrictions=1` parameter.","enum":[0,1],"example":0,"type":"integer"},"hold_outgoing":{"description":"Whether the email account's outgoing email is held in Exim's queue.\n* `1` - Outgoing email is held in Exim's queue.\n* `0` - Outgoing email is **not** held in Exim's queue.\n\n**Note:**\n\n  The function **only** returns this value if you pass the `get_restrictions=1` parameter.","enum":[0,1],"example":0,"type":"integer"},"humandiskquota":{"description":"The disk quota, in human-readable format.\n* The disk quota and the unit of measure.\n* `None` - The account possesses an unlimited disk quota.","example":"None","oneOf":[{"minimum":0,"type":"integer"},{"enum":["None"],"type":"string"}]},"humandiskused":{"description":"The disk space that the email account uses, in human-readable format.\n* The disk space that the email account uses, a non-breaking space (`\\u00a0`), and the unit of measure.\n* `None` - The account possesses an unlimited disk quota.","example":"483 bytes","type":"string"},"login":{"description":"The email address, or the main account username.\n* A valid email address.\n* The username for the main account.","example":"user@example.com","oneOf":[{"format":"username","type":"string"},{"format":"email","type":"string"}]},"mtime":{"description":"The email account's last modification time, in [Unix time](https://wikipedia.org/wiki/Unix_time) format.","example":1415894498,"format":"unix_timestamp","type":"integer"},"suspended_incoming":{"description":"Whether the email account's incoming email is suspended.\n* `1` - Suspended.\n* `0` - **Not** suspended.","enum":[0,1],"example":0,"type":"integer"},"suspended_login":{"description":"Whether the user's ability to log in to, send mail from, and read their email account is suspended.\n* `1` - Suspended.\n* `0` - **Not** suspended.","enum":[0,1],"example":0,"type":"integer"},"suspended_outgoing":{"description":"Whether the email account's outgoing email is suspended.\n* `1` - Suspended.\n* `0` - **Not** suspended.","enum":[0,1],"example":0,"type":"integer"},"txtdiskquota":{"description":"The email account's disk quota.\n* A positive value that represents the email address's quota, in megabytes (MB).\n* `unlimited` - The email account has an unlimited quota.","example":"unlimited","oneOf":[{"minimum":0,"type":"integer"},{"enum":["unlimited"],"type":"string"}]},"user":{"description":"The email account username. For example, `user` if the email address is `user@example.com`.","example":"user","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return email accounts with disk information","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  list_pops_with_disk\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/list_pops_with_disk"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_list_pops_with_disk.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_list_pops_with_disk.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/list_pops_with_disk/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_list_pops_with_disk.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_list_pops_with_disk.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'list_pops_with_disk'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/passwd_pop":{"get":{"description":"This function changes an email account's password.\n\n**Important:**\n\nWhen you disable the [Receive Mail role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"passwd_pop","parameters":[{"description":"The email account username or address.","example":"username@example.com","in":"query","name":"email","required":true,"schema":{"anyOf":[{"example":"username@example.com","format":"email","type":"string"},{"example":"username","format":"username","type":"string"}]}},{"description":"The email account password.","in":"query","name":"password","required":true,"schema":{"example":"12345luggage","type":"string"}},{"description":"The email account's domain.","in":"query","name":"domain","required":false,"schema":{"default":"the cPanel account's main domain","example":"example.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"passwd_pop","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update email account password","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  passwd_pop \\\n  email='username@example.com' \\\n  password='12345luggage'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/passwd_pop?email=username%40example.com&password=12345luggage"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_passwd_pop.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_passwd_pop.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/passwd_pop/,\n    {\n        'email' => 'username@example.com',\n        'password' => '12345luggage',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_passwd_pop.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_passwd_pop.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'passwd_pop',\n    array (\n        'email' => 'username@example.com',\n        'password' => '12345luggage',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/list_system_filter_info":{"get":{"description":"This function retrieves a `.yaml.gz` file that contains system-level filter information.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"list_system_filter_info","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_system_filter_info","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"properties":{"filter_info":{"description":"The file that contains the account's system-level filter information. A `.yaml.gz` filename that contains the cPanel account username.","example":"filter_info.username.yaml.gz","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return system-level email filter file information","tags":["Email","Email Filtering"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  list_system_filter_info\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/list_system_filter_info"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_list_system_filter_info.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_list_system_filter_info.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/list_system_filter_info/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_list_system_filter_info.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_list_system_filter_info.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'list_system_filter_info'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/release_outgoing":{"get":{"description":"This function sends all of the outgoing mail from Exim's queue for an email account.\n\n**Note:**\n\nTo set Exim to queue all outgoing mail for an email account, use the UAPI `Email::hold_outgoing` function.","operationId":"release_outgoing","parameters":[{"description":"The email account's username.","in":"query","name":"email","required":true,"schema":{"example":"username@example.com","format":"email","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"release_outgoing","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Start email account outgoing mail","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  release_outgoing \\\n  email='username@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/release_outgoing?email=username%40example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_release_outgoing.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_release_outgoing.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/release_outgoing/,\n    {\n        'email' => 'username@example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_release_outgoing.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_release_outgoing.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'release_outgoing',\n    array (\n        'email' => 'username@example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 70"}},"/Email/reorder_filters":{"get":{"description":"This function modifies the filter order for an email address. For more information about Exim filters, read [Exim's documentation](http://www.exim.org/exim-html-3.30/doc/html/filter.html).\n\n**Important:**\n\nWhen you disable the [_Receive Mail_ role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"reorder_filters","parameters":[{"description":"The email address.","in":"query","name":"mailbox","required":true,"schema":{"example":"user@example.com","type":"string"}},{"description":"A mail filter name.\n\nFor each mail filter to reorder, supply a `filter*` parameter, where `*` is a number that represents the filter's order.\n\nFor example, to set `coffee` as the first email filter and `cheesecloth` as the second, set `coffee` as the `filter1` parameter's value, and `cheesecloth` as the value for the `filter2` parameter.","in":"query","name":"filter*","required":true,"schema":{"example":"coffee","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"reorder_filters","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"enum":[null],"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update email address's email filter order","tags":["Email","Email Filtering"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  reorder_filters \\\n  mailbox='user@example.com' \\\n  filter*='coffee'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/reorder_filters?mailbox=user%40example.com&filter%2a=coffee"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_reorder_filters.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_reorder_filters.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/reorder_filters/,\n    {\n        'mailbox' => 'user@example.com',\n        'filter*' => 'coffee',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_reorder_filters.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_reorder_filters.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'reorder_filters',\n    array (\n        'mailbox' => 'user@example.com',\n        'filter*' => 'coffee',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/suspend_incoming":{"get":{"description":"This function suspends incoming email for an account. The system will reject incoming email while the account is suspended.\n\n**Notes:**\n\n* The user can still log in to the email account. To suspend a user's ability to log in to, send mail from, and read their account, use the UAPI `Email::suspend_login` function.\n* Use the UAPI `Email::unsuspend_incoming` function to allow the account to receive email.\n\n**Important:**\n\nWhen you disable the [Receive Mail role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"suspend_incoming","parameters":[{"description":"The email user's account name.","in":"query","name":"email","required":false,"schema":{"example":"user@example.com","format":"email","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"suspend_incoming","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Suspend email account incoming (SMTP) mail","tags":["Email","Email Suspensions"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  suspend_incoming\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/suspend_incoming"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_suspend_incoming.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_suspend_incoming.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/suspend_incoming/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_suspend_incoming.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_suspend_incoming.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'suspend_incoming'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/Email/remove_mailman_delegates":{"get":{"description":"This function removes an account's mailing list administrative privileges.","operationId":"remove_mailman_delegates","parameters":[{"description":"The mailing list.","in":"query","name":"list","required":true,"schema":{"example":"mylist","type":"string"}},{"description":"list of the administrators to remove.","in":"query","name":"delegates","required":true,"schema":{"example":"user@example.com,admin@example.com","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"remove_mailman_delegates","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"properties":{"delegates":{"description":"An array of the mailing list's administrators. One or more email addresses.","items":{"example":"secondadmin@example.com","type":"string"},"type":"array"},"metadata":{"properties":{"transformed":{}},"type":"object"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove account mailing list admin privileges","tags":["Email","Mailing Lists"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  remove_mailman_delegates \\\n  list='mylist' \\\n  delegates='user@example.com,admin@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/remove_mailman_delegates?list=mylist&delegates=user%40example.com%2cadmin%40example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_remove_mailman_delegates.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_remove_mailman_delegates.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/remove_mailman_delegates/,\n    {\n        'list' => 'mylist',\n        'delegates' => 'user@example.com,admin@example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_remove_mailman_delegates.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_remove_mailman_delegates.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'remove_mailman_delegates',\n    array (\n        'list' => 'mylist',\n        'delegates' => 'user@example.com,admin@example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/set_always_accept":{"get":{"description":"This function sets the Mail Exchanger (MX) type.\n\n**Note:**\n\n  This function **only** affects the cPanel configuration. You **must** configure the mail exchanger's DNS entry separately.\n\n**Important:**\n\nWhen you disable the [DNS role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"set_always_accept","parameters":[{"description":"The mail exchanger's domain.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"The mail exchanger type.\n* `auto` — Allow cPanel to determine the appropriate role.\n* `local` — Always accept the domain's mail.\n* `secondary` — Accept mail until a higher priority mail server is available.\n* `remote` — Do **not** accept mail.\n\n**Note:**\n\nThis parameter is redundant with the `alwaysaccept` parameter. Do **not** enter the `mxcheck` and `alwaysaccept`\nparameters at the same time. [Undefined behavior](https://en.wikipedia.org/wiki/Undefined_behavior) may occur if this\nhappens.","in":"query","name":"mxcheck","required":false,"schema":{"default":"auto","enum":["auto","local","secondary","remote"],"example":"auto","type":"string"}},{"description":"The mail exchanger type.\n* `auto` — Allow cPanel to determine the appropriate role.\n* `local` — Always accept the domain's mail.\n* `secondary` — Accept mail until a higher priority mail server is available.\n* `remote` — Do **not** accept mail.\n\n**Note:**\n\nThis parameter is redundant with the `mxcheck` parameter. Do **not** enter the `mxcheck` and `alwaysaccept`\nparameters at the same time. [Undefined behavior](https://en.wikipedia.org/wiki/Undefined_behavior) may occur if this\nhappens.","in":"query","name":"alwaysaccept","required":false,"schema":{"default":"auto","enum":["auto","local","secondary","remote"],"example":"auto","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_always_accept","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"properties":{"checkmx":{"description":"An object containing the mail exchanger's data.","properties":{"changed":{"description":"Whether a change occurred during the function.\n* `1` — Change occurred.\n* `0` — **No** change.","enum":[0,1],"example":1,"type":"integer"},"detected":{"description":"The mail exchanger type.\n* `auto` — Allow cPanel to determine the appropriate role.\n* `local` — Always accept the domain's mail.\n* `secondary` — Accept mail until a higher priority mail server is available.\n* `remote` — Do **not** accept mail.","enum":["auto","local","secondary","remote"],"example":"auto","type":"string"},"isprimary":{"description":"Whether the mail exchanger is the primary mail exchanger.\n* `1` —  Primary.\n* `0` — **Not** primary.","enum":[0,1],"example":0,"type":"integer"},"issecondary":{"description":"Whether the mail exchanger is a secondary exchanger.\n* `1` — Secondary.\n* `0` — **Not** secondary.","enum":[0,1],"example":0,"type":"integer"},"local":{"description":"Whether the mail exchanger is a local exchanger.\n* `1` — Local.\n* `0` — **Not** local.","enum":[0,1],"example":0,"type":"integer"},"mxcheck":{"description":"The mail exchanger type.\n  * `auto` — Allow cPanel to determine the appropriate role.\n  * `local` — Always accept the domain's mail.\n  * `secondary` — Accept mail until a higher priority mail server is available.\n  * `remote` — Do **not** accept mail.","enum":["auto","local","secondary","remote"],"example":"auto","type":"string"},"remote":{"description":"Whether the mail exchanger is a remote exchanger.\n* `1` — Remote.\n* `0` — **Not** remote.","enum":[0,1],"example":0,"type":"integer"},"secondary":{"description":"Whether the mail exchanger is a secondary exchanger.\n* `1` — Secondary.\n* `0` — **Not** secondary.","enum":[0,1],"example":0,"type":"integer"},"warnings":{"description":"An array of warning messages, if any exist. One or more warning messages.","items":{"example":"Auto Detect of MX configuration not possible due to non-resolving MX entries. Defaulting to last known setting: local.","type":"string"},"type":"array"}},"type":"object"},"detected":{"description":"The mail exchanger type.\n  * `auto` — Allow cPanel to determine the appropriate role.\n  * `local` — Always accept the domain's mail.\n  * `secondary` — Accept mail until a higher priority mail server is available.\n  * `remote` — Do **not** accept mail.","example":"auto","type":"string"},"local":{"description":"Whether the mail exchanger is a local exchanger.\n* `1` — Local.\n* `0` — **Not** local.","enum":[0,1],"example":0,"type":"integer"},"mxcheck":{"description":"The mail exchanger type.\n  * `auto` — Allow cPanel to determine the appropriate role.\n  * `local` — Always accept the domain's mail.\n  * `secondary` — Accept mail until a higher priority mail server is available.\n  * `remote` — Do **not** accept mail.","example":"auto","type":"string"},"remote":{"description":"Whether the mail exchanger is a remote exchanger.\n* `1` — Remote.\n* `0` — **Not** remote.","enum":[0,1],"example":0,"type":"integer"},"results":{"description":"A message of success or a reason for failure.\n* A message of success that includes the new type.\n* A string that describes an error.","example":"Set Always Accept Status to: local","type":"string"},"secondary":{"description":"Whether the mail exchanger is a secondary exchanger.\n* `1` — Secondary.\n* `0` — **Not** secondary.","enum":[0,1],"example":0,"type":"integer"},"status":{"description":"Whether the function succeeded.\n* `1` — Success.\n* `0` — Failure.","enum":[0,1],"example":1,"type":"integer"},"statusmsg":{"description":"A message of success or a reason for failure.\n* A message of success that includes the new type.\n* A string that describes an error.","example":"Set Always Accept Status to: local","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update Mail Exchanger type","tags":["Email","Email Server Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  set_always_accept \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/set_always_accept?domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_set_always_accept.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_set_always_accept.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/set_always_accept/,\n    {\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_set_always_accept.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_set_always_accept.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'set_always_accept',\n    array (\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/set_default_address":{"get":{"description":"This function configures a default (catchall) email address.\n\n**Important**:\n\n  When you disable the [Mail Receive role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"set_default_address","parameters":[{"description":"The domain whose default email behavior you want to configure.\n\n**Note**:\n\n  This parameter defaults to the cPanel account’s main domain.","in":"query","name":"domain","required":false,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"The method to use to handle unroutable mail.\n* `fwd` — Forward messages to the `fwdemail` parameter’s address.\n* `fail` — Bounce messages back to the sender, and include the `failmsgs` parameter’s failure message.\n* `blackhole` — Send messages to the `/dev/null/` directory. This method does **not** generate a failure notice.\n* `pipe` — Pipe mail to the `pipefwd` parameter’s application. This parameter requires the [File Storage role](https://go.cpanel.net/serverroles).","in":"query","name":"fwdopt","required":true,"schema":{"enum":["fwd","fail","blackhole","pipe"],"example":"fwd","type":"string"}},{"description":"The email address to which the system forwards messages.\n\n**Note**:\n\n Use this parameter if you used the `fwd` method for the `fwdopt` parameter.","in":"query","name":"fwdemail","required":false,"schema":{"example":"admin@example.com","format":"email","type":"string"}},{"description":"The failure message for the message’s sender.\n\n**Note**:\n\n Use this parameter if you used the `fail` method for the `fwdopt` parameter.","in":"query","name":"failmsgs","required":false,"schema":{"default":"No such person at this address","example":"Failure echos loud. That address does not exist. Softly I regret. - an email failure haiku","type":"string"}},{"description":"The application to which the system pipes messages.\n\n**Note**:\n\n  Use this parameter if you used the `pipe` method for the `fwdopt` parameter.\n\n**Important**:\n\n  This parameter requires the [File Storage role](https://go.cpanel.net/serverroles).","in":"query","name":"pipefwd","required":false,"schema":{"example":"mailscript.pl","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_default_address","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"An array of hashes of forwarder information. This array of hashes includes the domain and dest returns.","items":{"properties":{"dest":{"description":"The destination to which the system sends unroutable mail.\n- An email address  The system forwards mail to this address.\n- :fail:  The system bounces mail back to the sender, and sends a failure message.\n- :blackhole:  The system deletes mail without a failure message.\n- The path to an application  The system pipes mail to this application.","example":"admin@example.com","type":"string"},"domain":{"description":"The domain. A valid domain on the account.","example":"example.com","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- `1` — Success.\n- `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create default email address","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  set_default_address \\\n  fwdopt='fwd'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/set_default_address?fwdopt=fwd"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_set_default_address.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_set_default_address.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/set_default_address/,\n    {\n        'fwdopt' => 'fwd',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_set_default_address.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_set_default_address.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'set_default_address',\n    array (\n        'fwdopt' => 'fwd',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/set_list_privacy_options":{"get":{"description":"This function modifies a Mailman mailing list's privacy options.\n\n**Important:**\n\nWhen you disable the [Receive Mail role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"set_list_privacy_options","parameters":[{"description":"The mailing list name.","in":"query","name":"list","required":true,"schema":{"example":"mylist","type":"string"}},{"description":"Whether the Mailman directory page displays the list.\n* `1` - Display.\n* `0` - Does **not** display.","in":"query","name":"advertised","required":true,"schema":{"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether the mailing list archive is private.\n* `1` - Private.\n* `0` - Public.","in":"query","name":"archive_private","required":true,"schema":{"enum":[0,1],"example":1,"type":"integer"}},{"description":"The level of control that the mailing list administrator has over new subscribers.\n* `1` - Anyone can subscribe. The system sends a confirmation email.\n* `2` - The administrator **must** approve subscriptions. The system does **not** send a confirmation email.\n* `3` - The administrator **must** approve subscriptions. The system sends a confirmation email.","in":"query","name":"subscribe_policy","required":true,"schema":{"enum":[1,2,3],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_list_privacy_options","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update mailing list privacy options","tags":["Email","Mailing Lists"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  set_list_privacy_options \\\n  list='mylist' \\\n  advertised='1' \\\n  archive_private='1' \\\n  subscribe_policy='1'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/set_list_privacy_options?list=mylist&advertised=1&archive_private=1&subscribe_policy=1"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_set_list_privacy_options.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_set_list_privacy_options.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/set_list_privacy_options/,\n    {\n        'list' => 'mylist',\n        'advertised' => '1',\n        'archive_private' => '1',\n        'subscribe_policy' => '1',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_set_list_privacy_options.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_set_list_privacy_options.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'set_list_privacy_options',\n    array (\n        'list' => 'mylist',\n        'advertised' => '1',\n        'archive_private' => '1',\n        'subscribe_policy' => '1',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/stats_db_status":{"get":{"description":"This function returns the status of the eximstats SQLite Database.\n\n**Important:**\n\nWhen you disable the [Receive Mail role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"stats_db_status","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"stats_db_status","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"The disk space that the email account uses.\n* `active` - The database is available and up-to-date.\n* `importing` - The database is available, but a data import is currently in progress.\n* `upcp` - The database is unavailable because cPanel & WHM is updating.\n\n**Note:**\n\nIf the `eximstats` database is running a cPanel & WHM update, but the database is available, this function will return `active`, **not** `upcp`.","enum":["active","importing","upcp"],"example":"active","type":"string"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return eximstats SQLite database status","tags":["Email","Email Server Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  stats_db_status\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/stats_db_status"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_stats_db_status.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_stats_db_status.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/stats_db_status/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_stats_db_status.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_stats_db_status.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'stats_db_status'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 64"}},"/Email/store_filter":{"get":{"description":"This function creates a new email filter. For more information about Exim filters, read [Exim's documentation](http://www.exim.org/exim-html-3.30/doc/html/filter.html).\n\n**Important:**\n\nWhen you disable the [*Receive Mail* role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.\n\n### Create multiple rules\n\nYou may create up to 4,096 separate sets of conditions in one filter. To do this, append numbers to the parameter names.\n\nTo create a filter with two sets of actions and conditions, use the following parameters:\n  * Assign the information for the first filter rule to the `action1`, `dest1`, `match1`, `opt1`, `part1`, and `val1` parameters.\n  * Assign the information for the second filter rule to the `action2`, `dest2`, `match2`, `opt2`, `part2`, and `val2` parameters.\n\nTo create a filter that uses one set of actions but two sets of conditions, use the following parameters:\n  * Assign the actions to the `action1` and `dest1` parameters.\n  * Assign the first set of conditions to the `match1`, `opt1`, `part1`, and `val1` parameters.\n  * Assign the second set of conditions to the `match2`, `opt2`, `part2`, and `val2` parameters.","operationId":"store_filter","parameters":[{"description":"The email address, for user-level filters. If you do not use this parameter, the function creates an account-level filter.","in":"query","name":"account","required":false,"schema":{"example":"user@example.com","format":"email","type":"string"}},{"description":"The filter name.","in":"query","name":"filtername","required":true,"schema":{"example":"coffee","type":"string"}},{"description":"The name of an existing filter, to rename it. If you do not use this parameter, the function creates a new filter.","in":"query","name":"oldfiltername","required":false,"schema":{"example":"pool","type":"string"}},{"description":"The filter's action.\n\n* `deliver` - Deliver the message to the `dest*` address.\n* `fail` - Force a delivery failure.\n* `finish` - Stop processing the message.\n* `save` - Save the message to the `dest*` file.\n* `pipe` - Pipe the message to the `dest*` application.\n\n**Important:**\n\n* You **must** increment each action. For example, pass the first action as `action1` and the second action as `action2`.\n* This value **requires** the `FileStorage` role. For more information, read our [How to Use Server Profiles](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles) documentation.","examples":{"multiple":{"summary":"Use multiple filter actions.","value":"action1=deliver action2=save"},"single":{"summary":"Use a single filter action.","value":"deliver"}},"in":"query","name":"action*","required":true,"schema":{"anyOf":[{"enum":["deliver","fail","finish","save","pipe"],"type":"string"}]}},{"description":"The destination for filtered mail.\n\n**Important:**\n\n * This parameter is **required** if the action value is `deliver`, `save`, or `pipe`.\n * You **must** increment each destination. For example, pass the first destination as `dest1` and the second destination as `dest2`.","examples":{"multiple":{"summary":"Use multiple destinations for filtered mail.","value":"dest1=user@example.com dest2=user2@example.com"},"single":{"summary":"Use a single destination for filtered mail.","value":"user@example.com"}},"in":"query","name":"dest*","required":false,"schema":{"anyOf":[{"description":"A valid email address.","example":"cheesecloth@example.com","format":"email","type":"string"},{"description":"A valid file or application path.","example":"/path/to/thing","format":"path","type":"string"}],"default":""}},{"description":"The filter's [match type](http://www.exim.org/exim-html-current/doc/html/spec_html/filter_ch-exim_filter_files.html).\n* If the `val*` parameter is a string, use a string operator.\n* If the `val*` parameter is an integer, use a numeric operator.\n\nString operators:\n\n* `is`\n* `matches`\n* `contains`\n* `does not contain`\n* `begins`\n* `does not begin`\n* `ends`\n* `does not end`\n* `does not match`\n\nNumeric operators:\n\n* `is above`\n* `is not above`\n* `is below`\n* `is not below`\n\n**Important:**\n\n You **must** increment each match type. For example, pass the first match type as `match1` and the second match type as `match2`.","examples":{"multiple":{"summary":"Use multiple match types.","value":"match1=contains match2=matches"},"single":{"summary":"Use a single match type.","value":"contains"}},"in":"query","name":"match*","required":true,"schema":{"anyOf":[{"enum":["is","matches","contains","does not contain","begins","does not begin","ends","does not end","does not match","is above","is not above","is below","is not below"],"example":"matches","type":"string"}]}},{"description":"The connection between multiple conditions.\n\n**Important:**\n\nYou **must** increment each connection. For example, pass the first connection as `opt1` and the second connection as `opt2`.","examples":{"multiple":{"summary":"Use multiple connections between conditions.","value":"opt1=and opt2=and"},"single":{"summary":"Use a single connection between conditions.","value":"and"}},"in":"query","name":"opt*","required":false,"schema":{"anyOf":[{"enum":["and","or"],"type":"string"}],"default":"and"}},{"description":"The email section to query.\n\n * `$h_x-Spam-Bar:` - Match against the message's spam score value, measured in plus(`+`) characters.\n * `$h_x-Spam-Score:` - Match against the message's spam score value.\n * `$h_X-Spam-Status:` - Match against whether the system detected the message as spam.\n * `$h_List-Id:` - Match against the message's `List-ID` header value.\n * `$header_from:` - Match against the `From:` section.\n * `$header_subject:` - Match against the `Subject:` section.\n * `$header_to:` - Match against the `To:` section.\n * `$reply_address:` - Match against the `Reply To:` section.\n * `$message_body:` - Match against the message's body.\n * `$message_headers:` - Match against the message's headers.\n * `foranyaddress $h_to:, $h_cc:` - Match against all message recipients.\n * `not delivered` - Match if the message is not queued for delivery.\n * `error_message` - Match if the incoming message is bounced.\n\n**Important:**\n\nYou **must** increment each section. For example, pass the first section as `part1` and the second section as `part2`.\n\n**Note:**\n\nGenerally, the recipient does **not** receive the `BCC` field in an email's header. For this reason you **cannot** use the `BCC` field in a filter.","examples":{"multiple":{"summary":"Query multiple email sections.","value":"part1=$header_from part2=$message_body"},"single":{"summary":"Query a single email section.","value":"$header_from"}},"in":"query","name":"part*","required":true,"schema":{"anyOf":[{"enum":["$h_x-Spam-Bar","$h_x-Spam-Score","$h_X-Spam-Status","$h_List-id","$header_from","$header_subject","$header_to","$reply_address","$message_body","$message_headers","$h_to, $h_cc","not delivered","error_message"],"type":"string"}]}},{"description":"The value to match.\n\n**Important:**\n\nYou **must** increment each value. For example, pass the first value as `val1` and the second value as `val2`.","examples":{"multiple":{"summary":"Match multiple values.","value":"val1=coconut val2=12"},"single":{"summary":"Match a single value.","value":"coconut"}},"in":"query","name":"val*","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"integer"}]}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"store_filter","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"properties":{"account":{"description":"The filter's email address. The function only returns this value if it created a user-level filter.","example":"user@example.com","format":"email","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success\n* `0` - Failed. Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create email filter","tags":["Email","Email Filtering"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  store_filter \\\n  filtername='coffee' \\\n  action*='deliver' \\\n  match*='contains' \\\n  part*='$header_from' \\\n  val*='coconut'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/store_filter?filtername=coffee&action%2a=deliver&match%2a=contains&part%2a=%24header_from&val%2a=coconut"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_store_filter.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_store_filter.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/store_filter/,\n    {\n        'filtername' => 'coffee',\n        'action*' => 'deliver',\n        'match*' => 'contains',\n        'part*' => '$header_from',\n        'val*' => 'coconut',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_store_filter.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_store_filter.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'store_filter',\n    array (\n        'filtername' => 'coffee',\n        'action*' => 'deliver',\n        'match*' => 'contains',\n        'part*' => '$header_from',\n        'val*' => 'coconut',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/suspend_login":{"get":{"description":"This function suspends a user's ability to log in to their email account. This function immediately suspends the user's login credentials and prevents future authenticated connections to the email account.\n\n**Notes:**\n\n* When you suspend an account, the user's account still receives email.\n* To suspend incoming email for an account, use the UAPI `Email::suspend_incoming` function.\n* To remove the login suspension for an account, use the UAPI `Email::unsuspend_login` function.\n\n**Important:**\n\nWhen you disable the [Receive Mail role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"suspend_login","parameters":[{"description":"The email user's account name.","in":"query","name":"email","required":true,"schema":{"example":"user@example.com","format":"email","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"suspend_login","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Suspend email account login","tags":["Email","Email Suspensions"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  suspend_login \\\n  email='user@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/suspend_login?email=user%40example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_suspend_login.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_suspend_login.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/suspend_login/,\n    {\n        'email' => 'user@example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_suspend_login.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_suspend_login.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'suspend_login',\n    array (\n        'email' => 'user@example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/Email/unsuspend_login":{"get":{"description":"This function restores a user's ability to log in to their email account.\n\n**Note:**\n\n* To suspend a user's ability to log in, use the UAPI `Email::suspend_login` function.\n* To suspend incoming email for an account, use the UAPI `Email::suspend_incoming` function.\n\n**Important:**\n\nWhen you disable the [Receive Mail role](https://go.cpanel.net/serverroles#roles), the system **disables** this function.","operationId":"unsuspend_login","parameters":[{"description":"The email user's account name.","in":"query","name":"email","required":false,"schema":{"example":"username@example.com","format":"email","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"unsuspend_login","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Unsuspend email account login","tags":["Email","Email Suspensions"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  unsuspend_login\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/unsuspend_login"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_unsuspend_login.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_unsuspend_login.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/unsuspend_login/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_unsuspend_login.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_unsuspend_login.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'unsuspend_login'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/Email/trace_filter":{"get":{"description":"This function tests mail filters. The function **only** tests filters for the cPanel account's main domain, and only tests against the message's body. For more information about Exim filters, read [Exim's documentation](http://www.exim.org/exim-html-3.30/doc/html/filter.html).\n\n**Note:**\n\nIf the domain or account does not contain a filter file, this function will fail.\n\n**Important:**\n\nWhen you disable the [Receive Mail](https://go.cpanel.net/serverroles) role, the system **disables** this function.","operationId":"trace_filter","parameters":[{"description":"The email address, to test legacy cPanel filters in the filters directory. If you do not use this parameter, the function tests the main domain's filters in the `/etc/vfilters` directory.","in":"query","name":"account","required":false,"schema":{"example":"user@example.com","format":"email","type":"string"}},{"description":"The string to test. The function uses this string as the body of an email message, to check whether filters would match the string.","in":"query","name":"msg","required":true,"schema":{"example":"Test","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"trace_filter","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"properties":{"trace":{"description":"A series of messages that describe the trace results.\n\n**Note:**\n\nThis output may contain HTML.","example":"Warning: no message headers read\\nReturn-path copied from sender\\nSender = user@example.com\\nRecipient = user@example.com\\nTesting Exim filter file &quot;/etc/vfilters/example.com&quot;\\n\\nFiltering did not set up a significant delivery.\\n<b>Normal delivery will occur.\\n</b>","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Run test for main domain email filters","tags":["Email","Email Filtering"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  trace_filter \\\n  msg='Test'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/trace_filter?msg=Test"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_trace_filter.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_trace_filter.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/trace_filter/,\n    {\n        'msg' => 'Test',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_trace_filter.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_trace_filter.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'trace_filter',\n    array (\n        'msg' => 'Test',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/suspend_outgoing":{"get":{"description":"This function rejects outgoing mail for a suspended email account. This function does **not** disable a user's login credentials or access permissions to their email account.\n\n**Notes:**\n\n* To suspend a user's login credentials and prevent authenticated connections to the email account, use the UAPI `Email::suspend_login` function.\n* To allow an email account to send mail, use the UAPI `Email::unsuspend_outgoing` function.\n* To hold outgoing mail in Exim's queue, use the UAPI `Email::hold_outgoing` function.\n\n**Important:**\n\nWhen you disable the [Send Mail role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"suspend_outgoing","parameters":[{"description":"The email account's username.","in":"query","name":"email","required":true,"schema":{"example":"username@example.com","format":"email","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"suspend_outgoing","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"Whether the function succeeded.\n* `1` — The function succeeded.\n* `0` — The function failed.","enum":[0,1],"example":1,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Suspend email account outgoing mail","tags":["Email","Email Suspensions"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  suspend_outgoing \\\n  email='username@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/suspend_outgoing?email=username%40example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_suspend_outgoing.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_suspend_outgoing.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/suspend_outgoing/,\n    {\n        'email' => 'username@example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_suspend_outgoing.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_suspend_outgoing.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'suspend_outgoing',\n    array (\n        'email' => 'username@example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 70"}},"/Email/unsuspend_incoming":{"get":{"description":"This function unsuspends incoming email for an email account.\n\n**Important:**\n\nWhen you disable the [Receive Mail role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"unsuspend_incoming","parameters":[{"description":"The email user's account name.","in":"query","name":"email","required":false,"schema":{"example":"user@example.com","format":"email","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"unsuspend_incoming","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"Whether the function succeeded.\n* `1` — The function succeeded.\n* `0` — The function failed.","enum":[0,1],"example":1,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Unsuspend email account incoming mail","tags":["Email","Email Suspensions"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  unsuspend_incoming\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/unsuspend_incoming"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_unsuspend_incoming.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_unsuspend_incoming.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/unsuspend_incoming/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_unsuspend_incoming.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_unsuspend_incoming.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'unsuspend_incoming'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/Email/trace_delivery":{"get":{"description":"This function traces the email delivery route to an email account.","operationId":"trace_delivery","parameters":[{"description":"The email address to which to trace a message delivery path.","in":"query","name":"recipient","required":true,"schema":{"example":"username@example.com","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"trace_delivery","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/trace_deliveryResponseBase"},{"$ref":"#/components/schemas/trace_deliveryType"}],"example":{"address":"username@example.com","destinations":[{"address":"username@example.com","aliasfile":"/etc/valiases/example.com","destinations":[{"mailbox":"username@example.com","type":"local_delivery"}],"type":"routed"}],"type":"routed"}},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings\n describe non-critical failures or other problematic conditions\n noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Run email delivery route trace","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  trace_delivery \\\n  recipient='username@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/trace_delivery?recipient=username%40example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_trace_delivery.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_trace_delivery.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/trace_delivery/,\n    {\n        'recipient' => 'username@example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_trace_delivery.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_trace_delivery.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'trace_delivery',\n    array (\n        'recipient' => 'username@example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 84"}},"/Email/unsuspend_outgoing":{"get":{"description":"This function cancels the suspension action put in place by the UAPI `Email::suspend_outgoing`\nfunction for outgoing mail for an email account.\n\n**Note:**\n\nTo suspend an email account and reject all outgoing mail, use the UAPI `Email::suspend_outgoing` function.        ","operationId":"unsuspend_outgoing","parameters":[{"description":"The email account's username.","in":"query","name":"email","required":true,"schema":{"example":"username@example.com","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"unsuspend_outgoing","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Unsuspend email account outgoing mail","tags":["Email","Email Suspensions"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  unsuspend_outgoing \\\n  email='username@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/unsuspend_outgoing?email=username%40example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_unsuspend_outgoing.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_unsuspend_outgoing.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/unsuspend_outgoing/,\n    {\n        'email' => 'username@example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_unsuspend_outgoing.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_unsuspend_outgoing.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'unsuspend_outgoing',\n    array (\n        'email' => 'username@example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 70"}},"/Email/verify_password":{"get":{"description":"This function verifies the password for an email account.\n\n**Important:**\n\nWhen you disable the [Receive Mail role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"verify_password","parameters":[{"description":"The email account address.","in":"query","name":"email","required":true,"schema":{"example":"username@example.com","format":"email","type":"string"}},{"description":"The email account password.","in":"query","name":"password","required":true,"schema":{"example":"123456luggage","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"verify_password","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"Whether the password is valid for the email account.\n* `1` - The password is valid.\n* `0` - The password is **not** valid.","enum":[0,1],"example":1,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Validate email account password","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  verify_password \\\n  email='username@example.com' \\\n  password='123456luggage'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/verify_password?email=username%40example.com&password=123456luggage"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_verify_password.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_verify_password.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/verify_password/,\n    {\n        'email' => 'username@example.com',\n        'password' => '123456luggage',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_verify_password.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_verify_password.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'verify_password',\n    array (\n        'email' => 'username@example.com',\n        'password' => '123456luggage',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.52"}},"/Team/add_roles":{"get":{"description":"This function adds roles to a team user.\n\n**Note:**\n\n  This action may result in team users gaining access to team owner level privileges.","operationId":"add_roles","parameters":[{"description":"The username of the team user.","in":"query","name":"user","required":true,"schema":{"example":"teamuser","type":"string"}},{"description":"The role or roles to add to the team user. Current roles include admin, database, email, web.","in":"query","name":"role","required":true,"schema":{"example":"database","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"add_roles","type":"string"},"module":{"description":"The name of the module called.","example":"Team","type":"string"},"result":{"properties":{"data":{"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add roles to a team user","tags":["Team Users"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Team \\\n  add_roles \\\n  user='teamuser' \\\n  role='database'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Team/add_roles?user=teamuser&role=database"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Team_add_roles.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Team_add_roles.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Team/,\n    q/add_roles/,\n    {\n        'user' => 'teamuser',\n        'role' => 'database',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Team_add_roles.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Team_add_roles.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Team',\n    'add_roles',\n    array (\n        'user' => 'teamuser',\n        'role' => 'database',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":108}},"/EmailAuth/enable_dkim":{"get":{"description":"This function enables DomainKeys Identified Mail (DKIM) records on the DNS server for one or more domains.\n\n**Note:**\n\nIf a DKIM record does **not** exist on the server, this function will install a new DKIM record.","operationId":"enable_dkim","parameters":[{"description":"The domain for which to enable DKIM records on the DNS server.\n\n**Note:**\n\nTo enable multiple domain DKIM records, duplicate or increment the parameter. For example, to perform this for three domains, you could:\n\n* Use the `domain` parameter multiple times.\n* Use the `domain`, `domain-1`, and `domain-2` parameters.","examples":{"multiple":{"summary":"Enable multiple domains' DKIM records.","value":"domain-1=example1.com domain-2=example2.com domain-3=example3.com"},"multiple-alternative":{"summary":"Enable multiple domains' DKIM records.","value":"domain=example1.com domain=example2.com domain=example3.com"},"single":{"summary":"Enable a single domain's DKIM records.","value":"example.com"}},"in":"query","name":"domain","required":true,"schema":{"format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"enable_dkim","type":"string"},"module":{"description":"The name of the module called.","example":"EmailAuth","type":"string"},"result":{"properties":{"data":{"description":"An array that contains information about the enabled state of a domain's DKIM records on the DNS server.","items":{"properties":{"domain":{"description":"The domain for which the system enabled the DKIM record.","example":"example.com","format":"domain","type":"string"},"msg":{"description":"The domain's DKIM record status message.","example":"[no changes needed]","type":"string"},"status":{"description":"Whether the system enabled the domain's DKIM record on the DNS server.\n* `1` - Enabled.\n* `0` - The system did **not** enable the domain's DKIM record.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable domains' DKIM records","tags":["EmailAuth","Email DNS Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  EmailAuth \\\n  enable_dkim \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/EmailAuth/enable_dkim?domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file EmailAuth_enable_dkim.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/EmailAuth_enable_dkim.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/EmailAuth/,\n    q/enable_dkim/,\n    {\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file EmailAuth_enable_dkim.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/EmailAuth_enable_dkim.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'EmailAuth',\n    'enable_dkim',\n    array (\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 78"}},"/EmailAuth/ensure_dkim_keys_exist":{"get":{"description":"This function confirms the validity of a DomainKeys Identified Mail (DKIM) key for one or more domains.\n\n**Notes:**\n\n* If an existing DKIM key does **not** meet the server's security requirements, the system replaces the existing DKIM key.\n* If no DKIM key exists, the system creates a new key for the domain.","operationId":"ensure_dkim_keys_exist","parameters":[{"description":"The domain for which to confirm a valid DKIM key exists.\n\n**Note:**\n\n To check the DKIM key validity for multiple domains, duplicate the parameter name. For example, use the `domain=example.com`, `domain=example2.com`, and `domain=example3.com` parameters.","examples":{"multiple":{"summary":"Multiple domains.","value":"domain=example.com&domain=example2.com&domain=example3.com"},"single":{"summary":"A single domain.","value":"example.com"}},"in":"query","name":"domain","required":true,"schema":{"format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"ensure_dkim_keys_exist","type":"string"},"module":{"description":"The name of the module called.","example":"EmailAuth","type":"string"},"result":{"properties":{"data":{"description":"An array of objects that contains information about the domain's DKIM key validity.","items":{"properties":{"domain":{"description":"The domain for which the system confirmed that a valid DKIM key exists.","example":"example.com","format":"domain","type":"string"},"msg":{"description":"The domain's DKIM key status message.","example":"created new key","type":"string"},"status":{"description":"Whether the system verified that the domain's DKIM key exists.\n* `1` - The system verified the existence of the domain's DKIM key.\n* `0` - The system did **not** verify the existence of the domain's DKIM key.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Validate domains' DKIM private keys","tags":["EmailAuth","Email DNS Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  EmailAuth \\\n  ensure_dkim_keys_exist \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/EmailAuth/ensure_dkim_keys_exist?domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file EmailAuth_ensure_dkim_keys_exist.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/EmailAuth_ensure_dkim_keys_exist.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/EmailAuth/,\n    q/ensure_dkim_keys_exist/,\n    {\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file EmailAuth_ensure_dkim_keys_exist.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/EmailAuth_ensure_dkim_keys_exist.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'EmailAuth',\n    'ensure_dkim_keys_exist',\n    array (\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 78"}},"/EmailAuth/fetch_dkim_private_keys":{"get":{"description":"This function returns a domain's installed DKIM private key in [Privacy-Enhanced Mail (PEM)](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) format.\n\n**Warning:**\n\nWe **strongly** recommend that you protect your private key. If others obtain your private DKIM key, they could sign emails and impersonate you as a sender.","operationId":"fetch_dkim_private_keys","parameters":[{"description":"The domain for which to retrieve the installed DKIM private key.\n\n**Note:**\n\nTo retrieve multiple domain DKIM keys, duplicate the parameter name. For example, use the `domain=example.com`, `domain=example2.com`, and `domain=example3.com` parameters.","examples":{"multiple":{"summary":"Multiple domains.","value":"domain=example.com&domain=example2.com&domain=example3.com"},"single":{"summary":"A single domain.","value":"example.com"}},"in":"query","name":"domain","required":true,"schema":{"format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"fetch_dkim_private_keys","type":"string"},"module":{"description":"The name of the module called.","example":"EmailAuth","type":"string"},"result":{"properties":{"data":{"description":"An array of objects that contains information about the domain's DKIM private key.","items":{"properties":{"domain":{"description":"The queried domain.","example":"example.com","format":"domain","type":"string"},"pem":{"description":"The domain's DKIM private key, in PEM format.","example":"-----BEGIN RSA PRIVATE KEY-----\nMIICLDCCAdKgAwIBAgIBADAKBggqhkjOPQQDAjB9MQswCQYDVQQGEwJCRTEPMA0G\nA1UEChMGR251VExTMSUwIwYDVQQLExxHbnVUTFMgY2VydGlmaWNhdGUgYXV0aG9y\naXR5MQ8wDQYDVQQIEwZMZXV2ZW4xJTAjBgNVBAMTHEdudVRMUyBjZXJ0aWZpY2F0\nZSBhdXRob3JpdHkwHhcNMTEwNTIzMjAzODIxWhcNMTIxMjIyMDc0MTUxWjB9MQsw\nCQYDVQQGEwJCRTEPMA0GA1UEChMGR251VExTMSUwIwYDVQQLExxHbnVUTFMgY2Vy\ndGlmaWNhdGUgYXV0aG9yaXR5MQ8wDQYDVQQIEwZMZXV2ZW4xJTAjBgNVBAMTHEdu\ndVRMUyBjZXJ0aWZpY2F0ZSBhdXRob3JpdHkwWTATBgcqhkjOPQIBBggqhkjOPQMB\nBwNCAARS2I0jiuNn14Y2sSALCX3IybqiIJUvxUpj+oNfzngvj/Niyv2394BWnW4X\nuQ4RTEiywK87WRcWMGgJB5kX/t2no0MwQTAPBgNVHRMBAf8EBTADAQH/MA8GA1Ud\nDwEB/wQFAwMHBgAwHQYDVR0OBBYEFPC0gf6YEr+1KLlkQAPLzB9mTigDMAoGCCqG\nSM49BAMCA0gAMEUCIDGuwD1KPyG+hRf88MeyMQcqOFZD0TbVleF+UsAGQ4enAiEA\nl4wOuDwKQa+upc8GftXE2C//4mKANBC6It01gUaTIpo==\n-----END RSA PRIVATE KEY-----\n","format":"pem-private-key","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return domains' DKIM private keys","tags":["EmailAuth","Email DNS Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  EmailAuth \\\n  fetch_dkim_private_keys \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/EmailAuth/fetch_dkim_private_keys?domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file EmailAuth_fetch_dkim_private_keys.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/EmailAuth_fetch_dkim_private_keys.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/EmailAuth/,\n    q/fetch_dkim_private_keys/,\n    {\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file EmailAuth_fetch_dkim_private_keys.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/EmailAuth_fetch_dkim_private_keys.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'EmailAuth',\n    'fetch_dkim_private_keys',\n    array (\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 78"}},"/EmailAuth/install_dkim_private_keys":{"get":{"description":"This function installs existing keys for use in a DomainKeys Identified Mail (DKIM) record. This is useful if you do not want the system to generate keys for DKIM records.\n\n**Note:**\n\n* This function does **not** update the local DNS server's records.\n* If the local DNS server is authoritative for the domain's DNS records, use the UAPI `EmailAuth::enable_dkim` function to update the local DNS server's DNS records.\n  * We recommend that you use the UAPI `EmailAuth::install_dkim_private_keys` and `EmailAuth::enable_dkim functions` in a batch UAPI call.","operationId":"install_dkim_private_keys","parameters":[{"description":"The domain for which to install a DKIM private key on the local server.\n\n**Note:**\n\nTo install multiple RSA private keys for multiple domains, duplicate the parameter name. For example, use the `domain=example.com`, `domain=example2.com`, and `domain=example3.com` parameters.","examples":{"multiple":{"summary":"Multiple domains.","value":"domain=example&domain=example2.com&domain=example3.com"},"single":{"summary":"A single domain.","value":"example"}},"in":"query","name":"domain","required":true,"schema":{"format":"domain","type":"string"}},{"description":"An RSA key in [Privacy-Enhanced Mail (PEM)](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) format.\n\n**Note:**\n\nYou **must** provide this parameter for each `domain` parameter.","in":"query","name":"key","required":true,"schema":{"example":"-----BEGIN%20RSA%20PRIVATE%20KEY-----%0aAAAAB3NzaC1yc2EAAAABIwAAAQEA5kSivOqhs0U9ZMN20nxFe27QZ3t0lT2zbH7OSXylKd%0a1rjAjYXGnSXC9j2uaZlemHlptBKVziMJC86ha7Hcj6dVOVrDQ6vF4q34bOCjtKLphQ0IjB%0azVIvqILH9eLJdRaOrS34CmgmPaisrCk5wKVlakygvUfcj3HzaTKS6THyZDGx5shdTpa9lb%0ay8tpOD3JceV7ay4w8r0DipoKPC0OLpvS4EABEeMo9sx8zQEaKv03XygjNCCYtFvxlQQIRG%0alVoL7mPaHSaL3anI05RpNbm/PS+9BhZg+BqNjU4ofHBbfkXk5MiN6M7ieR4Sk5BquccboG%0aF13U5slNgmCEekdt0amw%0a-----END%20RSA%20PRIVATE%20KEY-----%0a","format":"pem-private-key","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"install_dkim_private_keys","type":"string"},"module":{"description":"The name of the module called.","example":"EmailAuth","type":"string"},"result":{"properties":{"data":{"description":"An array of objects that contains information about the DKIM private key installation to the local server.","items":{"properties":{"domain":{"description":"The DKIM private key's associated domain.","example":"example.com","format":"domain","type":"string"},"msg":{"description":"The DKIM private key's installation status message.","example":"[ADD:TXT@default._domainkey:v=DKIM1; k=rsa; p=AAAAB3NzaC1yc2EAAAABIwAAAQEA5kSivOqhs0U9ZMN20nxFe27QZ3t0lT2zbH7OSXylKd1rjAjYXGnSXC9j2uaZlemHlptBKVziMJC86ha7Hcj6dVOVrDQ6vF4q34bOCjtKLphQ0IjBzVIvqILH9eLJdRaOrS34CmgmPaisrCk5wKVlakygvUfcj3HzaTKS6THyZDGx5shdTpa9lby8tpOD3JceV7ay4w8r0DipoKPC0OLpvS4EABEeMo9sx8zQEaKv03XygjNCCYtFvxlQQIRGlVoL7mPaHSaL3anI05RpNbm/PS+9BhZg+BqNjU4ofHBbfkXk5MiN6M7ieR4Sk5BquccboGF13U5slNgmCEekdt0amw;]","type":"string"},"status":{"description":"Whether the system installed the DKIM private key to the local server.\n* `1` - The system installed the DKIM private key.\n* `0` - The system **cannot** install the DKIM private key.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add domains' DKIM record keys","tags":["EmailAuth","Email DNS Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  EmailAuth \\\n  install_dkim_private_keys \\\n  domain='example' \\\n  key='-----BEGIN%20RSA%20PRIVATE%20KEY-----%0aAAAAB3NzaC1yc2EAAAABIwAAAQEA5kSivOqhs0U9ZMN20nxFe27QZ3t0lT2zbH7OSXylKd%0a1rjAjYXGnSXC9j2uaZlemHlptBKVziMJC86ha7Hcj6dVOVrDQ6vF4q34bOCjtKLphQ0IjB%0azVIvqILH9eLJdRaOrS34CmgmPaisrCk5wKVlakygvUfcj3HzaTKS6THyZDGx5shdTpa9lb%0ay8tpOD3JceV7ay4w8r0DipoKPC0OLpvS4EABEeMo9sx8zQEaKv03XygjNCCYtFvxlQQIRG%0alVoL7mPaHSaL3anI05RpNbm/PS+9BhZg+BqNjU4ofHBbfkXk5MiN6M7ieR4Sk5BquccboG%0aF13U5slNgmCEekdt0amw%0a-----END%20RSA%20PRIVATE%20KEY-----%0a'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/EmailAuth/install_dkim_private_keys?domain=example&key=-----BEGIN%2520RSA%2520PRIVATE%2520KEY-----%250aAAAAB3NzaC1yc2EAAAABIwAAAQEA5kSivOqhs0U9ZMN20nxFe27QZ3t0lT2zbH7OSXylKd%250a1rjAjYXGnSXC9j2uaZlemHlptBKVziMJC86ha7Hcj6dVOVrDQ6vF4q34bOCjtKLphQ0IjB%250azVIvqILH9eLJdRaOrS34CmgmPaisrCk5wKVlakygvUfcj3HzaTKS6THyZDGx5shdTpa9lb%250ay8tpOD3JceV7ay4w8r0DipoKPC0OLpvS4EABEeMo9sx8zQEaKv03XygjNCCYtFvxlQQIRG%250alVoL7mPaHSaL3anI05RpNbm%2fPS%2b9BhZg%2bBqNjU4ofHBbfkXk5MiN6M7ieR4Sk5BquccboG%250aF13U5slNgmCEekdt0amw%250a-----END%2520RSA%2520PRIVATE%2520KEY-----%250a"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file EmailAuth_install_dkim_private_keys.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/EmailAuth_install_dkim_private_keys.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/EmailAuth/,\n    q/install_dkim_private_keys/,\n    {\n        'domain' => 'example',\n        'key' => '-----BEGIN%20RSA%20PRIVATE%20KEY-----%0aAAAAB3NzaC1yc2EAAAABIwAAAQEA5kSivOqhs0U9ZMN20nxFe27QZ3t0lT2zbH7OSXylKd%0a1rjAjYXGnSXC9j2uaZlemHlptBKVziMJC86ha7Hcj6dVOVrDQ6vF4q34bOCjtKLphQ0IjB%0azVIvqILH9eLJdRaOrS34CmgmPaisrCk5wKVlakygvUfcj3HzaTKS6THyZDGx5shdTpa9lb%0ay8tpOD3JceV7ay4w8r0DipoKPC0OLpvS4EABEeMo9sx8zQEaKv03XygjNCCYtFvxlQQIRG%0alVoL7mPaHSaL3anI05RpNbm/PS+9BhZg+BqNjU4ofHBbfkXk5MiN6M7ieR4Sk5BquccboG%0aF13U5slNgmCEekdt0amw%0a-----END%20RSA%20PRIVATE%20KEY-----%0a',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file EmailAuth_install_dkim_private_keys.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/EmailAuth_install_dkim_private_keys.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'EmailAuth',\n    'install_dkim_private_keys',\n    array (\n        'domain' => 'example',\n        'key' => '-----BEGIN%20RSA%20PRIVATE%20KEY-----%0aAAAAB3NzaC1yc2EAAAABIwAAAQEA5kSivOqhs0U9ZMN20nxFe27QZ3t0lT2zbH7OSXylKd%0a1rjAjYXGnSXC9j2uaZlemHlptBKVziMJC86ha7Hcj6dVOVrDQ6vF4q34bOCjtKLphQ0IjB%0azVIvqILH9eLJdRaOrS34CmgmPaisrCk5wKVlakygvUfcj3HzaTKS6THyZDGx5shdTpa9lb%0ay8tpOD3JceV7ay4w8r0DipoKPC0OLpvS4EABEeMo9sx8zQEaKv03XygjNCCYtFvxlQQIRG%0alVoL7mPaHSaL3anI05RpNbm/PS+9BhZg+BqNjU4ofHBbfkXk5MiN6M7ieR4Sk5BquccboG%0aF13U5slNgmCEekdt0amw%0a-----END%20RSA%20PRIVATE%20KEY-----%0a',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 78"}},"/EmailAuth/install_spf_records":{"get":{"description":"This function installs a Sender Policy Framework (SPF) record for a domain on the DNS server.","operationId":"install_spf_records","parameters":[{"description":"The domain for which to install an SPF record on the DNS server.\n\n**Note:**\n\nTo install multiple SPF records, duplicate the parameter name. For example, use the `domain=example.com`, `domain=example2.com`, and `domain=example3.com` parameters.","examples":{"multiple":{"summary":"Multiple domains.","value":"domain=example.com&domain=example2.com&domain=example3.com"},"single":{"summary":"A single domain.","value":"example.com"}},"in":"query","name":"domain","required":true,"schema":{"type":"string"}},{"description":"An SPF record.\n\n**Note:**\n\nYou **must** provide this parameter for each `domain` parameter.","in":"query","name":"record","required":true,"schema":{"example":"\"v=spf1 ip4:10.0.0.1 %2Ba %2Bmx %2Bip4:10.0.0.2 %2Bip4:10.0.0.3 -all\"","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"install_spf_records","type":"string"},"module":{"description":"The name of the module called.","example":"EmailAuth","type":"string"},"result":{"properties":{"data":{"description":"An array of objects that contains information about the domain's SPF record installation to the DNS server.","items":{"properties":{"domain":{"description":"The SPF record's associated domain on the DNS server.","example":"example.com","format":"domain","type":"string"},"msg":{"description":"The SPF record's installation status to the DNS server.","example":"[ADD:TXT@example.com.:v=spf1 ip4:10.0.0.1 %2Ba %2Bmx %2Bip4:10.0.0.2 %2Bip4:10.0.0.3 -all]","type":"string"},"status":{"description":"Whether the system installed the SPF record to the DNS server.\n- `1` - The system installed the SPF record on the DNS server.\n- `0` - The system **cannot** install the SPF record on the DNS server.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success.\n- 0 - Failed. Check the `errors`  field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add domains' SPF records","tags":["EmailAuth","Email DNS Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  EmailAuth \\\n  install_spf_records \\\n  domain='example.com' \\\n  record='\"v=spf1 ip4:10.0.0.1 %2Ba %2Bmx %2Bip4:10.0.0.2 %2Bip4:10.0.0.3 -all\"'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/EmailAuth/install_spf_records?domain=example.com&record=%22v%3dspf1%20ip4%3a10.0.0.1%20%252Ba%20%252Bmx%20%252Bip4%3a10.0.0.2%20%252Bip4%3a10.0.0.3%20-all%22"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file EmailAuth_install_spf_records.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/EmailAuth_install_spf_records.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/EmailAuth/,\n    q/install_spf_records/,\n    {\n        'domain' => 'example.com',\n        'record' => '\"v=spf1 ip4:10.0.0.1 %2Ba %2Bmx %2Bip4:10.0.0.2 %2Bip4:10.0.0.3 -all\"',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file EmailAuth_install_spf_records.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/EmailAuth_install_spf_records.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'EmailAuth',\n    'install_spf_records',\n    array (\n        'domain' => 'example.com',\n        'record' => '\"v=spf1 ip4:10.0.0.1 %2Ba %2Bmx %2Bip4:10.0.0.2 %2Bip4:10.0.0.3 -all\"',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 78"}},"/EmailAuth/validate_current_dkims":{"get":{"description":"This function retrieves and checks the DomainKeys Identified Mail\n(DKIM) records for one or more domains.","operationId":"validate_current_dkims","parameters":[{"description":"The domain for which to check the DKIM records.","examples":{"multiple":{"summary":"Check DKIM records for a multiple domains.","value":"domain=example.com,domain=another.com,domain=yetanother.com\ndomain=example.com,domain-1=another.com,domain-2=yetanother.com"},"single":{"summary":"Check DKIM records for a single domain.","value":"example.com"}},"in":"query","name":"domain","required":true,"schema":{"format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"validate_current_dkims","type":"string"},"module":{"description":"The name of the module called.","example":"EmailAuth","type":"string"},"result":{"properties":{"data":{"description":"An array that contains information about the\ndomain's DKIM records. ","items":{"properties":{"domain":{"description":"The domain that the function used to check\nthe DKIM record. This will be the value of\nthe domain parameter with a `default._domainkey` prefix.","example":"default._domainkey.example.com","format":"domain","type":"string"},"error":{"description":"A message that details the reason why the DNS lookup failed.\n\n**Note:**\n\nThe function only returns this value when the `state` returned\nis the `ERROR` value.","example":"(XID 4krw35) DNS returned SERVFAIL (code 2)\nin response to the systems query for default._domainkey.example2.coms\nTXT records.","type":"string"},"expected":{"description":"The DKIM record's contents.","example":"v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDw5nw4NP1RsWXlfmiMzByDfOT16QCZO\\/xJtrPZKskZF8\\/sU0zWGTqKUOErlyJfoJzMDUv3\\/zzjGswc2nEmYqxxoQZaBkN4QaS6MvJQxysAr+sK8C248\\/r9zMperQdhJedUVejtpFQHJwgqpHy1tQMxY37L7sQjdxmQ5WnQ1acXiwIDAQAB","type":"string"},"records":{"description":"The domain's DNS DKIM TXT records.\n\n**Important:**\n\nThis function may fail to preserve whitespace in DKIM records.","items":{"properties":{"current":{"description":"The domain's DKIM TXT record data contents.\n\n**Important:**\n\n This function may fail to preserve whitespace in DKIM records.","example":"v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDw5nw4NP1RsWXlfmiMzByDfOT16QCZO\\/xJtrPZKskZF8\\/sU0zWGTqKUOErlyJfoJzMDUv3\\/zzjGswc2nEmYqxxoQZaBkN4QaS6MvJQxysAr+sK8C248\\/r9zMperQdhJedUVejtpFQHJwgqpHy1tQMxY37L7sQjdxmQ5WnQ1acXiwIDAQAB","type":"string"},"reason":{"description":"The reason why the DKIM TXT record is not correct, if one exists.\n\n**Note:**\n\nThis function **only** returns this value when the `state` value is `PERMFAIL`.","example":"example.com: The DKIM version must be \"DKIM1\".","type":"string"},"state":{"description":"The DKIM TXT record's status:\n* `VALID` - The DKIM TXT record matches the local server's public key.\n* `MISMATCH` - The DKIM TXT record does not match the local server's public key.\n* `PERMFAIL` - Multiple DKIM TXT records for the domain exist or a misconfigured DKIM TXT record exists.","enum":["VALID","MISMATCH","PERMFAIL"],"example":"VALID","type":"string"}},"type":"object"},"type":"array"},"state":{"description":"The domain's DKIM record status.\nPossible values:\n\n* `VALID` The DKIM record is valid.\n* `MALFORMED` A single DKIM record exists, but the record does not match the expected DKIM specifications.\n* `MISMATCH` A DKIM record exists, but it does not match the expected public key.\n* `MISSING` No DKIM record exists for the domain.\n* `MULTIPLE` Multiple DKIM records exist.\n* `NOPUB` No key exists on the local server for the domain.\n* `ERROR` The record's DNS lookup failed. The function returns the reason in the error return.","enum":["VALID","MALFORMED","MISMATCH","MISSING","MULTIPLE","NOPUB","ERROR"],"example":"VALID","type":"string"},"validity_cache_update":{"description":"The result of the DKIM record's validity cache update operation:\n* `set` The domain is invalid but passed its validity check. The validity check now passes the domain as valid.\n* `unset` The domain is invalid and did not pass its validity check. The validity check does not pass the domain as valid.\n* `valid` The domain is valid and passed its validity check. There are no changes required.\n* `invalid` The domain is invalid and failed its validity check. There are no changes required.\n* `none` The domain is invalid, but the system will not take further action.\n* `error` The domain's validity check operation failed.","enum":["set","unset","valid","invalid","none","error"],"example":"valid","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` - Success.\n- `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Validate domains' DKIM records","tags":["EmailAuth","Email DNS Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  EmailAuth \\\n  validate_current_dkims \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/EmailAuth/validate_current_dkims?domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file EmailAuth_validate_current_dkims.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/EmailAuth_validate_current_dkims.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/EmailAuth/,\n    q/validate_current_dkims/,\n    {\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file EmailAuth_validate_current_dkims.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/EmailAuth_validate_current_dkims.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'EmailAuth',\n    'validate_current_dkims',\n    array (\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 78"}},"/EmailAuth/validate_current_ptrs":{"get":{"description":"This function validates the pointer records (PTR) for IPv4 and\nIPv6 addresses that the account's domains send mail from. It retrieves the\nPTR records for each IP address and determines which of the domain's IP addresses\nsend mail. It then validates the PTR records for each IP address and validates\nthe A or AAAA records pointing to each domain. This function also ensures\nthat at least one of that domain's A or AAAA records points back to the IP\naddress.","operationId":"validate_current_ptrs","parameters":[{"description":"The domain for which to validate the PTR records.","examples":{"multiple":{"summary":"Check PTR records for a multiple domains.","value":"`domain`=example.com,`domain`=another.com,`domain`=yetanother.com\n`domain`=example.com,`domain-1`=another.com,`domain-2`=yetanother.com"},"single":{"summary":"Check PTR records for a single domain.","value":"example.com"}},"in":"query","name":"domain","required":true,"schema":{"format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"validate_current_ptrs","type":"string"},"module":{"description":"The name of the module called.","example":"EmailAuth","type":"string"},"result":{"properties":{"data":{"description":"An array that contains information about the account's PTR records.","items":{"properties":{"arpa_domain":{"description":"The IP address used to perform a reverse DNS (rDNS) lookup.\nFor more information about rDNS, read our\n[How to Configure Reverse DNS for BIND in WHM](https://go.cpanel.net/HowtoConfigureReverseDNSforBINDinWHM)\ndocumentation.\nA valid reversed IP address appended with one of the following:\n* in-addr.arpa - An IPv4 address.\n* ip6.arpa - An IPv6 address.\n\nFor information about .arpa domains, read Wikipedia's\n[Reverse DNS lookup](https://en.wikipedia.org/wiki/Reverse_DNS_lookup)\narticle.\n\n**Note:**\n\nThe function does not return this value for a domain with an invalid IP address.","example":"1.0.0.10.in-addr.arpa","type":"string"},"domain":{"description":"The queried domain.","example":"example.com","format":"domain","type":"string"},"error":{"description":"A mmessage that details the reason why the domain's IP address validation failed.\n\n**Note:**\n\nThe function only returns this value when the `state` returned is\nthe `ERROR` value.","example":"1.1.1.1.1 is not a valid IP address.","type":"string"},"helo":{"description":"The hostname that the domain uses to identify\nitself to remote SMTP servers. A valid hostname.","example":"example.com","format":"domain","type":"string"},"ip_address":{"description":"The IP address.\n\n**Note:**\n\nThe function does **not** return this value for a domain with an invalid IP address.","example":"10.0.0.1","type":"string"},"ip_version":{"description":"The IP version number.\n* 4\n* 6\n\n**Note:**\n\nThe function does **not** return this value for a domain with an invalid IP address.","enum":[4,6],"example":4,"type":"integer"},"nameservers":{"description":"The authoritative nameservers for the domain's PTR record.","items":{"example":"ns1.example.com","format":"domain","type":"string"},"type":"array"},"ptr_records":{"description":"The domain's PTR records.\n\n**Note:**\n\nThe function does **not** return this for a domain with an invalid IP address.","items":{"properties":{"domain":{"description":"The fully-qualified domain name (FQDN)\nthat a PTR record points to.","example":"example.com","format":"domain","type":"string"},"forward_records":{"description":"A list of IP addresses that the domain\nresolves to for A (IPv4) and AAAA (IPv6) records.","items":{"example":"10.0.0.1","type":"string"},"type":"array"},"state":{"description":"The state of the domain's PTR record.\n* `VALID` - The PTR record is valid.\n* `MISSING_FWD` - The PTR points to a domain without an A or AAAA record.\n* `FWD_MISMATCH` - The PTR record points to a domain without an A or AAAA record that points back to the IP address.","enum":["VALID","MISSING_FWD","FWD_MISMATCH"],"example":"VALID","type":"string"}},"type":"object"},"type":"array"},"state":{"description":"Whether the PTR records are valid for the domain.\n* `ERROR` - The domain's IP address is invalid. The function returns the reason in the error return.\n* `IP_IS_PRIVATE` - The IP address exists within a range of private IP addresses.\n* `VALID` - The PTR record is valid.\n* `MISSING_PTR` - No PTR records exist for the IP address.\n* `PTR_MISMATCH` - One or more PTR records point to a domain that does not point back to the correct IP address.\n\n**Note:**\n\n* DNS does not define PTR records for private IP addresses.\n* The function only returns a VALID response if all of an IP address's PTR records are valid.","enum":["ERROR","IP_IS_PRIVATE","VALID","MISSING_PTR","PTR_MISMATCH"],"example":"VALID","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` - Success.\n- `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Validate domains' PTR records","tags":["EmailAuth","Email DNS Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  EmailAuth \\\n  validate_current_ptrs \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/EmailAuth/validate_current_ptrs?domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file EmailAuth_validate_current_ptrs.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/EmailAuth_validate_current_ptrs.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/EmailAuth/,\n    q/validate_current_ptrs/,\n    {\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file EmailAuth_validate_current_ptrs.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/EmailAuth_validate_current_ptrs.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'EmailAuth',\n    'validate_current_ptrs',\n    array (\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 78"}},"/EmailAuth/disable_dkim":{"get":{"description":"This function removes the DomainKeys Identified Mail (DKIM) records on the DNS server for one or more domains.","operationId":"disable_dkim","parameters":[{"description":"The domain for which to remove DKIM records on the DNS server.\n\n**Note:**\n\nTo remove multiple domain DKIM records, duplicate the parameter name. For example, use the `domain=example.com`, `domain=example2.com`, and `domain=example3.com` parameters.","examples":{"multiple":{"summary":"Multiple domains.","value":"domain=example.com&domain=example2.com&domain=example.com"},"single":{"summary":"A single domain.","value":"example.com"}},"in":"query","name":"domain","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"disable_dkim","type":"string"},"module":{"description":"The name of the module called.","example":"EmailAuth","type":"string"},"result":{"properties":{"data":{"description":"An array of objects that contain information about the removal of a domain's DKIM record on the DNS server.","items":{"properties":{"domain":{"description":"The domain for which the system removed the DKIM record.","example":"example.com","format":"domain","type":"string"},"msg":{"description":"Information about the removed DKIM record.","example":"[REMOVE:TXT@default._domainkey:v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiLMNOpQDw5nw4NP1RsWXlfmiMzByDfOT16QCZO/xJtrPZKskZF8/sU0zWGTqKUOErlyJfoJzMDUv3/zzjGswc2nEmYqxxoQZaBkN4QaS6MvJQxysAr+sK8C248/r9zMperQdhJedUVejtpFQHJwgqpHy1tQMxY37L7sQjdxmQ5WnQ1acXiwIDAQAB\\;]","type":"string"},"status":{"description":"Whether the system removed the domain's DKIM record on the DNS server.\n* `1` - The system removed the domain's DKIM record.\n* `0` - The system did **not** remove the domain's DKIM record.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove domains' DKIM records","tags":["EmailAuth","Email DNS Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  EmailAuth \\\n  disable_dkim \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/EmailAuth/disable_dkim?domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file EmailAuth_disable_dkim.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/EmailAuth_disable_dkim.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/EmailAuth/,\n    q/disable_dkim/,\n    {\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file EmailAuth_disable_dkim.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/EmailAuth_disable_dkim.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'EmailAuth',\n    'disable_dkim',\n    array (\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 78"}},"/EmailAuth/validate_current_spfs":{"get":{"description":"This function retrieves the the Sender Policy Framework (SPF) records\nfor one or more domains.","operationId":"validate_current_spfs","parameters":[{"description":"The domain for which to check the `SPF` records.","examples":{"multiple":{"summary":"Check `SPF` records for a multiple domains.","value":"`domain`=example.com,`domain`=another.com,`domain`=yetanother.com\n`domain`=example.com,`domain-1`=another.com,`domain-2`=yetanother.com"},"single":{"summary":"Check `SPF` records for a single domain.","value":"example.com"}},"in":"query","name":"domain","required":true,"schema":{"format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"validate_current_spfs","type":"string"},"module":{"description":"The name of the module called.","example":"EmailAuth","type":"string"},"result":{"properties":{"data":{"description":"A list of information about a domain's SPF records.","items":{"properties":{"domain":{"description":"The queried domain.","example":"example.com","format":"domain","type":"string"},"error":{"description":"A message that details the reason why the DNS lookup failed.\n\n**Note:**\n\n The function **only** returns this value when the `state` return is the `ERROR` value.","example":"(XID rm8h9f) DNS returned SERVFAIL (code 2)\nin response to the systems query for example2.coms\nTXT records.","type":"string"},"expected":{"description":"The SPF record for the domain in the DNS.","example":"ip6:0:0:0:0:0:ffff:c0a8:101","type":"string"},"ip_address":{"description":"The domain's IP address.","example":"0:0:0:0:0:ffff:c0a8:101","type":"string"},"ip_version":{"description":"The IP address version.\n* `4`\n* `6`","enum":[4,6],"example":6,"type":"integer"},"records":{"description":"The SPF records of the domain's DNS.","items":{"properties":{"current":{"description":"The SPF record's contents.","example":"v=spf1 +a +mx ip6:0:0:0:0:0:ffff:c0a8:101 ~all","type":"string"},"reason":{"description":"The reason why the SPF record is **not** correct, if one exists.\n\n**Note:**\n\nIf no errors exist, the function does **not** return this value.","example":"'example.com: Sender\nis not authorized by default to use ''example.com''\nin ''helo'' identity, however domain is not\ncurrently prepared for false failures (mechanism\n''~all'' matched)'","type":"string"},"state":{"description":"The SPF record's status:\n* `PASS` - The `SPF` record confirms that the `ip_address` value is a valid sender.\n* `NEUTRAL` - The current `SPF` record configuration does not determine the `ip_address` value's validity.\n* `FAIL` - The `SPF` record states that the `ip_address` value is **not** a valid sender.\n* `SOFTFAIL` - The `SPF` record states that the `ip_address` value is **not** a valid sender, but does not `FAIL` state it.\n* `TEMPERROR` - The `SPF` record check resulted in a failure. For example, a network failure.\n* `PERMERROR` - The domain's `SPF` records are **incorrect** and require manual correction.\n\n**Note:**\n\nThese values correspond with [RFC7208 section 2.6](https://tools.ietf.org/html/rfc7208#section-2.6).","enum":["PASS","NEUTRAL","FAIL","SOFTFAIL","TEMPERROR","PERMERROR"],"example":"PASS","type":"string"}},"type":"object"},"type":"array"},"state":{"description":"The SPF record's status:\n* `VALID` - A single `SPF TXT` record exists in the domain's DNS with the correct `ip_address` value or redirect mechanism.\n* `MISMATCHED` - An `SPF TXT` record exists for the domain that does **not** match the `ip_address` value.\n* `MULTIPLE` - Multiple `SPF TXT` records exist in the domain's DNS.\n* `MISSING` - No `SPF TXT` record exists for the domain's DNS.\n* `ERROR` - The record's DNS lookup failed. The function returns the reason in the error return.","enum":["VALID","MISMATCHED","MULTIPLE","MISSING","ERROR"],"example":"VALID","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` - Success.\n- `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Validate domains' SPF records","tags":["EmailAuth","Email DNS Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  EmailAuth \\\n  validate_current_spfs \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/EmailAuth/validate_current_spfs?domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file EmailAuth_validate_current_spfs.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/EmailAuth_validate_current_spfs.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/EmailAuth/,\n    q/validate_current_spfs/,\n    {\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file EmailAuth_validate_current_spfs.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/EmailAuth_validate_current_spfs.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'EmailAuth',\n    'validate_current_spfs',\n    array (\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 78"}},"/ExternalAuthentication/add_authn_link":{"get":{"description":"This function adds an External Authentication authorization link to an account.","operationId":"add_authn_link","parameters":[{"description":"The username.","in":"query","name":"username","required":true,"schema":{"example":"example","format":"username","type":"string"}},{"description":"The name of the identity provider.","in":"query","name":"provider_id","required":true,"schema":{"example":"google","type":"string"}},{"description":"The unique identifier for the user at the identity provider.","in":"query","name":"subject_unique_identifier","required":true,"schema":{"example":"123456789012345678901","type":"string"}},{"description":"The preferred username of the account on the identity provider.","in":"query","name":"preferred_username","required":true,"schema":{"example":"Example","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"add_authn_link","type":"string"},"module":{"description":"The name of the module called.","example":"ExternalAuthentication","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` - Success\n- `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add external authentication link","tags":["ExternalAuthentication","External Authentication"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  ExternalAuthentication \\\n  add_authn_link \\\n  username='example' \\\n  provider_id='google' \\\n  subject_unique_identifier='123456789012345678901' \\\n  preferred_username='Example'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/ExternalAuthentication/add_authn_link?username=example&provider_id=google&subject_unique_identifier=123456789012345678901&preferred_username=Example"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file ExternalAuthentication_add_authn_link.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/ExternalAuthentication_add_authn_link.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/ExternalAuthentication/,\n    q/add_authn_link/,\n    {\n        'username' => 'example',\n        'provider_id' => 'google',\n        'subject_unique_identifier' => '123456789012345678901',\n        'preferred_username' => 'Example',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file ExternalAuthentication_add_authn_link.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/ExternalAuthentication_add_authn_link.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'ExternalAuthentication',\n    'add_authn_link',\n    array (\n        'username' => 'example',\n        'provider_id' => 'google',\n        'subject_unique_identifier' => '123456789012345678901',\n        'preferred_username' => 'Example',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 56"}},"/ExternalAuthentication/configured_modules":{"get":{"description":"This function lists the display information for your server's available and configured external authentication identity provider modules.","operationId":"configured_modules","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"configured_modules","type":"string"},"module":{"description":"The name of the module called.","example":"ExternalAuthentication","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"color":{"description":"The background color of the button on the cPanel interface.","example":"00aef0","format":"RGB","type":"string"},"display_name":{"description":"The identity provider's friendly name. cPanel & WHM interfaces will display this value.","example":"cPanel ID","type":"string"},"documentation_url":{"description":"The public URL of the identity provider's implementation documentation.","example":"https://go.cpanel.net/OpenIDConnect","format":"url","type":"string"},"icon":{"description":"The icon file to display on the button in the cPanel login interface.","example":"iVBORw0KGgoAAAANSUhEUgAAACMAAAAhCAYAAABTERJSAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDoxMTNFRUVGMzIyODUxMUU1OUM1RERGODcwRjIwNTQ4MCIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDoxMTNFRUVGNDIyODUxMUU1OUM1RERGODcwRjIwNTQ4MCI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOjExM0VFRUYxMjI4NTExRTU5QzVEREY4NzBGMjA1NDgwIiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOjExM0VFRUYyMjI4NTExRTU5QzVEREY4NzBGMjA1NDgwIi8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+oa0v2AAAA3VJREFUeNrsWM1uFEcQruqent3Z9Y43DmuD2YT1LoIICSIgEULKC+SaF8gr5JAnyD3XKCcChxxyyhNYiFMU5ZRTzE8UuGCQY8DGeGd3Zqrydc/ajiWjBHCEpWxLPf1T01VfV/d09TesqnRUUuQfN+5tUzMylAsRM9EOPlTJV0V9qWQg3BgLXek4+mUtpxKy+bqhAvIcLxVSlT4FHVAQITegO7Z8vGFpqeW4P+N40Iy434rNR23Hcd3ymV0wL00TNIJH6UsY2syVsrICuTlWGFJyAJlYrtVj7jUi9gZhzPQSS4tJRO+1nF1C/aThoHFfgp7n+zzjZ+GNjUWDB7yHRPYAQQnV8MCMOu04ughvPEbzztV599UHbXvOGe7OwHhsKH3jZdrKiZwhgrtcYs0ilJ6A4ffhytMpZtmAa/3s4OYuQFhg/m75IX1xtm2/XKjbw90zn3Zr19+p81W4dr5mqP0vxslkOx3+Bu6n9jOsROttf02GjlCagpmCmYI5VDD8GuP0tYYdHP72HXq3N4prTcfHEA6ev8ir2OSjLwK0jkvRoRAjNmlkFG1aGAktPxrK6NZq/o3lwh1POPtkIQ4ncqm7Y2lcqua4o4zKKr4h66ggLrSSo2zinfUrnXgPzM9r+c0P51wySE22NhTBNUEQnVGqbuZSrm6LXJhzMkit/JmVdfT/vl1QcXej+H4r91cLyrtNW/ZmrG4AydORytMRyrHXpfJgq5TL70Zy+Vgs97JCnwS5yhOgRD3fAUP+coW8qa+Q4Kxr3/72Il0dFqEtPsuubLctupdflqSyHXBEkzvFq26AfYGS/7b4hg/YDNNPewpmCuZ/DwYn5I/rI7mLY/7ZW2eUy6ujz/0ZBZoSz8a8CB50ohkRqIo57QkZiNhS6mw/qaiKwYHmySXzfwGmorZKw1LGOjb3s7K8r8o/CRXhIPXZU9Sa5Q441aVByz5CoMtXnpVfyyydQ4DtQt4DzXkjhsE+JvzwRxZ4smeToKehHpgtVzxbAuPUwDwR2Oj8XES/rueB5nbqDJCeBJo6xvZmQG8bEQ1mY3Mqifgk+jzb9H3dgzzp6S3603/m2hOv+OwmRDnFTQHLFdaphWAL8h68mpWSbRW08lBoxf8I8IQfohCrEu9VLD1Yqmel/TQOSz5oxfzxrDN2h5TyUfolcqQ+7b8EGACd0Ob6pUnq9QAAAABJRU5ErkJggg==","format":"base64 image","type":"string"},"icon_type":{"description":"The icon file's MIME type.","example":"image/svg+xml","format":"MIME","type":"string"},"label":{"description":"The text label of the login icon in the cPanel login interface.","example":"Log in with a cPanel ID Account","type":"string"},"link":{"description":"link to the identity provider's configuration for the appropriate service on the system.","example":"https://hostname.example.com:2083/openid_connect/cpanelid","format":"url","type":"string"},"provider_name":{"description":"The identity provider's system name.","example":"cpanelid","type":"string"},"textcolor":{"description":"The color of the text label in the cPanel login interface.","example":"FFFFFF","format":"RGB","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` - Success\n- `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return server's external authentication providers","tags":["ExternalAuthentication","External Authentication"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  ExternalAuthentication \\\n  configured_modules\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/ExternalAuthentication/configured_modules"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file ExternalAuthentication_configured_modules.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/ExternalAuthentication_configured_modules.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/ExternalAuthentication/,\n    q/configured_modules/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file ExternalAuthentication_configured_modules.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/ExternalAuthentication_configured_modules.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'ExternalAuthentication',\n    'configured_modules'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/ExternalAuthentication/has_external_auth_modules_configured":{"get":{"description":"This function determines whether the user enabled external authentication modules.","operationId":"has_external_auth_modules_configured","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"has_external_auth_modules_configured","type":"string"},"module":{"description":"The name of the module called.","example":"ExternalAuthentication","type":"string"},"result":{"properties":{"data":{"description":"Whether the cPanel user enabled any external modules.\n\n* `1` - Enabled.\n* `0` - **Not** enabled.\n\n**Note:**\n\nFor more information, read our [Password and Security](https://go.cpanel.net/cpaneldocsPasswordoutputampSecurity) and [External Authentication](https://go.cpanel.net/externalauth) FAQ documentation.","enum":[0,1],"example":1,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return external authentication user status","tags":["ExternalAuthentication","External Authentication"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  ExternalAuthentication \\\n  has_external_auth_modules_configured\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/ExternalAuthentication/has_external_auth_modules_configured"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file ExternalAuthentication_has_external_auth_modules_configured.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/ExternalAuthentication_has_external_auth_modules_configured.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/ExternalAuthentication/,\n    q/has_external_auth_modules_configured/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file ExternalAuthentication_has_external_auth_modules_configured.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/ExternalAuthentication_has_external_auth_modules_configured.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'ExternalAuthentication',\n    'has_external_auth_modules_configured'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 66"}},"/DNS/ensure_domains_reside_only_locally":{"get":{"description":"This function indicates whether the account's domains resolve exclusively to this server.","operationId":"ensure_domains_reside_only_locally","parameters":[{"description":"The domain to check.\n\n**Note:**\n\nTo check multiple domains, duplicate or increment the parameter name. For example, to exclude three domains, you could:\n* Use the `domain` parameter multiple times.\n* Use the `domain`, `domain-1`, and `domain-2` parameters.","examples":{"multiple":{"summary":"Multiple domains","value":"domain=example.com&domain-1=example1.com&domain-2=example2.com"},"multiple-alternative":{"summary":"Multiple domains","value":"domain=example.com&domain=example1.com&domain=example2.com"},"single":{"summary":"A single domain.","value":"example.com"}},"in":"query","name":"domain","required":true,"schema":{"example":"example1.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"ensure_domains_reside_only_locally","type":"string"},"module":{"description":"The name of the module called.","example":"DNS","type":"string"},"result":{"properties":{"data":{"description":"The results from each domain parameter's DNS query.\n* `null` - The domain **only** resolves locally to the server.\n* A valid string that explains to where the domain resolves.\n\n**Note:**\n\n The function returns the results from the domains in the same order that you called them.","items":{"example":"The domain resolves to Mars. Beep beep beep.","type":"string"},"nullable":true,"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return whether domains only resolve locally","tags":["DNS","DNS Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DNS \\\n  ensure_domains_reside_only_locally \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DNS/ensure_domains_reside_only_locally?domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DNS_ensure_domains_reside_only_locally.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DNS_ensure_domains_reside_only_locally.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DNS/,\n    q/ensure_domains_reside_only_locally/,\n    {\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DNS_ensure_domains_reside_only_locally.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DNS_ensure_domains_reside_only_locally.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DNS',\n    'ensure_domains_reside_only_locally',\n    array (\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 56"}},"/ExternalAuthentication/remove_authn_link":{"get":{"description":"This function removes a link to an account at an external authentication identity provider.","operationId":"remove_authn_link","parameters":[{"description":"The name of the identity provider.","in":"query","name":"provider","required":true,"schema":{"example":"cpanelid","type":"string"}},{"description":"The unique identifier for the user at the identity provider.","in":"query","name":"subject_unique_identifier","required":true,"schema":{"example":"123456789012345678901","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"remove_authn_link","type":"string"},"module":{"description":"The name of the module called.","example":"ExternalAuthentication","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove external authentication link","tags":["ExternalAuthentication","External Authentication"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  ExternalAuthentication \\\n  remove_authn_link \\\n  provider='cpanelid' \\\n  subject_unique_identifier='123456789012345678901'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/ExternalAuthentication/remove_authn_link?provider=cpanelid&subject_unique_identifier=123456789012345678901"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file ExternalAuthentication_remove_authn_link.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/ExternalAuthentication_remove_authn_link.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/ExternalAuthentication/,\n    q/remove_authn_link/,\n    {\n        'provider' => 'cpanelid',\n        'subject_unique_identifier' => '123456789012345678901',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file ExternalAuthentication_remove_authn_link.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/ExternalAuthentication_remove_authn_link.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'ExternalAuthentication',\n    'remove_authn_link',\n    array (\n        'provider' => 'cpanelid',\n        'subject_unique_identifier' => '123456789012345678901',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/Features/has_feature":{"get":{"description":"This function checks whether a cPanel account has access to\na [feature](https://go.cpanel.net/whmdocsFeatureManager#selectable-features).","operationId":"has_feature","parameters":[{"description":"The feature's name.","in":"query","name":"name","required":true,"schema":{"example":"autossl","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"does-not-have-feature":{"summary":"The account does not have a feature.","value":{"result":{"data":null,"errors":null,"messages":null,"metadata":{},"status":0,"warnings":null}}},"exists-but-acct-does-not-have":{"summary":"The feature exists but the account does not have it enabled.","value":{"result":{"data":null,"errors":null,"messages":["The feature “autossl” exists but is not enabled."],"metadata":{},"status":0,"warnings":null}}},"has-feature":{"summary":"The account has a feature.","value":{"result":{"data":null,"errors":null,"messages":null,"metadata":{},"status":1,"warnings":null}}}},"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"has_feature","type":"string"},"module":{"description":"The name of the module called.","example":"Features","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"A message about the feature's status.\n\n**Note:**\n\nThe function only returns a message when the feature exists but\nit is **not** enabled.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"Whether the feature exists on the system.\n\n* `1` — The feature exists on the system and it is enabled.\n* `0` — The feature exists on the system, but the user does **not** have it.\n* `null` — The feature is **not** installed on the system.","enum":[0,1],"example":1,"nullable":true,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}}}}},"description":"HTTP Request was successful."}},"summary":"Validate cPanel account's feature access","tags":["Features","cPanel Features"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Features \\\n  has_feature \\\n  name='autossl'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Features/has_feature?name=autossl"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Features_has_feature.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Features_has_feature.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Features/,\n    q/has_feature/,\n    {\n        'name' => 'autossl',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Features_has_feature.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Features_has_feature.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Features',\n    'has_feature',\n    array (\n        'name' => 'autossl',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Features/list_features":{"get":{"description":"This function lists a cPanel account's features.","operationId":"list_features","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_features","type":"string"},"module":{"description":"The name of the module called.","example":"Features","type":"string"},"result":{"properties":{"data":{"additionalProperties":{"description":"Whether the feature is installed.\n* `1` - Installed.\n* `0` - **Not** installed.","enum":[0,1],"example":0,"type":"integer"},"description":"Features available to the account. The key is a feature name and the value\nis whether the feature is installed.\n\n**Note:**\n\nThis function returns features that third-party software or plugins provide.","example":{"bbs":0,"blockers":1,"boxtrapper":1,"changemx":1,"chat":0,"defaultaddress":1,"email_disk_usage":1,"emailarchive":1,"emailauth":1,"emaildomainfwd":1,"emailtrace":1,"popaccts":1,"spamassassin":1,"spambox":1,"traceaddy":1,"updatecontact":1,"webmail":1},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel account's features","tags":["Features","cPanel Features"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Features \\\n  list_features\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Features/list_features"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Features_list_features.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Features_list_features.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Features/,\n    q/list_features/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Features_list_features.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Features_list_features.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Features',\n    'list_features'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Features/get_feature_metadata":{"get":{"description":"This function lists the details of a cPanel account's available feature lists.","operationId":"get_feature_metadata","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_feature_metadata","type":"string"},"module":{"description":"The name of the module called.","example":"Features","type":"string"},"result":{"properties":{"data":{"description":"An array of objects containing feature information.","items":{"properties":{"id":{"description":"The feature's system ID.","example":"wordpress_manager","type":"string"},"is_cpaddon":{"description":"Whether the feature is a [cPAddon](https://go.cpanel.net/cPanelGlossary#addons-cpaddons).\n\n* `1` — cPAddon.\n* `0` — **Not** a cPAddon.","enum":[1,0],"example":0,"type":"integer"},"is_plugin":{"description":"Whether the feature is a [plugin](https://go.cpanel.net/cpanelplugin).\n\n* `1` — Plugin.\n* `0` — **Not** a plugin.","enum":[1,0],"example":1,"type":"integer"},"name":{"description":"The feature's name.","example":"Wordpress Manager","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel account's features' metadata","tags":["Features","cPanel Features"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Features \\\n  get_feature_metadata\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Features/get_feature_metadata"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Features_get_feature_metadata.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Features_get_feature_metadata.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Features/,\n    q/get_feature_metadata/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Features_get_feature_metadata.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Features_get_feature_metadata.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Features',\n    'get_feature_metadata'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 80"}},"/Fileman/autocompletedir":{"get":{"description":"This function returns any files and directories that begin with a specified string.\n\n**Important:**\n\n  When you disable the [File Storage role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"autocompletedir","parameters":[{"description":"The prefix of the paths to complete.","in":"query","name":"path","required":true,"schema":{"example":"public","type":"string"}},{"description":"Whether to include only directories in the output.\n* `1` — **Only** include directories.\n* `0` — Include directories **and** files.","in":"query","name":"dirsonly","required":false,"schema":{"default":0,"enum":[1,0],"type":"integer"}},{"description":"Whether to return all files and directories inside the specified\ndirectory. If you set this parameter's value to `1`, you **must** set the `path`\nparameter's value to a full directory path.\n* `1` — Return **all** files and directories inside the specified directory.\n* `0` — Return partial file and directory name matches.","in":"query","name":"list_all","required":false,"schema":{"default":1,"enum":[1,0],"type":"integer"}},{"description":"Whether to return HTML-encoded results.\n* `1` — Return HTML-encoded output.\n* `0` — Return plaintext output.","in":"query","name":"html","required":false,"schema":{"default":1,"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"autocompletedir","type":"string"},"module":{"description":"The name of the module called.","example":"Fileman","type":"string"},"result":{"properties":{"data":{"description":"An array of objects containing the files and directories that match the specified path.","items":{"properties":{"file":{"description":"A file or directory that matches the specified path.","example":"public_ftp","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- `1` — Success.\n- `0` — Failed. Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return autocomplete file and directory names","tags":["Fileman","Manage Files"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Fileman \\\n  autocompletedir \\\n  path='public'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Fileman/autocompletedir?path=public"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Fileman_autocompletedir.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Fileman_autocompletedir.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Fileman/,\n    q/autocompletedir/,\n    {\n        'path' => 'public',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Fileman_autocompletedir.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Fileman_autocompletedir.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Fileman',\n    'autocompletedir',\n    array (\n        'path' => 'public',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/Fileman/empty_trash":{"get":{"description":"This function purges content from the `.trash` folder in the user's home directory.\n\n**Important:**\n\n  When you disable the [FileStorage role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.","operationId":"empty_trash","parameters":[{"description":"The maximum age in days of content that the function will not purge.\n\n**Note:**\n\nA value of `0` will purge everything from the user's `.trash` folder.","in":"query","name":"older_than","required":false,"schema":{"default":0,"example":31,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"empty_trash","type":"string"},"module":{"description":"The name of the module called.","example":"Fileman","type":"string"},"result":{"properties":{"data":{"example":null,"nullable":true,"properties":{},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* 1 — Success.\n* 0 — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete .trash folder content","tags":["Fileman","Manage Files"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Fileman \\\n  empty_trash\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Fileman/empty_trash"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Fileman_empty_trash.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Fileman_empty_trash.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Fileman/,\n    q/empty_trash/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Fileman_empty_trash.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Fileman_empty_trash.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Fileman',\n    'empty_trash'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 60"}},"/Fileman/get_file_content":{"get":{"description":"This function retrieves a file's content.\n\n**Important:**\n\nWhen you disable the [File Storage](https://go.cpanel.net/serverroles) role, the system **disables** this function.\n\n**Note:**\n\nJSON strings **must** be valid UTF-8. To retrieve a non-UTF-8 file via\nJSON, we recommend that you give `ISO-8859-1` as `from_charset` and\n`UTF-8` as `to_charset`, then decode the return payload’s `content`\nas UTF-8.","operationId":"get_file_content","parameters":[{"description":"The file path to the directory that contains the selected file.","in":"query","name":"dir","required":true,"schema":{"example":"/home/user/public.html","format":"path","type":"string"}},{"description":"The file to retrieve.","in":"query","name":"file","required":true,"schema":{"example":"example.html","type":"string"}},{"description":"The file’s character encoding. This parameter defaults to `_DETECT_`, which indicates a request to detect the file’s character encoding.","in":"query","name":"from_charset","required":false,"schema":{"default":"_DETECT_","example":"_DETECT_","type":"string"}},{"description":"The output character encoding. This parameter defaults to `_LOCALE_`, which indicates a request to use the session locale’s character encoding.\n\n**Important:**\n\nContexts that serialize the API response as JSON **require**\nthis value to be `utf-8` or `US-ASCII`. Behavior is **undefined**\nif the request indicates any other encoding.","in":"query","name":"to_charset","required":false,"schema":{"default":"_LOCALE_","example":"_LOCALE_","type":"string"}},{"description":"Whether to update the file's HTML document encoding.\n\n* `1` — Update the file's HTML document encoding.\n* `0` — Don't update the file's HTML encoding.","in":"query","name":"update_html_document_encoding","required":false,"schema":{"default":1,"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_file_content","type":"string"},"module":{"description":"The name of the module called.","example":"Fileman","type":"string"},"result":{"properties":{"data":{"properties":{"content":{"description":"The file's contents. A string value.\n\n**Note:**\n\nBehavior is **undefined** if the calling context\nrequires an encoding that conflicts with\nthe file contents. For example, if the file\ncontents are ISO-8859-1 but the context requires\nUTF-8 (as is the case with JSON), the system may\napply an extra layer of UTF-8 encoding in order\nto satisfy the request.","example":"`hi`","format":"binary","type":"string"},"dir":{"description":"The absolute path to the directory that contains the selected file.","example":"/home/user/public_html","format":"path","type":"string"},"filename":{"description":"The file's name.","example":"example.html","type":"string"},"from_char":{"description":"The file's previous character encoding. If the request’s `from_charset` was `_DETECT_`, this will contain the detected encoding. Otherwise, it will contain the request’s `from_charset` value.","example":"UTF-8","type":"string"},"from_charset":{},"path":{"description":"The absolute path to the file.","example":"/home/user/public_html/example.html","format":"path","type":"string"},"to_char":{"description":"The file's new character encoding. If the request’s `from_charset` was `_LOCALE_`, this will contain the locale’s encoding. Otherwise, it will contain the request’s `to_charset` value.","example":"UTF-8","type":"string"},"to_charset":{}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return file content","tags":["Fileman","Manage Files"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Fileman \\\n  get_file_content \\\n  dir='/home/user/public_html' \\\n  file='example.html'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Fileman/get_file_content?dir=%2fhome%2fuser%2fpublic.html&file=example.html"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Fileman_get_file_content.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Fileman_get_file_content.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Fileman/,\n    q/get_file_content/,\n    {\n        'dir' => '/home/user/public.html',\n        'file' => 'example.html',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Fileman_get_file_content.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Fileman_get_file_content.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Fileman',\n    'get_file_content',\n    array (\n        'dir' => '/home/user/public.html',\n        'file' => 'example.html',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.44"}},"/Fileman/get_file_information":{"get":{"description":"This function returns the information for a specified file or directory.\n\n**Important:**\n\nWhen you disable the [File Storage](https://go.cpanel.net/serverroles) role, the system **disables** this function.","operationId":"get_file_information","parameters":[{"description":"The directory from which to list files.","in":"query","name":"path","required":true,"schema":{"example":"public_html","format":"path","type":"string"}},{"description":"Whether to include hidden files in the output.\n\n* `1` - Include hidden files.\n* `0` - Do **not** include hidden files.","in":"query","name":"show_hidden","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to flag directories that contain subdirectories.\n\n* `1` - Flag directories that contain subdirectories.\n* `0` - Do **not** flag directories that contain subdirectories.","in":"query","name":"check_for_leaf_directories","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to return the file's MIME type.\n\n* `1` - Return the file's MIME type.\n* `0` - Do **not** return the file's MIME type.","in":"query","name":"include_mime","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to parse the file owner's read and write permissions.\n\n* `1` - Parse the file owner's read and write permissions.\n* `0` - Do **not** parse the file owner's read and write permissions.","in":"query","name":"include_permissions","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_file_information","type":"string"},"module":{"description":"The name of the module called.","example":"Fileman","type":"string"},"result":{"properties":{"data":{"properties":{"absdir":{"description":"The path to the user's home directory.","example":"/home/user","format":"path","type":"string"},"ctime":{"description":"The file's creation time, Unix time format.","example":1400573272,"format":"unix_timestamp","type":"integer"},"exists":{"description":"Whether the file exists in the directory.\n* `1` - Exists.\n* `0` - Does **not** exist.","enum":[0,1],"example":1,"type":"integer"},"file":{"description":"The filename.","example":"cgi-bin","type":"string"},"fullpath":{"description":"The file's full filepath.","example":"/home/user/public_html/cgi-bin","format":"path","type":"string"},"gid":{"description":"The file owner's system group ID.","example":503,"minimum":1,"type":"integer"},"humansize":{"description":"The file's formatted size, followed by one of the following symbols:\n* `KB` - kilobytes\n* `MB` - megabytes\n* `GB` - gigabytes","example":"5 KB","type":"string"},"isleaf":{"description":"Whether the directory contains subdirectories.\n* `1` - Contains subdirectories.\n* `0` - Does **not** contain subdirectories.","enum":[0,1],"example":1,"type":"integer"},"mimename":{"description":"The file's MIME name.","example":"publichtml","type":"string"},"mimetype":{"description":"The file's MIME type.","example":"text/plain","format":"MIME","type":"string"},"mode":{"description":"The file's textual permissions in [Unix format](https://en.wikipedia.org/wiki/File-system_permissions#Notation_of_traditional_Unix_permissions).","example":"16872","type":"string"},"mtime":{"description":"The file's last modification time, in Unix time format.","example":1400573272,"format":"unix_timestamp","type":"integer"},"nicemode":{"description":"The file's numerical permissions in [octal notation](https://en.wikipedia.org/wiki/File-system_permissions#Notation_of_traditional_Unix_permissions).","example":755,"type":"integer"},"path":{"description":"The file's path.","example":"/home/user/public.html","format":"path","type":"string"},"rawmimename":{"description":"The file's raw MIME name.","example":"text/plain","format":"MIME","type":"string"},"rawmimetype":{"description":"The file's raw MIME type.","example":"text/plain","format":"MIME","type":"string"},"read":{"description":"Whether the file is readable. The function only returns this value if you set the `include_permissions` value to 1.\n* `1` - Readable.\n* `0` - **Not** readable.","enum":[0,1],"example":1,"type":"integer"},"size":{"description":"The file's size, in bytes.","example":4096,"minimum":1,"type":"integer"},"type":{"description":"The item's type.\n* `file` - File.\n* `dir` - Directory.\n* `char` - Character special device.\n* `block` - Block special device.\n* `fifo` - Named pipe.\n* `link` - Symbolic link.\n* `socket` - Unix domain socket.","enum":["file","dir","char","block","fifo","link","socket"],"example":"file","type":"string"},"uid":{"description":"The file owner's system user ID.","example":502,"minimum":1,"type":"integer"},"write":{"description":"Whether the file is writable. The function only returns this value if you set the `include_permissions` value to 1 .\n* `1` - Writable.\n* `0` - Not writable.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return file or directory information","tags":["Fileman","Manage Files"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Fileman \\\n  get_file_information \\\n  path='public_html'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Fileman/get_file_information?path=public_html"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Fileman_get_file_information.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Fileman_get_file_information.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Fileman/,\n    q/get_file_information/,\n    {\n        'path' => 'public_html',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Fileman_get_file_information.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Fileman_get_file_information.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Fileman',\n    'get_file_information',\n    array (\n        'path' => 'public_html',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.44"}},"/Fileman/transcode":{"get":{"description":"This function converts a buffer from one encoding language to another.\n\n**Important:**\n\n  When you disable the [File Storage role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"transcode","parameters":[{"description":"The file's contents.","in":"query","name":"content","required":true,"schema":{"example":"hi","type":"string"}},{"description":"The file's current [character set encoding](https://en.wikipedia.org/wiki/Character_encoding).","in":"query","name":"from_charset","required":false,"schema":{"example":"UTF-8","type":"string"}},{"description":"The [character set encoding](https://en.wikipedia.org/wiki/Character_encoding) in which to encode the file.","in":"query","name":"to_charset","required":false,"schema":{"example":"ASCII","type":"string"}},{"description":"Whether to discard any characters that do not transcode correctly.\n  * `1` - Discard invalid characters.\n  * `0` - Transcode invalid characters in the default [character set encoding](https://en.wikipedia.org/wiki/Character_encoding).","in":"query","name":"discard_illegal","required":false,"schema":{"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to transcode invalid characters to valid characters in the new character set encoding.\n  * `1` - Transcode invalid characters in the new [character set encoding](https://en.wikipedia.org/wiki/Character_encoding).\n  * `0` - Return an error message.","in":"query","name":"transliterate","required":false,"schema":{"enum":[0,1],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"transcode","type":"string"},"module":{"description":"The name of the module called.","example":"Fileman","type":"string"},"result":{"properties":{"data":{"properties":{"charset":{"description":"The file's new character set.","example":"ASCII","type":"string"},"content":{"description":"The file's content.","example":"hi","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update buffer encoding","tags":["Fileman","Manage Files"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Fileman \\\n  transcode \\\n  content='hi'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Fileman/transcode?content=hi"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Fileman_transcode.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Fileman_transcode.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Fileman/,\n    q/transcode/,\n    {\n        'content' => 'hi',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Fileman_transcode.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Fileman_transcode.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Fileman',\n    'transcode',\n    array (\n        'content' => 'hi',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.44"}},"/Fileman/list_files":{"get":{"description":"This function returns a sorted list of files and directories.\n\n**Important:**\n\nWhen you disable the [FileStorage role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function. For more information, read our How to Use Server Profiles documentation.","operationId":"list_files","parameters":[{"description":"The directory from which to list files.","in":"query","name":"dir","required":true,"schema":{"example":"public_html","type":"string"}},{"description":"A pipe-separated list of file types to return.\n\n* `file` — A file.\n* `dir` — A directory.\n* `char` — A character special device.\n* `block` — A block special device.\n* `fifo` — A named pipe (FIFO).\n* `link` — A symbolic link.\n* `socket` — A Unix domain socket.\n\nIf you do not use this parameter, the function returns all file types.","explode":false,"in":"query","name":"types","required":false,"schema":{"items":{"example":"file|dir","type":"string"},"type":"array"},"style":"pipeDelimited"},{"description":"Whether to return only entries that begin with the `filepath-` prefix.\n\n* `1` — Return only files that begin with the `filepath-` prefix.\n* `0` — Return **all** files.\n\nIf you do not use this parameter, the function returns all filenames.","in":"query","name":"limit_to_list","required":false,"schema":{"enum":[0,1],"example":0,"type":"integer"}},{"description":"A comma-separated list of files to return.\n\nIf you do not use this parameter, the function returns all files.","in":"query","name":"only_these_files","required":false,"schema":{"example":"cpbackup-exclude.conf","type":"string"}},{"description":"Whether to include hidden files in the output.\n\n* `1` — Include hidden files.\n* `0` — Do **not** include hidden files.","in":"query","name":"show_hidden","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to return directories that contain subdirectories.\n\n* `1` — Return subdirectories.\n* `0` — Do **not** retain subdirectories.","in":"query","name":"check_for_leaf_directories","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"The MIME types to return.\n\n* If you use this parameter, the function returns the specified MIME types\nand sets the `include_mime` parameter's value to `1`.\n* If you do **not** use this parameter, the function returns all MIME types.","in":"query","name":"mime_types","required":false,"schema":{"example":"text-plain","type":"string"}},{"description":"The raw MIME types to return.\n\n* If you use this parameter, the function returns the specified MIME types\nand sets the `include_mime` parameter's value to `1`.\n* If you do **not** use this parameter, the function returns all MIME types.","in":"query","name":"raw_mime_types","required":false,"schema":{"example":"text/plain","type":"string"}},{"description":"Whether to return the file's MIME type.\n\n* `1` — Include MIME type.\n* `0` — Do **not** include MIME type.\n\n**Note:**\n\n If you set this value to `0` but also include the `mime_types` or `raw_mime_types` parameters, the function **overrides** your specified value and sets this parameter to `1`.","in":"query","name":"include_mime","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to parse the file owner's read and write permissions.\n\n* `1` — Parse file permissions.\n* `0` — Do **not** parse file permissions.","in":"query","name":"include_permissions","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_files","type":"string"},"module":{"description":"The name of the module called.","example":"Fileman","type":"string"},"result":{"properties":{"data":{"properties":{"dirs":{"description":"An array of objects containing information about each directory.","items":{"properties":{"absdir":{"description":"The file path to the user's home directory.","example":"/home/user","format":"path","type":"string"},"ctime":{"description":"The directory's creation date.","example":1400573272,"format":"unix_timestamp","type":"integer"},"exists":{"description":"Whether the directory exists in the directory.\n\n* `1` — Exists.\n* `0` — Does **not** exist.","enum":[0,1],"example":1,"type":"integer"},"file":{"description":"The directory name.","example":"cgi-bin","type":"string"},"fullpath":{"description":"The directory's full directory path.","example":"/home/user/public_html/cgi-bin","format":"path","type":"string"},"gid":{"description":"The directory owner's system group ID.","example":503,"minimum":1,"type":"integer"},"humansize":{"description":"The formatted size of the directory. The function returns the size with\none of the following symbols:\n\n* `KB` — Kilobytes.\n* `MB` — Megabytes.\n* `GB` — Gigabytes.","example":"5 KB","type":"string"},"isleaf":{"description":"Whether the directory contains subdirectories.\n\n* `1` — Contains subdirectories.\n* `0` — Does **not** contain subdirectories.","enum":[0,1],"example":1,"type":"integer"},"isparent":{"description":"Whether the directory is a parent record.\n\n* `1` — A parent record.\n* `0` — **Not** a parent record.","enum":[0,1],"example":1,"type":"integer"},"mimename":{"description":"The MIME type's name.","example":"text-plain","type":"string"},"mimetype":{"description":"The directory's MIME's type.","example":"text/plain","type":"string"},"mode":{"description":"The directory's textual permissions in [Unix format](http://en.wikipedia.org/wiki/File_system_permissions#Notation_of_traditional_Unix_permissions).","example":"16877","format":"unix-file-permission","type":"string"},"mtime":{"description":"The directory's last modification time.","example":1400573272,"format":"unix_timestamp","type":"integer"},"nicemode":{"description":"The directory's numerical permissions.","example":755,"format":"unix-file-permission","type":"integer"},"path":{"description":"The path to the directory.","example":"/home/user/public.html","format":"path","type":"string"},"rawmimename":{"description":"The directory's raw MIME type's name.","example":"text-plain","type":"string"},"rawmimetype":{"description":"The directory's raw MIME type.","example":"text/plain","type":"string"},"read":{"description":"Whether the directory is readable.\n\n* `1` — Readable.\n* `0` — **Not** readable.\n\n**Note:**\n\nThe function only returns this value if the `include_permissions` value is `1`.","enum":[0,1],"example":1,"type":"integer"},"size":{"description":"The directory's size, in bytes.","example":4096,"minimum":1,"type":"integer"},"type":{"description":"The item's type.\n\n* `file` — A file.\n* `dir` — A directory.\n* `char` — A character special device.\n* `block` — A block special device.\n* `fifo` - A named pipe (FIFO).\n* `link` — A symbolic link.\n* `socket` — A Unix domain socket.","enum":["file","dir","char","block","fifo","link","socket"],"example":"file","type":"string"},"uid":{"description":"The directory owner's system user ID.","example":502,"minimum":1,"type":"integer"},"write":{"description":"Whether the directory is writable.\n\n* `1` — Writable.\n* `0` — **Not** writable.\n\n**Note:**\n\nThe function only returns this value if the `include_permissions` value is `1`.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"type":"array"},"files":{"description":"An array of objects containing information about each file.","items":{"properties":{"absdir":{"description":"The file path to the user's home directory.","example":"/home/user","format":"path","type":"string"},"ctime":{"description":"The file's creation time.","example":1400573272,"format":"unix_timestamp","type":"integer"},"exists":{"description":"Whether the file exists in the directory.\n\n* `1` — Exists.\n* `0` — Does **not** exist.","enum":[0,1],"example":1,"type":"integer"},"file":{"description":"The filename.","example":"cgi-bin","type":"string"},"fullpath":{"description":"The file's full file path.","example":"/home/user/public_html/cgi-bin","format":"path","type":"string"},"gid":{"description":"The file owner's system group ID.","example":503,"minimum":1,"type":"integer"},"humansize":{"description":"The formatted size of the file. The function returns the size with\none of the following symbols:\n\n* `KB` — Kilobytes.\n* `MB` — Megabytes.\n* `GB` — Gigabytes.","example":"5 KB","type":"string"},"isleaf":{"description":"Whether the directory contains subdirectories.\n\n* `1` — Contains subdirectories.\n* `0` — Does **not** contain subdirectories.","enum":[0,1],"example":1,"type":"integer"},"isparent":{"description":"Whether the file is a parent record.\n\n* `1` — A parent record.\n* `0` — **Not** a parent record.","enum":[0,1],"example":1,"type":"integer"},"mimename":{"description":"The file's MIME type name.","example":"text-plain","type":"string"},"mimetype":{"description":"The file's MIME type.","example":"text/plain","type":"string"},"mode":{"description":"The file's textual permissions.","example":"16877","format":"unix-file-permission","type":"string"},"mtime":{"description":"The file's last modification time.","example":1400573272,"format":"unix_timestamp","type":"integer"},"nicemode":{"description":"The file's numerical permissions.","example":755,"format":"unix-file-permission","type":"integer"},"path":{"description":"The absolute path to the file.","example":"/home/user/public.html","format":"path","type":"string"},"rawmimename":{"description":"The file's raw MIME type's name.","example":"text-plain","type":"string"},"rawmimetype":{"description":"The file's raw MIME type.","example":"text/plain","type":"string"},"read":{"description":"Whether the file is readable.\n\n* `1` — Readable.\n* `0` — **Not** readable.\n\n**Note:**\n\nThe function only returns this value if the `include_permissions` value is `1`.","enum":[0,1],"example":1,"type":"integer"},"size":{"description":"The file's size, in bytes.","example":4096,"minimum":1,"type":"integer"},"type":{"description":"The item's type.\n\n* `file` — A file.\n* `dir` — A directory.\n* `char` — A character special device.\n* `block` — A block special device.\n* `fifo` - A named pipe (FIFO).\n* `link` — A symbolic link.\n* `socket` — A Unix domain socket.","enum":["file","dir","char","block","fifo","link","socket"],"example":"file","type":"string"},"uid":{"description":"The file owner's system user ID.","example":502,"minimum":1,"type":"integer"},"write":{"description":"Whether the file is writable.\n\n* `1` — Writable.\n* `0` — **Not** writable.\n\n**Note:**\n\nThe function only returns this value if the `include_permissions` value is `1`.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"type":"array"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success\n* `0` — Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return directory content","tags":["Fileman","Manage Files"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Fileman \\\n  list_files \\\n  dir='public_html'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Fileman/list_files?dir=public_html"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Fileman_list_files.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Fileman_list_files.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Fileman/,\n    q/list_files/,\n    {\n        'dir' => 'public_html',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Fileman_list_files.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Fileman_list_files.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Fileman',\n    'list_files',\n    array (\n        'dir' => 'public_html',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.44"}},"/Fileman/save_file_content":{"get":{"description":"This function saves a file in a directory and encodes it in a character set.\n\n**Important:**\n\n  When you disable the [File Storage role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"save_file_content","parameters":[{"description":"The directory that contains the selected file.\n\n**Note:**\n\nThis parameter defaults to the currently-authenticated user's `/home` directory.","in":"query","name":"dir","required":false,"schema":{"example":"/home/username/public_html","format":"path","type":"string"}},{"description":"The files to retrieve.","in":"query","name":"file","required":true,"schema":{"example":"example.html","type":"string"}},{"description":"The [character set encoding](https://en.wikipedia.org/wiki/Character_encoding) of the `content` parameter's value.","in":"query","name":"from_charset","required":false,"schema":{"default":"UTF-8","example":"UTF-8","type":"string"}},{"description":"The [character set encoding](https://en.wikipedia.org/wiki/Character_encoding) in which to encode the file.","in":"query","name":"to_charset","required":false,"schema":{"default":"UTF-8","example":"ASCII","type":"string"}},{"description":"The new file's contents. If you do **not** use this parameter, the function creates a blank file.","in":"query","name":"content","required":false,"schema":{"example":"hi","type":"string"}},{"description":"Whether the function will return an error or save in the default\ncharacter set if it cannot save in the specified character set.\n\n* `1` — Save in the default character set.\n* `0` — Return an error.","in":"query","name":"fallback","required":false,"schema":{"default":1,"enum":[0,1],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"save_file_content","type":"string"},"module":{"description":"The name of the module called.","example":"Fileman","type":"string"},"result":{"properties":{"data":{"properties":{"from_charset":{"description":"The file's character set.","example":"UTF-8","type":"string"},"path":{"description":"The path to the file.","example":"/home/user/public_html/example.html","format":"path","type":"string"},"to_charset":{"description":"The file's new character set.","example":"ASCII","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Save file","tags":["Fileman","Manage Files"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Fileman \\\n  save_file_content \\\n  file='example.html'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Fileman/save_file_content?file=example.html"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Fileman_save_file_content.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Fileman_save_file_content.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Fileman/,\n    q/save_file_content/,\n    {\n        'file' => 'example.html',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Fileman_save_file_content.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Fileman_save_file_content.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Fileman',\n    'save_file_content',\n    array (\n        'file' => 'example.html',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.44"}},"/Fileman/upload_files":{"get":{"description":"This function uploads files.\n\n**Note:**\n\n  For more information about how to use this function in your custom code,\n  read our [Use UAPI's `Fileman::upload_files` \n  Function in Custom Code tutorial](https://go.cpanel.net/tutorial-use-uapis-fileman-upload-files-function-in-custom-code). \n\n**Important:**\n\n When you disable the [File Storage](https://go.cpanel.net/serverroles) role, the system **disables** this function.\n\nYou cannot call this function through WHM API 1's [uapi_cpanel](https://go.cpanel.net/UseWHMAPItoCallcPanelAPIandUAPI) function.","operationId":"upload_files","summary":"Upload files","tags":["Fileman","Manage Files"],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"upload_files","type":"string"},"module":{"description":"The name of the module called.","example":"Fileman","type":"string"},"result":{"properties":{"data":{"properties":{"content":{"description":"","example":"","format":"binary","type":"string"},"filename":{"description":"The file's name.","example":"example.png","type":"string"}}},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"To implement Fileman::upload_files, read our Use UAPI's `Fileman::upload_files` Function in Custom Code tutorial."},{"label":"URL","lang":"HTTP","source":"To implement Fileman::upload_files, read our Use UAPI's `Fileman::upload_files` Function in Custom Code tutorial."},{"label":"LiveAPI Perl","lang":"Perl","source":"To implement Fileman::upload_files, read our Use UAPI's `Fileman::upload_files` Function in Custom Code tutorial."},{"label":"LiveAPI PHP","lang":"PHP","source":"To implement Fileman::upload_files, read our Use UAPI's `Fileman::upload_files` Function in Custom Code tutorial."}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.44"}},"/Ftp/add_ftp":{"get":{"description":"This function creates an FTP account.\n\n**Important:**\n\nWhen you disable the [FTP role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"add_ftp","parameters":[{"description":"The new FTP account username.","in":"query","name":"user","required":true,"schema":{"example":"username","type":"string"}},{"description":"The new FTP account password.\n\n**Note:**\n\nYou can use the `pass_hash` parameter in place of this parameter. However, you **cannot** use both the `pass` and `pass_hash` parameters in the same request.","in":"query","name":"pass","required":false,"schema":{"example":"123456luggage","type":"string"}},{"description":"The path to the FTP account's root directory, relative to the cPanel account's home directory. If you don't set this, it defaults to a directory with the same name as the FTP account.","in":"query","name":"homedir","required":false,"schema":{"example":"exampleftp","format":"path","type":"string"}},{"description":"The FTP account's maximum disk usage quota, in megabytes (MB).\n\n**Note:**\n\nA value of `0` grants the FTP account unlimited disk space.","in":"query","name":"quota","required":false,"schema":{"default":0,"example":42,"minimum":0,"type":"integer"}},{"description":"Whether to strip dots (`.`) from the username.\n\n* `1` — Strip dots.\n* `0` — Do **not** strip dots.","in":"query","name":"disallowdot","required":false,"schema":{"default":1,"enum":[0,1],"example":1,"type":"integer"}},{"description":"The FTP user's associated domain. This must be a domain that the cPanel account owns.\n\n**Note:**\n\nThis parameter defaults to the cPanel account's primary domain.","in":"query","name":"domain","required":false,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"The account's password hash.\n\n**Note:**\n\n* You can use this parameter in place of the `pass` parameter. However, you **cannot** use both the `pass` and `pass_hash` parameters in the same request.\n* You can find your server's password hash type in the `/etc/sysconfig/authconfig` file.","in":"query","name":"pass_hash","required":false,"schema":{"default":"","example":"$6$1sOyHP5ZDYp3pGUz$R0TSgfPRHfDjT5PP5RJGv39FhiGTNNPvM7IFpCBjXijMmlMZk9yI8T3LqGuntc9fdKb5eX.lGL7wBS9e4DAWn/","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"add_ftp","type":"string"},"module":{"description":"The name of the module called.","example":"Ftp","type":"string"},"result":{"properties":{"data":{"enum":[null],"example":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create FTP account","tags":["Ftp","FTP Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Ftp \\\n  add_ftp \\\n  user='username2' \\\n  pass='123456luggage'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Ftp/add_ftp?user=username"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Ftp_add_ftp.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Ftp_add_ftp.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Ftp/,\n    q/add_ftp/,\n    {\n        'user' => 'username',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Ftp_add_ftp.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Ftp_add_ftp.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Ftp',\n    'add_ftp',\n    array (\n        'user' => 'username',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Ftp/allows_anonymous_ftp":{"get":{"description":"This function checks whether the account allows anonymous FTP connections.\n\n**Important:**\n\nWhen you disable the [*FTP* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"allows_anonymous_ftp","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"allows_anonymous_ftp","type":"string"},"module":{"description":"The name of the module called.","example":"Ftp","type":"string"},"result":{"properties":{"data":{"properties":{"allows":{"description":"Whether the cPanel account allows anonymous FTP connections.\n* `1` - Allowed.\n* `0` - **Not** allowed.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return if anonymous FTP connections allowed","tags":["Ftp","FTP Server Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Ftp \\\n  allows_anonymous_ftp\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Ftp/allows_anonymous_ftp"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Ftp_allows_anonymous_ftp.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Ftp_allows_anonymous_ftp.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Ftp/,\n    q/allows_anonymous_ftp/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Ftp_allows_anonymous_ftp.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Ftp_allows_anonymous_ftp.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Ftp',\n    'allows_anonymous_ftp'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Ftp/delete_ftp":{"get":{"description":"This function deletes an FTP account.\n\n**Important:**\n\nWhen you disable the [*FTP* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"delete_ftp","parameters":[{"description":"The user's associated domain.\n\n**Note:**\n\nThis parameter defaults to the cPanel account's primary domain.","in":"query","name":"domain","required":false,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"The FTP account's username.","in":"query","name":"user","required":true,"schema":{"example":"username","type":"string"}},{"description":"Whether to delete the FTP account's home directory.\n\n* `1` — Delete the home directory.\n* `0` — Do **not** delete the home directory.","in":"query","name":"destroy","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"delete_ftp","type":"string"},"module":{"description":"The name of the module called.","example":"Ftp","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete FTP account","tags":["Ftp","FTP Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Ftp \\\n  delete_ftp \\\n  user='username2'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Ftp/delete_ftp?user=username"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Ftp_delete_ftp.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Ftp_delete_ftp.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Ftp/,\n    q/delete_ftp/,\n    {\n        'user' => 'username',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Ftp_delete_ftp.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Ftp_delete_ftp.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Ftp',\n    'delete_ftp',\n    array (\n        'user' => 'username',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Ftp/ftp_exists":{"get":{"description":"This function checks whether an FTP account exists.\n\n**Note:**\n\nThis function returns only metadata if the FTP account exists, or an error if the FTP account does **not** exist.","operationId":"ftp_exists","parameters":[{"description":"The user's associated domain.\n\n**Note:**\n\nThis parameter defaults to the cPanel account's primary domain.","in":"query","name":"domain","required":false,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"The FTP account's username.","in":"query","name":"user","required":true,"schema":{"example":"us_chickens","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"ftp_exists","type":"string"},"module":{"description":"The name of the module called.","example":"Ftp","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return whether an FTP account exists","tags":["Ftp","FTP Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Ftp \\\n  ftp_exists \\\n  user='us_chickens'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Ftp/ftp_exists?user=us_chickens"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Ftp_ftp_exists.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Ftp_ftp_exists.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Ftp/,\n    q/ftp_exists/,\n    {\n        'user' => 'us_chickens',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Ftp_ftp_exists.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Ftp_ftp_exists.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Ftp',\n    'ftp_exists',\n    array (\n        'user' => 'us_chickens',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Ftp/allows_anonymous_ftp_incoming":{"get":{"description":"This function checks whether the account allows inbound anonymous FTP transfers.\n\n**Important:**\n\n  When you disable the [*FTP* role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"allows_anonymous_ftp_incoming","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"allows_anonymous_ftp_incoming","type":"string"},"module":{"description":"The name of the module called.","example":"Ftp","type":"string"},"result":{"properties":{"data":{"properties":{"allows":{"description":"Whether the cPanel account allows inbound anonymous FTP transfers.\n* `1` - Allowed.\n* `0` - Not allowed.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return if anonymous FTP transfers allowed","tags":["Ftp","FTP Server Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Ftp \\\n  allows_anonymous_ftp_incoming\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Ftp/allows_anonymous_ftp_incoming"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Ftp_allows_anonymous_ftp_incoming.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Ftp_allows_anonymous_ftp_incoming.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Ftp/,\n    q/allows_anonymous_ftp_incoming/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Ftp_allows_anonymous_ftp_incoming.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Ftp_allows_anonymous_ftp_incoming.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Ftp',\n    'allows_anonymous_ftp_incoming'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Ftp/get_ftp_daemon_info":{"get":{"description":"This function retrieves the extended information about the server's FTP daemon.","operationId":"get_ftp_daemon_info","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_ftp_daemon_info","type":"string"},"module":{"description":"The name of the module called.","example":"Ftp","type":"string"},"result":{"properties":{"data":{"properties":{"enabled":{"description":"Whether the server's FTP daemon is enabled.\n\n* `1` – Enabled.\n* `0` – Disabled.","enum":[0,1],"example":1,"type":"integer"},"name":{"description":"The FTP server's name.\n\n* `pure-ftpd`\n* `proftpd`\n* An empty string.","enum":["pure-ftpd","proftpd",""],"example":"pure-ftpd","type":"string"},"supports":{"description":"This object contains the features that the FTP daemon supports.","properties":{"login_without_domain":{"description":"Whether the FTP daemon supports username authentication without the user's domain.\n\n* `1` – Supported.\n* `0` – **Not** supported.","enum":[0,1],"example":0,"type":"integer"},"quota":{"description":"Whether the FTP daemon supports disk quotas.\n\n* `1` – Supported.\n* `0` – **Not** supported.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return FTP server's information","tags":["Ftp","FTP Server Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Ftp \\\n  get_ftp_daemon_info\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Ftp/get_ftp_daemon_info"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Ftp_get_ftp_daemon_info.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Ftp_get_ftp_daemon_info.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Ftp/,\n    q/get_ftp_daemon_info/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Ftp_get_ftp_daemon_info.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Ftp_get_ftp_daemon_info.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Ftp',\n    'get_ftp_daemon_info'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/Ftp/get_port":{"get":{"description":"This function returns the FTP port.\n\n**Important:**\n\n  When you disable the [*FTP* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"get_port","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_port","type":"string"},"module":{"description":"The name of the module called.","example":"Ftp","type":"string"},"result":{"properties":{"data":{"properties":{"port":{"description":"The FTP port.","example":21,"maximum":65335,"minimum":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed. Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return FTP server's port","tags":["Ftp","FTP Server Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Ftp \\\n  get_port\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Ftp/get_port"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Ftp_get_port.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Ftp_get_port.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Ftp/,\n    q/get_port/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Ftp_get_port.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Ftp_get_port.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Ftp',\n    'get_port'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Ftp/get_quota":{"get":{"description":"This function checks an FTP account's quota.\n\n**Important:**\n\n  When you disable the [_FTP role_](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"get_quota","parameters":[{"description":"The FTP account's username.","in":"query","name":"account","required":true,"schema":{"example":"user1","type":"string"}},{"description":"The user's associated domain.\n\n**Note:**\n\nThis parameter defaults to the cPanel account's primary domain.","in":"query","name":"domain","required":false,"schema":{"example":"example.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_quota","type":"string"},"module":{"description":"The name of the module called.","example":"Ftp","type":"string"},"result":{"properties":{"data":{"description":"The FTP account's quota.\n* `unlimited`\n* A positive integer that represents the maximum amount of disk space that the FTP account can use, in megabytes (MB).","example":"unlimited","type":"string"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return FTP account's quota","tags":["Ftp","FTP Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Ftp \\\n  get_quota \\\n  account='user1'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Ftp/get_quota?account=user1"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Ftp_get_quota.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Ftp_get_quota.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Ftp/,\n    q/get_quota/,\n    {\n        'account' => 'user1',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Ftp_get_quota.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Ftp_get_quota.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Ftp',\n    'get_quota',\n    array (\n        'account' => 'user1',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Ftp/get_welcome_message":{"get":{"description":"This function retrieves the cPanel account's FTP welcome message.\n\n**Important:**\n\n  When you disable the [*FTP* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"get_welcome_message","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_welcome_message","type":"string"},"module":{"description":"The name of the module called.","example":"Ftp","type":"string"},"result":{"properties":{"data":{"description":"The cPanel account's FTP welcome message.","example":"Greetings, Professor Falken.","type":"string"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` — Success.\n- `0` — Failed. Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return FTP account's welcome message","tags":["Ftp","FTP Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Ftp \\\n  get_welcome_message\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Ftp/get_welcome_message"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Ftp_get_welcome_message.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Ftp_get_welcome_message.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Ftp/,\n    q/get_welcome_message/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Ftp_get_welcome_message.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Ftp_get_welcome_message.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Ftp',\n    'get_welcome_message'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Ftp/kill_session":{"get":{"description":"This function kills FTP sessions.\n\n**Important:**\n\n  When you disable the [*FTP* Role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"kill_session","parameters":[{"description":"The username for the session's FTP account.\n\n**Note:**\n\n  To stop all FTP sessions for the cPanel account, set this parameter to the `all` value.","in":"query","name":"login","required":false,"schema":{"default":"all","example":"weeones","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"kill_session","type":"string"},"module":{"description":"The name of the module called.","example":"Ftp","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Stop FTP session","tags":["Ftp","FTP Server Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Ftp \\\n  kill_session\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Ftp/kill_session"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Ftp_kill_session.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Ftp_kill_session.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Ftp/,\n    q/kill_session/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Ftp_kill_session.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Ftp_kill_session.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Ftp',\n    'kill_session'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Ftp/list_sessions":{"get":{"description":"This function lists the FTP server's active sessions.\n\n**Important:**\n\n  When you disable the [FTP role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"list_sessions","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_sessions","type":"string"},"module":{"description":"The name of the module called.","example":"Ftp","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"cmdline":{"description":"Information about the FTP process, from the `ps` ([process status](http://www.linfo.org/ps.html)) command.","example":"pure-ftpd (IDLE)","type":"string"},"file":{"description":"The file that the session is processing.\n\n**Note:**\n\nThe function returns a blank value if the session is idle.","example":"","type":"string"},"host":{"description":"The IP address or hostname that connected to the FTP server.","example":"localhost","oneOf":[{"format":"ipv4","type":"string"},{"format":"domain","type":"string"}]},"login":{"description":"The FTP session login time.","example":"Tue Apr 23 16:23:23 2020","type":"string"},"pid":{"description":"The session's PID.","example":6735,"minimum":1,"type":"integer"},"status":{"description":"The session's status.\n- `IDLE` - The session is connected, but idle.\n- `DL` - A download is in progress.\n- `UL` - An upload is in progress.","enum":["IDLE","DL","UL"],"example":"IDLE","type":"string"},"user":{"description":"The FTP account username.","example":"ftpaccount","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- `1` - Success.\n- `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return FTP server's active sessions","tags":["Ftp","FTP Server Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Ftp \\\n  list_sessions\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Ftp/list_sessions"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Ftp_list_sessions.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Ftp_list_sessions.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Ftp/,\n    q/list_sessions/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Ftp_list_sessions.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Ftp_list_sessions.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Ftp',\n    'list_sessions'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Ftp/list_ftp_with_disk":{"get":{"description":"This function lists FTP account and disk usage information.\n\n**Important:**\n\nWhen you disable the [FTP role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"list_ftp_with_disk","parameters":[{"description":"A pipe-delimited list of the FTP account types to exclude from the function's\nresults. If you do not specify this parameter, the function does **not** exclude\nany account types.\n\nValid types for this list are:\n\n* `anonymous`\n* `logaccess`\n* `main`\n* `sub`","in":"query","name":"skip_acct_types","required":false,"schema":{"example":"main|anonymous","type":"string"}},{"description":"A pipe-delimited list of the FTP account types to include in the function's results.\nIf you do not specify this parameter, the function returns all FTP account types.\n\nValid types for this list are:\n\n* `anonymous`\n* `logaccess`\n* `main`\n* `sub`","in":"query","name":"include_acct_types","required":false,"schema":{"example":"main|anonymous","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_ftp_with_disk","type":"string"},"module":{"description":"The name of the module called.","example":"Ftp","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"_diskquota":{"description":"The FTP account's quota in megabytes, with two digits of fractional precision,\nencoded as a string. `0.00` means that the quota is unlimited.\n\n**Note:**\n\nThis value is different from the value for `diskquota`.","example":"476.84","format":"^\\d+\\.\\d+$","type":"string"},"_diskused":{"description":"The amount of disk space in megabytes that the account currently uses,\nwith two digits of fractional precision, encoded as a string.\n\n**Note:**\n\nThis value is the same as the value for `diskused`.","example":"2.34","format":"^\\d+\\.\\d+$","type":"string"},"accttype":{"description":"The type of FTP account.\n\n* `anonymous`\n* `logaccess`\n* `main`\n* `sub`","enum":["anonymous","logaccess","main","sub"],"example":"sub","type":"string"},"deleteable":{"description":"Whether the function's caller can delete the account.\n\n* `1` – The caller can delete the account.\n* `0` – The caller **cannot** delete the account.","enum":[0,1],"example":1,"type":"integer"},"dir":{"description":"The absolute path to the FTP account's document root.","example":"/home/user/public_ftp","type":"string"},"diskquota":{"description":"The FTP account's quota.\n\n* `unlimited`\n* The disk quota in megabytes, with two digits of fractional precision, encoded as a string.\n\n**Note:**\n\nThis value is different from the value for `_diskquota`.","example":"476.84","oneOf":[{"enum":["unlimited"],"type":"string"},{"format":"^\\d+\\.\\d+$","type":"string"}]},"diskused":{"description":"The amount of disk space in megabytes that the account currently uses,\nwith two digits of fractional precision, encoded as a string.\n\n**Note:**\n\nThis value is the same as the value for `_diskused`.","example":"2.34","format":"^\\d+\\.\\d+$","type":"string"},"diskusedpercent":{"description":"The percentage of the disk space quota that the account currently uses.","example":21,"type":"integer"},"diskusedpercent20":{"description":"The percentage of disk space that the account currently uses, rounded in 20 percent increments.","example":20,"maximum":100,"minimum":0,"multipleOf":20,"type":"integer"},"htmldir":{"description":"The path to the FTP account's HTML directory.","example":null,"nullable":true,"type":"string"},"humandiskquota":{"description":"The FTP account's quota, in human-readable format.\n\n* `None` — The function returns this value if the account has an unlimited quota.\n* The quota in megabytes (MB), a space, and the characters `MB`.","example":"477 MB","type":"string"},"humandiskused":{"description":"The amount of disk space that the account currently uses, in\nhuman-readable format. The function formats this value as the\nquota's size, a space, and the characters `MB`.","example":"2 MB","type":"string"},"login":{"description":"The FTP account username.","example":"ftpaccount","type":"string"},"reldir":{"description":"The path to the FTP account's document root,\nrelative to the cPanel account's home directory.","example":"public_ftp","type":"string"},"serverlogin":{"description":"The full FTP login username.","example":"ftpaccount@example.com","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return FTP accounts and disk usage","tags":["Ftp","FTP Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Ftp \\\n  list_ftp_with_disk\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Ftp/list_ftp_with_disk"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Ftp_list_ftp_with_disk.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Ftp_list_ftp_with_disk.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Ftp/,\n    q/list_ftp_with_disk/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Ftp_list_ftp_with_disk.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Ftp_list_ftp_with_disk.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Ftp',\n    'list_ftp_with_disk'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Ftp/passwd":{"get":{"description":"This function changes an FTP account's password.\n\n**Important:**\n\nWhen you disable the [FTP role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"passwd","parameters":[{"description":"The user's associated domain.\n\n**Note:**\n\nThis parameter defaults to the cPanel account's primary domain","in":"query","name":"domain","required":false,"schema":{"example":"example.com","type":"string"}},{"description":"The FTP account username.","in":"query","name":"user","required":true,"schema":{"example":"ftpaccount","type":"string"}},{"description":"The FTP account's new password.","in":"query","name":"pass","required":true,"schema":{"example":"12345luggage","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"passwd","type":"string"},"module":{"description":"The name of the module called.","example":"Ftp","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update FTP account's password","tags":["Ftp","FTP Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Ftp \\\n  passwd \\\n  user='ftpaccount' \\\n  pass='123456luggage'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Ftp/passwd?user=ftpaccount&pass=12345luggage"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Ftp_passwd.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Ftp_passwd.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Ftp/,\n    q/passwd/,\n    {\n        'user' => 'ftpaccount',\n        'pass' => '12345luggage',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Ftp_passwd.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Ftp_passwd.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Ftp',\n    'passwd',\n    array (\n        'user' => 'ftpaccount',\n        'pass' => '12345luggage',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Ftp/set_anonymous_ftp":{"get":{"description":"This function enables or disables anonymous FTP logins.\n\n**Important:**\n\nWhen you disable the [FTP role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"set_anonymous_ftp","parameters":[{"description":"Whether to enable or disable anonymous FTP logins.\n\n* `1` - Enable.\n* `0` - Disable.","in":"query","name":"set","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_anonymous_ftp","type":"string"},"module":{"description":"The name of the module called.","example":"Ftp","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable or disable anonymous FTP logins","tags":["Ftp","FTP Server Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Ftp \\\n  set_anonymous_ftp\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Ftp/set_anonymous_ftp"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Ftp_set_anonymous_ftp.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Ftp_set_anonymous_ftp.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Ftp/,\n    q/set_anonymous_ftp/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Ftp_set_anonymous_ftp.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Ftp_set_anonymous_ftp.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Ftp',\n    'set_anonymous_ftp'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Ftp/server_name":{"get":{"description":"This function checks whether the server uses ProFTPD or Pure-FTPd.\n\n**Important:**\n\nWhen you disable the [FTP role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"server_name","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"server_name","type":"string"},"module":{"description":"The name of the module called.","example":"Ftp","type":"string"},"result":{"properties":{"data":{"description":"The FTP server.\n* `pure-ftpd` - The Pure-FTPD server.\n* `proftpd` - The ProFTPD FTP server.\n* `disabled` - FTP has been disabled on this server.","enum":["pure-ftpd","proftpd","disabled"],"example":"pure-ftpd","type":"string"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return whether server uses ProFTPD or Pure-FTPd","tags":["Ftp","FTP Server Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Ftp \\\n  server_name\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Ftp/server_name"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Ftp_server_name.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Ftp_server_name.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Ftp/,\n    q/server_name/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Ftp_server_name.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Ftp_server_name.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Ftp',\n    'server_name'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Ftp/set_homedir":{"get":{"description":"This function changes the home directory for FTP accounts.\n\n**Important:**\n\nWhen you disable the [FTP role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"set_homedir","parameters":[{"description":"The FTP account username.","in":"query","name":"user","required":true,"schema":{"example":"example1","type":"string"}},{"description":"The user's associated domain.\n\n**Note:**\n\nThe default value is the cPanel account's primary domain.","in":"query","name":"domain","required":false,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"The FTP account's home directory\n\n**Note:**\n\nThis parameter defaults to the `user@domain` subdirectory in the cPanel account's home directory with the name, where user and domain represent the `user` and `domain` parameters.","in":"query","name":"homedir","required":false,"schema":{"default":"user@domain/","example":"example1/","format":"path","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_homedir","type":"string"},"module":{"description":"The name of the module called.","example":"Ftp","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update FTP account's home directory","tags":["Ftp","FTP Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Ftp \\\n  set_homedir \\\n  user='example1'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Ftp/set_homedir?user=example1"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Ftp_set_homedir.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Ftp_set_homedir.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Ftp/,\n    q/set_homedir/,\n    {\n        'user' => 'example1',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Ftp_set_homedir.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Ftp_set_homedir.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Ftp',\n    'set_homedir',\n    array (\n        'user' => 'example1',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/Ftp/set_anonymous_ftp_incoming":{"get":{"description":"This function enables or disables inbound anonymous FTP transfers.\n\n**Important:**\n\nWhen you disable the [FTP role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"set_anonymous_ftp_incoming","parameters":[{"description":"Whether to enable or disable inbound anonymous FTP transfers.\n\n* `1` - Enable.\n* `0` - Disable.","in":"query","name":"set","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_anonymous_ftp_incoming","type":"string"},"module":{"description":"The name of the module called.","example":"Ftp","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable or disable anonymous incoming FTP transfers","tags":["Ftp","FTP Server Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Ftp \\\n  set_anonymous_ftp_incoming\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Ftp/set_anonymous_ftp_incoming"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Ftp_set_anonymous_ftp_incoming.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Ftp_set_anonymous_ftp_incoming.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Ftp/,\n    q/set_anonymous_ftp_incoming/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Ftp_set_anonymous_ftp_incoming.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Ftp_set_anonymous_ftp_incoming.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Ftp',\n    'set_anonymous_ftp_incoming'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Ftp/set_quota":{"get":{"description":"This function changes an FTP account's quota.\n\n**Important:**\n\nWhen you disable the [FTP role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"set_quota","parameters":[{"description":"The FTP account username.","in":"query","name":"user","required":true,"schema":{"example":"ftpaccount","type":"string"}},{"description":"The new quota, in megabytes.\n\n**Note:**\n\nSetting this parameter to `0` grants the account unlimited disk space.","in":"query","name":"quota","required":false,"schema":{"default":0,"example":500,"minimum":0,"type":"integer"}},{"description":"Whether to disable quotas for the FTP account.\n* `1` - Disable quotas.\n* `0` - Enable quotas.\n\n**Note:**\n\n If you disable quotas for an FTP account, you grant that account unlimited disk space.","in":"query","name":"kill","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"The user's associated domain.\n\n**Note:**\n\nThe default value is the cPanel account's primary domain.","in":"query","name":"domain","required":false,"schema":{"example":"example.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_quota","type":"string"},"module":{"description":"The name of the module called.","example":"Ftp","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update FTP account's quota","tags":["Ftp","FTP Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Ftp \\\n  set_quota \\\n  user='ftpaccount'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Ftp/set_quota?user=ftpaccount"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Ftp_set_quota.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Ftp_set_quota.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Ftp/,\n    q/set_quota/,\n    {\n        'user' => 'ftpaccount',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Ftp_set_quota.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Ftp_set_quota.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Ftp',\n    'set_quota',\n    array (\n        'user' => 'ftpaccount',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Ftp/list_ftp":{"get":{"description":"This function lists FTP account information.\n\n**Important:**\n\nWhen you disable the [*FTP* role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function. For more information, read our How to Use Server Profiles documentation.","operationId":"list_ftp","parameters":[{"description":"A list of the FTP account types to exclude from the function's\nresults.\n\n* `anonymous`\n* `logaccess`\n* `main`\n* `sub`\n\nIf you do not specify this parameter, this function does **not** exclude\nany account types.\n\n**Note:**\n\n* Separate multiple types with the pipe character (`|`).\n* In browser-based calls, use `%7C`.","in":"query","name":"skip_acct_types","required":false,"schema":{"example":"main|anonymous","type":"string"}},{"description":"A list of the FTP account types to include in the function's results.\n\n* `anonymous`\n* `logaccess`\n* `main`\n* `sub`\n\nIf you do not specify this parameter, this function returns all FTP account\ntypes.\n\n**Note:**\n\n* Separate multiple types with the pipe character (`|`).\n* In browser-based calls, use `%7C`.","in":"query","name":"include_acct_types","required":false,"schema":{"example":"main|anonymous","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_ftp","type":"string"},"module":{"description":"The name of the module called.","example":"Ftp","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"homedir":{"description":"The absolute path to the FTP account's document root.","example":"/home/user/public_html/ftp/","format":"path","type":"string"},"type":{"description":"The type of FTP account.\n\n* `anonymous`\n* `logaccess`\n* `main`\n* `sub`","enum":["anonymous","logaccess","main","sub"],"example":"main","type":"string"},"user":{"description":"The username for an FTP account on the cPanel account.","example":"ftpaccount","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return FTP accounts","tags":["Ftp","FTP Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Ftp \\\n  list_ftp\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Ftp/list_ftp"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Ftp_list_ftp.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Ftp_list_ftp.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Ftp/,\n    q/list_ftp/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Ftp_list_ftp.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Ftp_list_ftp.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Ftp',\n    'list_ftp'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Ftp/set_welcome_message":{"get":{"description":"This function sets the FTP welcome message.\n\n**Important:**\n\nWhen you disable the [FTP role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"set_welcome_message","parameters":[{"description":"The cPanel account's new FTP welcome message.","in":"query","name":"message","required":true,"schema":{"example":"Greetings, Professor Falken.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_welcome_message","type":"string"},"module":{"description":"The name of the module called.","example":"Ftp","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update FTP welcome message","tags":["Ftp","FTP Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Ftp \\\n  set_welcome_message \\\n  message='Greetings, Professor Falken.'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Ftp/set_welcome_message?message=Greetings%2c%20Professor%20Falken."},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Ftp_set_welcome_message.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Ftp_set_welcome_message.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Ftp/,\n    q/set_welcome_message/,\n    {\n        'message' => 'Greetings, Professor Falken.',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Ftp_set_welcome_message.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Ftp_set_welcome_message.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Ftp',\n    'set_welcome_message',\n    array (\n        'message' => 'Greetings, Professor Falken.',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/GPG/delete_keypair":{"get":{"description":"This function deletes a GnuPG (GPG) key pair.","operationId":"delete_keypair","parameters":[{"description":"The ID of the GPG key that you wish to delete.\n\n**Note:**\n\n* The function will delete **all** keys that match this ID.\n  * If you set this parameter to a public key, the function will delete the public key. \n  * If you set this parameter to a public and private key pair, the function will delete the public and private keys.\n* To obtain the desired key, call the UAPI `GPG::list_secret_keys` function.","in":"query","name":"key_id","required":true,"schema":{"example":"ACFFDB37176B680D","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"delete_keypair","type":"string"},"module":{"description":"The name of the module called.","example":"GPG","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* 1 — Success.\n* 0 — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete GnuPG key pair","tags":["GPG","Signing and Encryption (GnuPG Keys)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  GPG \\\n  delete_keypair \\\n  key_id='ACFFDB37176B680D'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/GPG/delete_keypair?key_id=ACFFDB37176B680D"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file GPG_delete_keypair.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/GPG_delete_keypair.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/GPG/,\n    q/delete_keypair/,\n    {\n        'key_id' => 'ACFFDB37176B680D',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file GPG_delete_keypair.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/GPG_delete_keypair.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'GPG',\n    'delete_keypair',\n    array (\n        'key_id' => 'ACFFDB37176B680D',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/GPG/export_public_key":{"get":{"description":"This function exports a GnuPG (GPG) public key.","operationId":"export_public_key","parameters":[{"description":"The ID of the GPG key.","in":"query","name":"key_id","required":true,"schema":{"example":"48BEA5A16FCA746E","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"export_public_key","type":"string"},"module":{"description":"The name of the module called.","example":"GPG","type":"string"},"result":{"properties":{"data":{"properties":{"key_data":{"description":"The GPG public key's contents.","example":"-----BEGIN PGP PUBLIC KEY BLOCK-----\nVersion: GnuPG v2.0.22 (GNU/Linux)\n\nmQMuBFzwFyMRCADgNf7GHvCgb2/HWBYVAzu408eXEO4ucWGfbD5c5BOHg7WBVOkh\nj+J0HYaeh9FwOXLJAzesiGtTU/HQ5wNkBbKRYR2oNEUbiefBgQhjllIGJNnFCQbD\nTcyxXjKUF4aQBw6InqzM9akVChLvGoCfom/y1fcwrQ5OQ46EEjhe9lSnj1E2DIi+\n0PvOsWeehChtn28WkmXPcl+XovfsCl5vh2RnJQeJwkSwBogA1GObj9fnPBbrIUt2\nF5JDaJ7/R8aDwV1Pg2mBmRqTBIKvx6gxEQgCL52OWCKVJfqy5oVGDl/2u0BGCaRt\n3Tnh9B14Lk8frBaOjYMtMq1Rl3rPDc3KCRnLAQC6dMNJCxIoyfeEFqj0HgwHETYn\nQNGwUaRrOGKLJbMnewf/Yq0S2R6YvMl8pDQeSExYJaqv/u2Hch6GM0f3CSvMnPSg\noB2c/h4MmhmiAbymSO5GBaM4Nx3NTNYU0JpghkTTJpucFZ8hK/aJ8PDQzBnS0zTY\nF8ZqSMFL84QB1NTd1nlJnilpKCkBC6NHUh76IyLQEsH7jgOG9L28qnLxm8bGHwaJ\nmhEH2Y859WzN9hUTZEMxdklI8uwdI+msI7md0uNYiWr5svtM+rrpU+LCZMG+nTCy\n6q0CNLXM0T0Fa642mYSqV307Ouv5rjGvfohIOo5X8ikBoEIOAQk6LX800OzzYGG4\nX75Q4irMuehEK3tId5VIRToy9MRLP6fyOVHwfhzD6Af/R2TJjIdEkEGdspuw9875\nN4z9xV2QNVNgURIOutrfeKSbb7gRLgV7TWpKWItMoEO1njzb4YqoHwcAASj4TDaT\niCYun6u12Mb97L0S3QDaD3sLk7P5sZvnO//k/YxbGISv+HGl5rSF87kVectLYpAL\nehL2EBmyxP4nxhSDOqhc0rbaqOZ+b4F1ns4NsUJjxIqQJZ+ovTqkmKnh3YbBeMAb\nsPcjyfQNmYE9qFXw17vJMm6ypNsuDIvxKCDq4QpO3/MujYX0Hg7aGOq4aWtndcL0\nPfpukTLvTA+AedMj+0QHWiP15bSxCJKqa0O62mKWnrzL0Tju8FKTwVHgRoW57GY/\nZbQmYmVuZGVyIChpcyBncmVhdCkgPGJlbmRlckBleGFtcGxlLmNvbT6IgQQTEQgA\nKQUCXPAXIwIbIwUJAeEzgAcLCQgHAwIBBhUIAgkKCwQWAgMBAh4BAheAAAoJEEi+\npaFvynRuACUA/1/usChuLicDwCbBlJpcYWaAkt4bC4z+wFAONKnwwlHoAQCq3GRM\nto4CkoB6pK1Zh+s5SitojUFrKEj8CJNkAQOGaLkCDQRc8BcjEAgA4CY3AKnkIvSz\nfcsFCf1NmZipQGLChs3iIhqa3NPiopYpYMNTdCZkkDMSDM40+d/LthpYnbzYVgPB\nN9OFMdL/ndf/yu0jPEZE1uEpxvH1X/x2IecMy7wm51usxpBWwSw7BTLfA9ASzDtH\n8fnkid2qY2J6fNWZDA5wrNR4auVKDkqKsatMC75GkHcT2NevLdh8SuYH60kQsmvD\nOkuE4ufIwzlnQ4HFKsYTxn6QIQY18entu563f+RCoUCNv2J0zxXFzvy+eo568+Uh\nx4Irz9OQRNUh/82a2HF10oUvkPEtCDlMy8gISEqnU1i2Ry8IsbUrvhz+my5yb5Gm\nZz+xOKWTiwADBQf/YOYKvHIWw4/vsbLUPMmjDdMfsnT0haDlLerCSHhY+ZLzYQdz\n/7hC4Qt/5EvaGeXkwAPzr0T4PvVOQUUAiskvDNScYQxS5KxyrHAqoKkF4EDJ9MyK\nDqEN6dF9IDOxuA1g0cOX7THPm3GjRh3BjOaHnN5jXKwT85Cs7hj7u1q9Cm59RUzJ\nwRKyxo9eR3pJMR+8E0VW8oRe/7O/Qvh54ShD7NkfgUhIWcriR9MjoGp0gnpCOH52\nLrfdczCIzAoUC4Q3Jm80sCeZAqf4CNHZ0TxqxuwG+ZkfbCBViM4TVXDEufA4IENM\nmEu2bNWDLkRrrNme+S4HEeNRuSg8EOpFUuwPI4hnBBgRCAAPBQJc8BcjAhsMBQkB\n4TOAAAoJEEi+paFvynRu0YsA/0rluXh9ij3Np4O/KWuL2L8zcOrJJ7mNFuw0wkpY\nfZ3NAP9ayHG+70XellsQ/E3lR8fkRwqDDRh43w7ukhJEfkcY9A==\n=yyST\n-----END PGP PUBLIC KEY BLOCK-----\n","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Export GnuPG public key","tags":["GPG","Signing and Encryption (GnuPG Keys)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  GPG \\\n  export_public_key \\\n  key_id='48BEA5A16FCA746E'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/GPG/export_public_key?key_id=48BEA5A16FCA746E"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file GPG_export_public_key.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/GPG_export_public_key.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/GPG/,\n    q/export_public_key/,\n    {\n        'key_id' => '48BEA5A16FCA746E',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file GPG_export_public_key.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/GPG_export_public_key.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'GPG',\n    'export_public_key',\n    array (\n        'key_id' => '48BEA5A16FCA746E',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/GPG/export_secret_key":{"get":{"description":"This function exports a GnuPG (GPG) secret key.","operationId":"export_secret_key","parameters":[{"description":"The ID of the GPG secret key that you wish to retrieve.","in":"query","name":"key_id","required":true,"schema":{"example":"48BEA5A16FCA746E","type":"string"}},{"description":"The passphrase of the GPG secret key that you wish to retrieve.","in":"query","name":"passphrase","required":false,"schema":{"example":"whatever","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"export_secret_key","type":"string"},"module":{"description":"The name of the module called.","example":"GPG","type":"string"},"result":{"properties":{"data":{"properties":{"key_data":{"description":"The GPG key's contents.","example":"-----BEGIN PGP PRIVATE KEY BLOCK-----\nVersion: GnuPG v2.0.22 (GNU/Linux)\n\nlQNTBFzwFyMRCADgNf7GHvCgb2/HWBYVAzu408eXEO4ucWGfbD5c5BOHg7WBVOkh\nj+J0HYaeh9FwOXLJAzesiGtTU/HQ5wNkBbKRYR2oNEUbiefBgQhjllIGJNnFCQbD\nTcyxXjKUF4aQBw6InqzM9akVChLvGoCfom/y1fcwrQ5OQ46EEjhe9lSnj1E2DIi+\n0PvOsWeehChtn28WkmXPcl+XovfsCl5vh2RnJQeJwkSwBogA1GObj9fnPBbrIUt2\nF5JDaJ7/R8aDwV1Pg2mBmRqTBIKvx6gxEQgCL52OWCKVJfqy5oVGDl/2u0BGCaRt\n3Tnh9B14Lk8frBaOjYMtMq1Rl3rPDc3KCRnLAQC6dMNJCxIoyfeEFqj0HgwHETYn\nQNGwUaRrOGKLJbMnewf/Yq0S2R6YvMl8pDQeSExYJaqv/u2Hch6GM0f3CSvMnPSg\noB2c/h4MmhmiAbymSO5GBaM4Nx3NTNYU0JpghkTTJpucFZ8hK/aJ8PDQzBnS0zTY\nF8ZqSMFL84QB1NTd1nlJnilpKCkBC6NHUh76IyLQEsH7jgOG9L28qnLxm8bGHwaJ\nmhEH2Y859WzN9hUTZEMxdklI8uwdI+msI7md0uNYiWr5svtM+rrpU+LCZMG+nTCy\n6q0CNLXM0T0Fa642mYSqV307Ouv5rjGvfohIOo5X8ikBoEIOAQk6LX800OzzYGG4\nX75Q4irMuehEK3tId5VIRToy9MRLP6fyOVHwfhzD6Af/R2TJjIdEkEGdspuw9875\nN4z9xV2QNVNgURIOutrfeKSbb7gRLgV7TWpKWItMoEO1njzb4YqoHwcAASj4TDaT\niCYun6u12Mb97L0S3QDaD3sLk7P5sZvnO//k/YxbGISv+HGl5rSF87kVectLYpAL\nehL2EBmyxP4nxhSDOqhc0rbaqOZ+b4F1ns4NsUJjxIqQJZ+ovTqkmKnh3YbBeMAb\nsPcjyfQNmYE9qFXw17vJMm6ypNsuDIvxKCDq4QpO3/MujYX0Hg7aGOq4aWtndcL0\nPfpukTLvTA+AedMj+0QHWiP15bSxCJKqa0O62mKWnrzL0Tju8FKTwVHgRoW57GY/\nZQABALMunDJSN+b/VyFzqifGvopLxJFqA4un4WjGEY9jvJooD7e0JmJlbmRlciAo\naXMgZ3JlYXQpIDxiZW5kZXJAZXhhbXBsZS5jb20+iIEEExEIACkFAlzwFyMCGyMF\nCQHhM4AHCwkIBwMCAQYVCAIJCgsEFgIDAQIeAQIXgAAKCRBIvqWhb8p0bgAlAP9f\n7rAobi4nA8AmwZSaXGFmgJLeGwuM/sBQDjSp8MJR6AEAqtxkTLaOApKAeqStWYfr\nOUoraI1BayhI/AiTZAEDhmidAj0EXPAXIxAIAOAmNwCp5CL0s33LBQn9TZmYqUBi\nwobN4iIamtzT4qKWKWDDU3QmZJAzEgzONPnfy7YaWJ282FYDwTfThTHS/53X/8rt\nIzxGRNbhKcbx9V/8diHnDMu8JudbrMaQVsEsOwUy3wPQEsw7R/H55IndqmNienzV\nmQwOcKzUeGrlSg5KirGrTAu+RpB3E9jXry3YfErmB+tJELJrwzpLhOLnyMM5Z0OB\nxSrGE8Z+kCEGNfHp7buet3/kQqFAjb9idM8Vxc78vnqOevPlIceCK8/TkETVIf/N\nmthxddKFL5DxLQg5TMvICEhKp1NYtkcvCLG1K74c/psucm+Rpmc/sTilk4sAAwUH\n/2DmCrxyFsOP77Gy1DzJow3TH7J09IWg5S3qwkh4WPmS82EHc/+4QuELf+RL2hnl\n5MAD869E+D71TkFFAIrJLwzUnGEMUuSscqxwKqCpBeBAyfTMig6hDenRfSAzsbgN\nYNHDl+0xz5txo0YdwYzmh5zeY1ysE/OQrO4Y+7tavQpufUVMycESssaPXkd6STEf\nvBNFVvKEXv+zv0L4eeEoQ+zZH4FISFnK4kfTI6BqdIJ6Qjh+di633XMwiMwKFAuE\nNyZvNLAnmQKn+AjR2dE8asbsBvmZH2wgVYjOE1VwxLnwOCBDTJhLtmzVgy5Ea6zZ\nnvkuBxHjUbkoPBDqRVLsDyMAAVIC+56gmf2bW2mDuoFFUW6KT6jorvvbmXSZHi1L\nAGhQj/Q83gRejq2g+DYiFlCIZwQYEQgADwUCXPAXIwIbDAUJAeEzgAAKCRBIvqWh\nb8p0btGLAPsFHEqEg/qrEpjFu/9B8KvBWBgqIJm9XtDgaVaaHjzR4AD/XcrEvMuc\nPVYssXICwKbDwxWEYqhpI6ms0IOob0PH8hE=\n=W2NA\n-----END PGP PRIVATE KEY BLOCK-----","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success.\n- 0 - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Export GnuPG secret key","tags":["GPG","Signing and Encryption (GnuPG Keys)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  GPG \\\n  export_secret_key \\\n  key_id='48BEA5A16FCA746E'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/GPG/export_secret_key?key_id=48BEA5A16FCA746E"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file GPG_export_secret_key.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/GPG_export_secret_key.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/GPG/,\n    q/export_secret_key/,\n    {\n        'key_id' => '48BEA5A16FCA746E',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file GPG_export_secret_key.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/GPG_export_secret_key.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'GPG',\n    'export_secret_key',\n    array (\n        'key_id' => '48BEA5A16FCA746E',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/GPG/import_key":{"get":{"description":"This function imports a GnuPG (GPG) key.","operationId":"import_key","parameters":[{"description":"The key to import.\n\n**Note:**\n\nYou must URI-encode this value.","in":"query","name":"key_data","required":true,"schema":{"example":"%0A-----BEGIN%20PGP%20PUBLIC%20KEY%20BLOCK-----%0AVersion%3A%20GnuPG%20v2.0.14%20(GNU%2FLinux)%0A%0AmQENBFN0%2BOsBCADoFvyf8gHIKZ%2F%2B5KwbWb3Ht%2Fz1ukyQqFNGpBVIqHossmjmyF9e%0APn6iiZ0fHnt7r6XGGXaP%2BKKjIxAcqOTiFiP%2BHIx6GQubzVih6Ol0YNjzmK%2Ft4f%2B4%0AfSElEVnyzeyJa4LmC%2Fui%2FvvtptJ8JX6su7f11BwUTSyuqnk204AfN5uVpAcZNPT0%0A0qNNky1bxYvPUxU6Imvi1q3NtpFzqsQ4u%2FyZuLpUe7uwmgMPeO0lAms1kCa3Guot%0A3mfSt0vrUAMdcV4drY1FGtYZdYSa4rSTzpFuB7o9Ze%2BE3fUbCWs1%2B0FiN3JQNGO1%0AS2lnqjEqbpz2nHtA50elJRGqxZLEi8zkFqlTABEBAAG0Z2NQYW5lbCBTZWN1cml0%0AeSBUZWFtIC0gVEVTVCAoVEhJUyBJUyBBIFRFU1QgS0VZOyBETyBOT1QgVVNFIEZP%0AUiBBTllUSElORyBSRUFMISkgPHNlY3RlYW1zaXhAY3BhbmVsLm5ldD6JAT4EEwEC%0AACgFAlN0%2BOsCGwMFCQHhM4AGCwkIBwMCBhUIAgkKCwQWAgMBAh4BAheAAAoJEOhU%0A60c9RtoRkhMIAIe2yDKj55mGD3zbuGqxx6NNNIyiuEujw31N8yOS9BKTqGtIiK9i%0AGu4lzrzmHISKi0rjKmJdbckap7OouUoo9WR3ewjN6S5EHyjKfrrMwMzTWMPZOkTj%0A7A698X0vGc9yZ6KyBj8mM8J9duvNtRS285hfXfQxYO%2FuiyrJGBedI%2FWVZ3a7mcfq%0A7FhC8t6jU6sz9uIvYHAzywcVdmhEK5rS%2FuE%2F9e37h46jn2%2BkzlIWEe%2FYgpa%2BuWdT%0AO%2BOyqteW51LEjXLWMyP8AJEq8EoqbqKnm4Q1g0etOQ9trrkLUnPxaSwD5R6i4KLH%0AMR%2Fh7m%2FOoz8yOhUlrCGJwX7v9qDEdaYYFLQ%3D%0A%3DMEFZ%0A-----END%20PGP%20PUBLIC%20KEY%20BLOCK-----%0A","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"import_key","type":"string"},"module":{"description":"The name of the module called.","example":"GPG","type":"string"},"result":{"properties":{"data":{"properties":{"key_id":{"description":"The key's ID.","example":"59E79B6904616529","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Import GnuPG key","tags":["GPG","Signing and Encryption (GnuPG Keys)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  GPG \\\n  import_key \\\n  key_data='%0A-----BEGIN%20PGP%20PUBLIC%20KEY%20BLOCK-----%0AVersion%3A%20GnuPG%20v2.0.14%20(GNU%2FLinux)%0A%0AmQENBFN0%2BOsBCADoFvyf8gHIKZ%2F%2B5KwbWb3Ht%2Fz1ukyQqFNGpBVIqHossmjmyF9e%0APn6iiZ0fHnt7r6XGGXaP%2BKKjIxAcqOTiFiP%2BHIx6GQubzVih6Ol0YNjzmK%2Ft4f%2B4%0AfSElEVnyzeyJa4LmC%2Fui%2FvvtptJ8JX6su7f11BwUTSyuqnk204AfN5uVpAcZNPT0%0A0qNNky1bxYvPUxU6Imvi1q3NtpFzqsQ4u%2FyZuLpUe7uwmgMPeO0lAms1kCa3Guot%0A3mfSt0vrUAMdcV4drY1FGtYZdYSa4rSTzpFuB7o9Ze%2BE3fUbCWs1%2B0FiN3JQNGO1%0AS2lnqjEqbpz2nHtA50elJRGqxZLEi8zkFqlTABEBAAG0Z2NQYW5lbCBTZWN1cml0%0AeSBUZWFtIC0gVEVTVCAoVEhJUyBJUyBBIFRFU1QgS0VZOyBETyBOT1QgVVNFIEZP%0AUiBBTllUSElORyBSRUFMISkgPHNlY3RlYW1zaXhAY3BhbmVsLm5ldD6JAT4EEwEC%0AACgFAlN0%2BOsCGwMFCQHhM4AGCwkIBwMCBhUIAgkKCwQWAgMBAh4BAheAAAoJEOhU%0A60c9RtoRkhMIAIe2yDKj55mGD3zbuGqxx6NNNIyiuEujw31N8yOS9BKTqGtIiK9i%0AGu4lzrzmHISKi0rjKmJdbckap7OouUoo9WR3ewjN6S5EHyjKfrrMwMzTWMPZOkTj%0A7A698X0vGc9yZ6KyBj8mM8J9duvNtRS285hfXfQxYO%2FuiyrJGBedI%2FWVZ3a7mcfq%0A7FhC8t6jU6sz9uIvYHAzywcVdmhEK5rS%2FuE%2F9e37h46jn2%2BkzlIWEe%2FYgpa%2BuWdT%0AO%2BOyqteW51LEjXLWMyP8AJEq8EoqbqKnm4Q1g0etOQ9trrkLUnPxaSwD5R6i4KLH%0AMR%2Fh7m%2FOoz8yOhUlrCGJwX7v9qDEdaYYFLQ%3D%0A%3DMEFZ%0A-----END%20PGP%20PUBLIC%20KEY%20BLOCK-----%0A'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/GPG/import_key?key_data=%250A-----BEGIN%2520PGP%2520PUBLIC%2520KEY%2520BLOCK-----%250AVersion%253A%2520GnuPG%2520v2.0.14%2520%28GNU%252FLinux%29%250A%250AmQENBFN0%252BOsBCADoFvyf8gHIKZ%252F%252B5KwbWb3Ht%252Fz1ukyQqFNGpBVIqHossmjmyF9e%250APn6iiZ0fHnt7r6XGGXaP%252BKKjIxAcqOTiFiP%252BHIx6GQubzVih6Ol0YNjzmK%252Ft4f%252B4%250AfSElEVnyzeyJa4LmC%252Fui%252FvvtptJ8JX6su7f11BwUTSyuqnk204AfN5uVpAcZNPT0%250A0qNNky1bxYvPUxU6Imvi1q3NtpFzqsQ4u%252FyZuLpUe7uwmgMPeO0lAms1kCa3Guot%250A3mfSt0vrUAMdcV4drY1FGtYZdYSa4rSTzpFuB7o9Ze%252BE3fUbCWs1%252B0FiN3JQNGO1%250AS2lnqjEqbpz2nHtA50elJRGqxZLEi8zkFqlTABEBAAG0Z2NQYW5lbCBTZWN1cml0%250AeSBUZWFtIC0gVEVTVCAoVEhJUyBJUyBBIFRFU1QgS0VZOyBETyBOT1QgVVNFIEZP%250AUiBBTllUSElORyBSRUFMISkgPHNlY3RlYW1zaXhAY3BhbmVsLm5ldD6JAT4EEwEC%250AACgFAlN0%252BOsCGwMFCQHhM4AGCwkIBwMCBhUIAgkKCwQWAgMBAh4BAheAAAoJEOhU%250A60c9RtoRkhMIAIe2yDKj55mGD3zbuGqxx6NNNIyiuEujw31N8yOS9BKTqGtIiK9i%250AGu4lzrzmHISKi0rjKmJdbckap7OouUoo9WR3ewjN6S5EHyjKfrrMwMzTWMPZOkTj%250A7A698X0vGc9yZ6KyBj8mM8J9duvNtRS285hfXfQxYO%252FuiyrJGBedI%252FWVZ3a7mcfq%250A7FhC8t6jU6sz9uIvYHAzywcVdmhEK5rS%252FuE%252F9e37h46jn2%252BkzlIWEe%252FYgpa%252BuWdT%250AO%252BOyqteW51LEjXLWMyP8AJEq8EoqbqKnm4Q1g0etOQ9trrkLUnPxaSwD5R6i4KLH%250AMR%252Fh7m%252FOoz8yOhUlrCGJwX7v9qDEdaYYFLQ%253D%250A%253DMEFZ%250A-----END%2520PGP%2520PUBLIC%2520KEY%2520BLOCK-----%250A"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file GPG_import_key.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/GPG_import_key.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/GPG/,\n    q/import_key/,\n    {\n        'key_data' => '%0A-----BEGIN%20PGP%20PUBLIC%20KEY%20BLOCK-----%0AVersion%3A%20GnuPG%20v2.0.14%20(GNU%2FLinux)%0A%0AmQENBFN0%2BOsBCADoFvyf8gHIKZ%2F%2B5KwbWb3Ht%2Fz1ukyQqFNGpBVIqHossmjmyF9e%0APn6iiZ0fHnt7r6XGGXaP%2BKKjIxAcqOTiFiP%2BHIx6GQubzVih6Ol0YNjzmK%2Ft4f%2B4%0AfSElEVnyzeyJa4LmC%2Fui%2FvvtptJ8JX6su7f11BwUTSyuqnk204AfN5uVpAcZNPT0%0A0qNNky1bxYvPUxU6Imvi1q3NtpFzqsQ4u%2FyZuLpUe7uwmgMPeO0lAms1kCa3Guot%0A3mfSt0vrUAMdcV4drY1FGtYZdYSa4rSTzpFuB7o9Ze%2BE3fUbCWs1%2B0FiN3JQNGO1%0AS2lnqjEqbpz2nHtA50elJRGqxZLEi8zkFqlTABEBAAG0Z2NQYW5lbCBTZWN1cml0%0AeSBUZWFtIC0gVEVTVCAoVEhJUyBJUyBBIFRFU1QgS0VZOyBETyBOT1QgVVNFIEZP%0AUiBBTllUSElORyBSRUFMISkgPHNlY3RlYW1zaXhAY3BhbmVsLm5ldD6JAT4EEwEC%0AACgFAlN0%2BOsCGwMFCQHhM4AGCwkIBwMCBhUIAgkKCwQWAgMBAh4BAheAAAoJEOhU%0A60c9RtoRkhMIAIe2yDKj55mGD3zbuGqxx6NNNIyiuEujw31N8yOS9BKTqGtIiK9i%0AGu4lzrzmHISKi0rjKmJdbckap7OouUoo9WR3ewjN6S5EHyjKfrrMwMzTWMPZOkTj%0A7A698X0vGc9yZ6KyBj8mM8J9duvNtRS285hfXfQxYO%2FuiyrJGBedI%2FWVZ3a7mcfq%0A7FhC8t6jU6sz9uIvYHAzywcVdmhEK5rS%2FuE%2F9e37h46jn2%2BkzlIWEe%2FYgpa%2BuWdT%0AO%2BOyqteW51LEjXLWMyP8AJEq8EoqbqKnm4Q1g0etOQ9trrkLUnPxaSwD5R6i4KLH%0AMR%2Fh7m%2FOoz8yOhUlrCGJwX7v9qDEdaYYFLQ%3D%0A%3DMEFZ%0A-----END%20PGP%20PUBLIC%20KEY%20BLOCK-----%0A',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file GPG_import_key.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/GPG_import_key.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'GPG',\n    'import_key',\n    array (\n        'key_data' => '%0A-----BEGIN%20PGP%20PUBLIC%20KEY%20BLOCK-----%0AVersion%3A%20GnuPG%20v2.0.14%20(GNU%2FLinux)%0A%0AmQENBFN0%2BOsBCADoFvyf8gHIKZ%2F%2B5KwbWb3Ht%2Fz1ukyQqFNGpBVIqHossmjmyF9e%0APn6iiZ0fHnt7r6XGGXaP%2BKKjIxAcqOTiFiP%2BHIx6GQubzVih6Ol0YNjzmK%2Ft4f%2B4%0AfSElEVnyzeyJa4LmC%2Fui%2FvvtptJ8JX6su7f11BwUTSyuqnk204AfN5uVpAcZNPT0%0A0qNNky1bxYvPUxU6Imvi1q3NtpFzqsQ4u%2FyZuLpUe7uwmgMPeO0lAms1kCa3Guot%0A3mfSt0vrUAMdcV4drY1FGtYZdYSa4rSTzpFuB7o9Ze%2BE3fUbCWs1%2B0FiN3JQNGO1%0AS2lnqjEqbpz2nHtA50elJRGqxZLEi8zkFqlTABEBAAG0Z2NQYW5lbCBTZWN1cml0%0AeSBUZWFtIC0gVEVTVCAoVEhJUyBJUyBBIFRFU1QgS0VZOyBETyBOT1QgVVNFIEZP%0AUiBBTllUSElORyBSRUFMISkgPHNlY3RlYW1zaXhAY3BhbmVsLm5ldD6JAT4EEwEC%0AACgFAlN0%2BOsCGwMFCQHhM4AGCwkIBwMCBhUIAgkKCwQWAgMBAh4BAheAAAoJEOhU%0A60c9RtoRkhMIAIe2yDKj55mGD3zbuGqxx6NNNIyiuEujw31N8yOS9BKTqGtIiK9i%0AGu4lzrzmHISKi0rjKmJdbckap7OouUoo9WR3ewjN6S5EHyjKfrrMwMzTWMPZOkTj%0A7A698X0vGc9yZ6KyBj8mM8J9duvNtRS285hfXfQxYO%2FuiyrJGBedI%2FWVZ3a7mcfq%0A7FhC8t6jU6sz9uIvYHAzywcVdmhEK5rS%2FuE%2F9e37h46jn2%2BkzlIWEe%2FYgpa%2BuWdT%0AO%2BOyqteW51LEjXLWMyP8AJEq8EoqbqKnm4Q1g0etOQ9trrkLUnPxaSwD5R6i4KLH%0AMR%2Fh7m%2FOoz8yOhUlrCGJwX7v9qDEdaYYFLQ%3D%0A%3DMEFZ%0A-----END%20PGP%20PUBLIC%20KEY%20BLOCK-----%0A',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/GPG/list_public_keys":{"get":{"description":"This function lists the GnuPG (GPG) public keys for the\ncurrently-authenticated account.","operationId":"list_public_keys","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_public_keys","type":"string"},"module":{"description":"The name of the module called.","example":"GPG","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"algorithm":{"description":"The key's algorithm.\n* RSA\n* DSA","enum":["RSA","DSA"],"example":"DSA","type":"string"},"bits":{"description":"The length of the key, in bits.","enum":[1024,2048,3072,4096],"example":2048,"maximum":4096,"minimum":1024,"type":"integer"},"created":{"description":"The creation time for the key,\nin [Unix time format](http://en.wikipedia.org/wiki/Unix_time).","example":"1559238435","type":"string"},"expires":{"description":"When the key will expire,\nin [Unix time format](http://en.wikipedia.org/wiki/Unix_time).\n\n**Note:**\n\nIf the key does not expire,\nthis will be an empty string.","example":"1590774435","type":"string"},"id":{"description":"The key's ID.","example":"C801294347601B8F","type":"string"},"type":{"description":"The type of key.\n\n**Note:**\n\nThis will always be \"pub\" because we are listing public keys.","enum":["pub"],"example":"pub","type":"string"},"user_id":{"description":"The user ID of the key which consists of the following space-separated values:\n* The username.\n* The key's comment in parentheses.\n* The key's email address in angle brackets (<>).","example":"bender (is great) <bender@example.com>","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` - Success\n- `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return current user's GnuPG public keys","tags":["GPG","Signing and Encryption (GnuPG Keys)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  GPG \\\n  list_public_keys\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/GPG/list_public_keys"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file GPG_list_public_keys.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/GPG_list_public_keys.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/GPG/,\n    q/list_public_keys/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file GPG_list_public_keys.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/GPG_list_public_keys.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'GPG',\n    'list_public_keys'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/GPG/list_secret_keys":{"get":{"description":"This function lists the GnuPG (GPG) secret keys for the currently-authenticated account.","operationId":"list_secret_keys","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_secret_keys","type":"string"},"module":{"description":"The name of the module called.","example":"GPG","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"algorithm":{"description":"The key's algorithm.\n* `RSA`\n* `DSA`","enum":["RSA","DSA"],"example":"DSA","type":"string"},"bits":{"description":"The key's length.","example":2048,"maximum":4096,"minimum":1024,"multipleOf":1024,"type":"integer"},"created":{"description":"When the function created the key.","example":1559238435,"format":"unix_timestamp","type":"integer"},"expires":{"description":"When the key will expire.","example":1590774435,"format":"unix_timestamp","type":"integer"},"id":{"description":"The key's ID.","example":"738538C1","type":"string"},"type":{"description":"The type of key.\n\n* `sec` is the only possible value.","enum":["sec"],"example":"sec","type":"string"},"user_id":{"description":"The user ID of the key. The system returns this value as a space-separated string with the following values:\n\n* The username.\n* A comment in parentheses.\n* The key's email address in angle brackets (`<>`).","example":"username (John Doe) <username@example.com>","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — `Success`.\n* `0` — `Failed`. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return current user's GnuPG secret keys","tags":["GPG","Signing and Encryption (GnuPG Keys)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  GPG \\\n  list_secret_keys\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/GPG/list_secret_keys"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file GPG_list_secret_keys.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/GPG_list_secret_keys.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/GPG/,\n    q/list_secret_keys/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file GPG_list_secret_keys.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/GPG_list_secret_keys.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'GPG',\n    'list_secret_keys'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/ImageManager/convert_file":{"get":{"description":"This function converts an image to a new file format.\n\n**Important:**\n\nWhen you disable the [WebServer role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.","operationId":"convert_file","parameters":[{"description":"The image file to convert, relative to the cPanel account's `/home` directory.","in":"query","name":"image_file","required":true,"schema":{"example":"images/myimage.jpg","type":"string"}},{"description":"The format to which to convert the images.","in":"query","name":"type","required":true,"schema":{"example":"png","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"convert_file","type":"string"},"module":{"description":"The name of the module called.","example":"ImageManager","type":"string"},"result":{"properties":{"data":{"properties":{"converted_file":{"description":"The new absolute filepath to the image.","example":"/home/cptest1/images/myimage.png","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* 1 — Success.\n* 0 — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create image with new format","tags":["ImageManager","Image Tools"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  ImageManager \\\n  convert_file \\\n  image_file='images/myimage.jpg' \\\n  type='png'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/ImageManager/convert_file?image_file=images%2fmyimage.jpg&type=png"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file ImageManager_convert_file.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/ImageManager_convert_file.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/ImageManager/,\n    q/convert_file/,\n    {\n        'image_file' => 'images/myimage.jpg',\n        'type' => 'png',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file ImageManager_convert_file.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/ImageManager_convert_file.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'ImageManager',\n    'convert_file',\n    array (\n        'image_file' => 'images/myimage.jpg',\n        'type' => 'png',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/ImageManager/create_thumbnails":{"get":{"description":"This function creates thumbnails from images. The function saves the new thumbnail images in a thumbnails subdirectory inside the original directory. The system prepends thumbnail filenames with ``tn_`` (for example, ``tn_picture.jpg``).\n\n**Important:**\n\nWhen you disable the [WebServer role](https://go.cpanel.net/serverroles), the system disables this function.","operationId":"create_thumbnails","parameters":[{"description":"The path to the directory where the image resides. When you pass this parameter, the function creates a thumbnail directory directly below the image directory.\n\n**NOTE:**\n\nThis parameter can use an absolute directory path or a path relative to the user's home directory.","in":"query","name":"dir","required":true,"schema":{"example":"images","type":"string"}},{"description":"The percentage by which to reduce the thumbnails' width.","in":"query","name":"width_percentage","required":true,"schema":{"example":25,"maximum":99,"minimum":1,"type":"integer"}},{"description":"The percentage by which to reduce the thumbnails' height.","in":"query","name":"height_percentage","required":true,"schema":{"example":25,"maximum":99,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"create_thumbnails","type":"string"},"module":{"description":"The name of the module called.","example":"ImageManager","type":"string"},"result":{"properties":{"data":{"description":"An array of objects containing thumbnail file information.","items":{"properties":{"failed":{"description":"Whether the function failed to create the thumbnail file.\n\n**Note:**\n\n * The function **only** returns this value if it doesn't create the thumbnail.\n * `1` is the **only** possible value.","enum":[1],"example":1,"type":"integer"},"file":{"description":"The file from which the function generated the thumbnail file. An absolute filepath.","example":"/home/cptest1/public_html/images/610_290.jpg","type":"string"},"reason":{"description":"The reason that the function didn't create the thumbnail file.\n\n**Note:**\n\n The function only returns this value if it doesn't create the thumbnail.","example":"too many pixels","type":"string"},"thumbnail_file":{"description":"The thumbnail file that the function generated. An absolute filepath.","example":"/home/cptest1/public_html/images/thumbnails/tn_610_290.jpg","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success.\n- 0 - Failed. Check the ``errors`` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create image thumbnails","tags":["ImageManager","Image Tools"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  ImageManager \\\n  create_thumbnails \\\n  dir='images' \\\n  width_percentage='25' \\\n  height_percentage='25'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/ImageManager/create_thumbnails?dir=images&width_percentage=25&height_percentage=25"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file ImageManager_create_thumbnails.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/ImageManager_create_thumbnails.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/ImageManager/,\n    q/create_thumbnails/,\n    {\n        'dir' => 'images',\n        'width_percentage' => '25',\n        'height_percentage' => '25',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file ImageManager_create_thumbnails.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/ImageManager_create_thumbnails.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'ImageManager',\n    'create_thumbnails',\n    array (\n        'dir' => 'images',\n        'width_percentage' => '25',\n        'height_percentage' => '25',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/GPG/generate_key":{"get":{"description":"This function generates a GnuPG (GPG) key. The system saves the key in the user's `.gnupg` directory.\n\n**Note:**\n\nThis function uses [the system's entropy](https://en.wikipedia.org/wiki/Entropy_(computing)) to generate the key. Systems with low entropy levels may cause long generation times or timeouts.","operationId":"generate_key","parameters":[{"description":"The name of the user for whom to generate the key.","in":"query","name":"name","required":true,"schema":{"example":"username","format":"username","type":"string"}},{"description":"A comment about the key.","in":"query","name":"comment","required":false,"schema":{"default":null,"example":"Username's Key","type":"string"}},{"description":"The user's email address.","in":"query","name":"email","required":true,"schema":{"example":"user@example.com","format":"email","type":"string"}},{"description":"The desired expiration date of the key\nas a timestamp in [Unix time format](http://en.wikipedia.org/wiki/Unix_time).\n\n**Note:**\n\nThis will default to one year from the current date.","in":"query","name":"expire","required":false,"schema":{"example":"1560363242","type":"string"}},{"description":"Whether to generate the key without an expiration date.\n\n* `0` - The key will expire.\n* `1` - The key will **not** expire.","in":"query","name":"no_expire","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"The new key's size, in bytes.\n\n**Note:**\n\nLarge keys require more time to generate.","in":"query","name":"keysize","required":false,"schema":{"default":2048,"enum":[1024,2048,3072,4096],"example":2048,"maximum":4096,"minimum":1024,"type":"integer"}},{"description":"The key's password.","in":"query","name":"passphrase","required":true,"schema":{"default":null,"example":"123456luggage","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"generate_key","type":"string"},"module":{"description":"The name of the module called.","example":"GPG","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` - Success.\n- `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create GnuPG key","tags":["GPG","Signing and Encryption (GnuPG Keys)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  GPG \\\n  generate_key \\\n  name='username' \\\n  email='user@example.com'\n  passphrase='123456luggage'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/GPG/generate_key?name=username&email=user%40example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file GPG_generate_key.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/GPG_generate_key.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/GPG/,\n    q/generate_key/,\n    {\n        'name' => 'username',\n        'email' => 'user@example.com',\n        'passphrase' => '123456luggage',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file GPG_generate_key.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/GPG_generate_key.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'GPG',\n    'generate_key',\n    array (\n        'name' => 'username',\n        'email' => 'user@example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/ImageManager/get_dimensions":{"get":{"description":"This function returns the dimensions of the image file that you specify.\n\n**Important:**\n\nWhen you disable the [WebServer role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.","operationId":"get_dimensions","parameters":[{"description":"The path to the file to measure.\n\n**Note:**\n\nUse the absolute filepath or a path relative to the user's home directory.","in":"query","name":"image_file","required":true,"schema":{"example":"image/myimage.jpg","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_dimensions","type":"string"},"module":{"description":"The name of the module called.","example":"ImageManager","type":"string"},"result":{"properties":{"data":{"properties":{"height":{"description":"The image's height, in pixels.","example":300,"minimum":1,"type":"integer"},"width":{"description":"The image's width, in pixels.","example":261,"minimum":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return image dimensions","tags":["ImageManager","Image Tools"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  ImageManager \\\n  get_dimensions \\\n  image_file='image/myimage.jpg'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/ImageManager/get_dimensions?image_file=image%2fmyimage.jpg"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file ImageManager_get_dimensions.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/ImageManager_get_dimensions.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/ImageManager/,\n    q/get_dimensions/,\n    {\n        'image_file' => 'image/myimage.jpg',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file ImageManager_get_dimensions.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/ImageManager_get_dimensions.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'ImageManager',\n    'get_dimensions',\n    array (\n        'image_file' => 'image/myimage.jpg',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/ImageManager/resize_image":{"get":{"description":"This function resizes a specified image.\n\n**Important:**\n\nWhen you disable the [WebServer role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.","operationId":"resize_image","parameters":[{"description":"The name of the file to scale.\n\n**Note:**\n\nUse the absolute filepath or a filepath relative to the user's home directory.","in":"query","name":"image_file","required":true,"schema":{"example":"/images/image.jpg","type":"string"}},{"description":"The width to which to set the image size.","in":"query","name":"width","required":true,"schema":{"example":200,"minimum":1,"type":"integer"}},{"description":"The height to which to set the image size.","in":"query","name":"height","required":true,"schema":{"example":300,"minimum":1,"type":"integer"}},{"description":"The path to the directory in which to save a copy the original\nimage file.\n\n**Note:**\n\n* If you don't pass this parameter, the function doesn't save\na copy of the original image.\n* Use the absolute filepath or a filepath relative to the user's home directory.","in":"query","name":"save_original_as","required":false,"schema":{"example":"images/original.jpg","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"resize_image","type":"string"},"module":{"description":"The name of the module called.","example":"ImageManager","type":"string"},"result":{"properties":{"data":{"description":"The absolute filepath to the resized image.","example":"/home/cptest1/images/myimage.jpg","type":"string"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Save resized image","tags":["ImageManager","Image Tools"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  ImageManager \\\n  resize_image \\\n  image_file='images/image.jpg' \\\n  width='200' \\\n  height='300'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/ImageManager/resize_image?image_file=%2fimages%2fimage.jpg&width=200&height=300"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file ImageManager_resize_image.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/ImageManager_resize_image.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/ImageManager/,\n    q/resize_image/,\n    {\n        'image_file' => '/images/image.jpg',\n        'width' => '200',\n        'height' => '300',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file ImageManager_resize_image.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/ImageManager_resize_image.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'ImageManager',\n    'resize_image',\n    array (\n        'image_file' => '/images/image.jpg',\n        'width' => '200',\n        'height' => '300',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/Integration/fetch_url":{"get":{"description":"This function returns the URL for an integrated application.","operationId":"fetch_url","parameters":[{"description":"The application's name.","in":"query","name":"app","required":true,"schema":{"example":"applicationname","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"fetch_url","type":"string"},"module":{"description":"The name of the module called.","example":"Integration","type":"string"},"result":{"properties":{"data":{"properties":{"redirect_url":{"description":"The publicly-available URL to which the application will redirect visitors.","example":"http://application.example.com/application","format":"url","type":"string"},"url":{"description":"The publicly-available URL to which the application redirects visitors if the `redirect_url` location is unavailable.","example":"http://application.example.com/","format":"url","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return integrated application URL","tags":["Integration","URL Parsing"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Integration \\\n  fetch_url \\\n  app='applicationname'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Integration/fetch_url?app=applicationname"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Integration_fetch_url.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Integration_fetch_url.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Integration/,\n    q/fetch_url/,\n    {\n        'app' => 'applicationname',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Integration_fetch_url.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Integration_fetch_url.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Integration',\n    'fetch_url',\n    array (\n        'app' => 'applicationname',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/KnownHosts/create":{"get":{"description":"This function registers a host in the cPanel account's `/home/user/.ssh/known_hosts` file.","operationId":"create","parameters":[{"description":"The hostname or IP address to add.","example":"hostname.example.com","in":"query","name":"host_name","required":true,"schema":{"oneOf":[{"description":"A valid hostname.","example":"hostname.example.com","format":"hostname","type":"string"},{"description":"A valid IP address.","example":"192.0.2.102","format":"ipv4","type":"string"}]}},{"description":"The SSH port to use, if the system uses a non-standard SSH port.","in":"query","name":"port","required":false,"schema":{"default":22,"example":1234,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"create","type":"string"},"module":{"description":"The name of the module called.","example":"KnownHosts","type":"string"},"result":{"properties":{"data":{"properties":{"host":{"description":"An array of objects containing information for the host.","items":{"properties":{"host":{"description":"The hostname or IP address.","example":"hostname.example.com","oneOf":[{"description":"A valid hostname.","example":"hostname.example.com","format":"hostname","type":"string"},{"description":"A valid IP address.","example":"192.0.2.102","format":"ipv4","type":"string"}]},"key":{"description":"The host's key.","example":"ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ==","type":"string"},"line":{"description":"The host's entry in the `/home/user/.ssh/known_hosts` file, where `user` is the cPanel account username.","example":"host.example.com ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ==","type":"string"},"meta":{"description":"An object containing metadata about the host's public key.","properties":{"algorithm":{"description":"The key's algorithm.","example":"ssh-rsa","type":"string"},"body":{"description":"The host's public key.","example":"AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ==","type":"string"},"md5":{"description":"The key's [MD5](https://en.wikipedia.org/wiki/MD5) fingerprint.","example":"b6030e39979ed0e724cea3773e014209","type":"string"},"md5-printable":{"description":"A human-readable version of the key's MD5 fingerprint.","example":"MD5:b6:03:0e:39:97:9e:d0:e7:24:ce:a3:77:3e:01:42:09","type":"string"},"sha256":{"description":"The key's [SHA-256](https://en.wikipedia.org/wiki/SHA-2)\nfingerprint.","example":"44e405bcf4e11ab5b846e58ba0bf6dabd23dcc9e367cae17cb0c91b5b 3b3fc44","type":"string"},"sha256-printable":{"description":"A human-readable version of the key's SHA-256 fingerprint.","example":"SHA256:ROQFvPThGrW4RuWLoL9tq9I9zJ42fK4XywyRtbOz/EQ","type":"string"}},"type":"object"}},"type":"object"},"type":"array"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create host","tags":["KnownHosts","Known SSH Hosts Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  KnownHosts \\\n  create \\\n  host_name='hostname.example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/KnownHosts/create?host_name=hostname.example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file KnownHosts_create.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/KnownHosts_create.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/KnownHosts/,\n    q/create/,\n    {\n        'host_name' => 'hostname.example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file KnownHosts_create.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/KnownHosts_create.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'KnownHosts',\n    'create',\n    array (\n        'host_name' => 'hostname.example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 74"}},"/KnownHosts/delete":{"get":{"description":"This function removes a host from the cPanel account's `/home/user/.ssh/known_hosts` file.","operationId":"KnownHosts::delete","parameters":[{"description":"The hostname or IP address of the host to delete.","in":"query","name":"host_name","required":true,"schema":{"example":"host.example.com","oneOf":[{"format":"hostname","type":"string"},{"format":"ipv4","type":"string"}]}},{"description":"The SSH port to use.","in":"query","name":"port","required":false,"schema":{"default":22,"example":1234,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"delete","type":"string"},"module":{"description":"The name of the module called.","example":"KnownHosts","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete host","tags":["KnownHosts","Known SSH Hosts Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  KnownHosts \\\n  delete \\\n  host_name='host.example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/KnownHosts/delete?host_name=host.example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file KnownHosts_delete.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/KnownHosts_delete.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/KnownHosts/,\n    q/delete/,\n    {\n        'host_name' => 'host.example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file KnownHosts_delete.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/KnownHosts_delete.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'KnownHosts',\n    'delete',\n    array (\n        'host_name' => 'host.example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 74"}},"/KnownHosts/update":{"get":{"description":"This function updates a host's entry in the cPanel account's /home/user/.ssh/known_hosts file.","operationId":"KnownHosts::update","parameters":[{"description":"The host to update.","in":"query","name":"host_name","required":true,"schema":{"example":"host.example.com","oneOf":[{"format":"hostname","type":"string"},{"format":"ipv4","type":"string"}]}},{"description":"The SSH port to use.","in":"query","name":"port","required":false,"schema":{"default":22,"example":1234,"maximum":65535,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"update","type":"string"},"module":{"description":"The name of the module called.","example":"KnownHosts","type":"string"},"result":{"properties":{"data":{"properties":{"host":{"description":"An array of objects containing the host's information.","items":{"properties":{"host":{"description":"The updated host and its associated key value.","example":"host.example.com","oneOf":[{"format":"hostname","type":"string"},{"format":"ipv4","type":"string"}]},"key":{"description":"The host's key.","example":"ssh-rsa AAAAB3NzaC1yc2AEEEEDAQABAAABAQCsj2bNKTBSpIYDEGk9KxsGh3mySTRgMtXL583qmBpzeQ+jqCMRgBqB98u3z++J1sKlXHWfM9dyhSevkMwSbhoR8XIq/U0tCNyokEi/ueaBMCvbcTHhO7FcwzY92WK4Yt0aGROY5qX2UKSeOvuP4D6TPqKF1onSzH9bx9XUf2lEdWT/ia1NEKjunUqu1xOB/StKDHMoX4/OKyIzuS0q/T1zOATthvasJFoPrAjkohTyaDUz2LN5JoH839hViyEG82yB+MjcFV5MU3N1l1QL3cVUCh93xSaua1N85qivl+siMkPGbO5xR/En4iEY6K2XPASUEMaieWVNTRCtJ4S8H+9","type":"string"},"line":{"description":"The host's entry in the `/home/user/.ssh/known_hosts` file, where user is the cPanel account username. A valid entry that includes the hostname or IP address, the key's algorithm, and the public key.","example":"host.example.com ssh-rsa AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA","type":"string"},"meta":{"description":"An object containing metadata about the host's public key.","properties":{"algorithm":{"description":"The key's algorithm.","example":"ssh-rsa","type":"string"},"body":{"description":"The host's public key.","example":"EEEEB3NzaC1yc2EAAAADAQABAAABAQCsj2bNKTBSpIYDEGk9KxsGh3mySTRgMtXL583qmBpzeQ+jqCMRgBqB98u3z++J1sKlXHWfM9dyhSevkMwSbhoR8XIq/U0tCNyokEi/ueaBMCvbcTHhO7FcwzY92WK4Yt0aGROY5qX2UKSeOvuP4D6TPqKF1onrSzH9\\bx9XUf2lEdWT/ia1NEKjunUqu1xOB/StKDHMoX4/OKyIzuS0q/T1zOATthvasJFoPrAjkohTyaDUz2LN5JoH839hViyEG82yB+MjcFV5MU3N1l1QL3cVUCh93xSaua1N85qivl+siMkPGbO5xR/En4iEY6K2XPASUEMaieWVNTRCtJ4S8H+9","type":"string"},"md5":{"description":"The key's MD5 fingerprint.","example":"b6030e39868ed0e724cea3773e014219","type":"string"},"md5-printable":{"description":"A human-readable version of the key's MD5 fingerprint.","example":"MD5:b6:03:0e:39:97:2e:d0:e7:24:ab:c3:77:3d:01:42:09","type":"string"},"sha256":{"description":"The key's SHA-256 fingerprint.","example":"55a405bcf4e11ab5b846e58ba0bf6dabd23dcc9e367cae17cb0c91b5b3b3fc55","type":"string"},"sha256-printable":{"description":"human-readable version of the key's SHA-256 fingerprint.","example":"SHA256:RPLFvPThGrW4RuWLoL9tq9I9zJ42fK3XywyRtbOz/EQ","type":"string"}},"type":"object"}},"type":"object"},"type":"array"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` Success.\n* `0` Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update host in the known_hosts file","tags":["KnownHosts","Known SSH Hosts Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  KnownHosts \\\n  update \\\n  host_name='host.example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/KnownHosts/update?host_name=host.example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file KnownHosts_update.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/KnownHosts_update.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/KnownHosts/,\n    q/update/,\n    {\n        'host_name' => 'host.example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file KnownHosts_update.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/KnownHosts_update.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'KnownHosts',\n    'update',\n    array (\n        'host_name' => 'host.example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 74"}},"/KnownHosts/verify":{"get":{"description":"This function checks whether a host's public key exists in the cPanel account's `/home/user/.ssh/known_hosts` file.","operationId":"verify","parameters":[{"description":"The host to query.","in":"query","name":"host_name","required":true,"schema":{"example":"host.example.com","oneOf":[{"format":"ipv4","type":"string"},{"format":"domain","type":"string"}]}},{"description":"The SSH port to use.","in":"query","name":"port","required":false,"schema":{"default":22,"example":1234,"maximum":65535,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"verify","type":"string"},"module":{"description":"The name of the module called.","example":"KnownHosts","type":"string"},"result":{"properties":{"data":{"properties":{"errors":{"description":"An array of errors that the system generated.","items":{"example":"The example.com host does not exist in the known_hosts file.","type":"string"},"type":"array"},"failure_type":{"description":"The reason why the system will register the hostname.\n* `new` — The host does **not** already exist.\n* `changed` — The host's information has changed.","enum":["new","changed"],"example":"new","type":"string"},"host":{"description":"An array of objects that contain information about the host.","items":{"properties":{"host":{"description":"The hostname or IP address.","example":"host.example.com","oneOf":[{"format":"ipv4","type":"string"},{"format":"domain","type":"string"}]},"key":{"description":"The host's key.","example":"ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ==","type":"string"},"line":{"description":"The host's entry in the `/home/user/.ssh/known_hosts` file, where `user` is the cPanel account username.","example":"host.example.com ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ==","type":"string"},"meta":{"description":"An object that contains information about the host's public key.","properties":{"algorithm":{"description":"The key's algorithm.","example":"ssh-rsa","type":"string"},"body":{"description":"The host's public key. public key.","example":"AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ==","type":"string"},"md5":{"description":"The key's [MD5](https://en.wikipedia.org/wiki/MD5) fingerprint.","example":"b6030e39979ed0e724cea3773e014209","type":"string"},"md5-printable":{"description":"A human-readable version of the key's MD5 fingerprint.","example":"MD5:b6:03:0e:39:97:9e:d0:e7:24:ce:a3:77:3e:01:42:09","type":"string"},"sha256":{"description":"The key's [SHA-256](https://en.wikipedia.org/wiki/SHA-2) fingerprint.","example":"44e405bcf4e11ab5b846e58ba0bf6dabd23dcc9e367cae17cb0c91b5b3b3fc44","type":"string"},"sha256-printable":{"description":"A human-readable version of the key's SHA-256 fingerprint.","example":"SHA256:ROQFvPThGrW4RuWLoL9tq9I9zJ42fK4XywyRtbOz/EQ","type":"string"}},"type":"object"}},"type":"object"},"type":"array"},"status":{"description":"Whether the host already exists in the `/home/user/.ssh/known_hosts` file, where `user` is the cPanel account username.\n* `1` — Exists.\n* `0` — The host does **not** already exist, or the system must re-register the hostname.","enum":[0,1],"example":0,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Validate host","tags":["KnownHosts","Known SSH Hosts Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  KnownHosts \\\n  verify \\\n  host_name='host.example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/KnownHosts/verify?host_name=host.example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file KnownHosts_verify.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/KnownHosts_verify.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/KnownHosts/,\n    q/verify/,\n    {\n        'host_name' => 'host.example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file KnownHosts_verify.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/KnownHosts_verify.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'KnownHosts',\n    'verify',\n    array (\n        'host_name' => 'host.example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 74"}},"/LangPHP/php_get_domain_handler":{"get":{"description":"This function returns a PHP version's assigned PHP handler.\n\n**Note:**\n\n  This document **only** applies to systems that run EasyApache 4.\n\n**Important:**\n\n  When you disable the [WebServer role](https://go.cpanel.net/howtouseserverprofiles#roles), the system disables this function. For more information, read our How to Use Server Profiles documentation.","operationId":"php_get_domain_handler","parameters":[{"description":"The type of `php.ini` file.\n\n* `home`\n* `vhost`\n\n**Important:**\n\n * If you set this parameter to `vhost`, you **must** also include the vhost parameter.\n * If you set this parameter to `home`, the system returns the system default PHP handler.","in":"query","name":"type","required":true,"schema":{"enum":["home","vhost"],"example":"vhost","type":"string"}},{"description":"The name of a virtual host.\n\n**Important:**\n\n If the `type` value is `vhost`, you **must** use this parameter.","in":"query","name":"vhost","required":false,"schema":{"example":"clearly.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"php_get_domain_handler","type":"string"},"module":{"description":"The name of the module called.","example":"LangPHP","type":"string"},"result":{"properties":{"data":{"properties":{"php_handler":{"description":"The virtual host's PHP handler.","example":"cgi","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return PHP version's handler","tags":["LangPHP","PHP Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  LangPHP \\\n  php_get_domain_handler \\\n  type='vhost'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/LangPHP/php_get_domain_handler?type=vhost"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file LangPHP_php_get_domain_handler.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/LangPHP_php_get_domain_handler.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/LangPHP/,\n    q/php_get_domain_handler/,\n    {\n        'type' => 'vhost',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file LangPHP_php_get_domain_handler.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/LangPHP_php_get_domain_handler.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'LangPHP',\n    'php_get_domain_handler',\n    array (\n        'type' => 'vhost',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 68"}},"/LangPHP/php_get_impacted_domains":{"get":{"description":"This function lists domains that obtain their PHP version from a specified PHP configuration.\n\n**Note:**\n\n  This document **only** applies to systems that run EasyApache 4.\n\n**Important:**\n\n  When you disable the [WebServer role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"php_get_impacted_domains","parameters":[{"description":"Whether to return domains that inherit the system's default PHP version.\n\n* `1` - Return domains that inherit the system's default PHP version.\n* `0` - Do **not** return domains that inherit the system's default PHP version.\n\n**Note:**\n\nIf you pass this parameter with a false value and do **not** also pass the domain parameter, the function returns an error.","in":"query","name":"system_default","required":false,"schema":{"enum":[1,0],"example":1,"type":"integer"}},{"description":"A domain on the system.\n\n**Note:**\n\n * You must pass either the `system_default` or `domain` parameters, or both.\n * You can pass this parameter multiple times.\n * You **cannot** pass the name of a parked domain.","in":"query","name":"domain","required":false,"schema":{"example":"example.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"php_get_impacted_domains","type":"string"},"module":{"description":"The name of the module called.","example":"LangPHP","type":"string"},"result":{"properties":{"data":{"properties":{"domains":{"description":"The domains that obtain their PHP version from the PHP configuration. Any valid domain or subdomain.\n\n**Note:**\n\nThis function does **not** return parked domains.","items":{"example":"example.com","type":"string"},"type":"array"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return domains that shared PHP configuration","tags":["LangPHP","PHP Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  LangPHP \\\n  php_get_impacted_domains\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/LangPHP/php_get_impacted_domains"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file LangPHP_php_get_impacted_domains.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/LangPHP_php_get_impacted_domains.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/LangPHP/,\n    q/php_get_impacted_domains/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file LangPHP_php_get_impacted_domains.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/LangPHP_php_get_impacted_domains.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'LangPHP',\n    'php_get_impacted_domains'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 62"}},"/LangPHP/php_get_installed_versions":{"get":{"description":"This function lists the system's PHP versions.\n\n**Note:**\n\n  This document **only** applies to systems that run EasyApache 4.\n\n**Important:**\n\n  When you disable the [WebServer role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"php_get_installed_versions","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"php_get_installed_versions","type":"string"},"module":{"description":"The name of the module called.","example":"LangPHP","type":"string"},"result":{"properties":{"data":{"properties":{"versions":{"description":"The available PHP versions.\n\n- `ea-php72`\n- `ea-php73`\n- `ea-php74`\n-  Any custom PHP package name.","items":{"example":"ea-php72","type":"string"},"type":"array"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return installed PHP versions","tags":["LangPHP","PHP Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  LangPHP \\\n  php_get_installed_versions\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/LangPHP/php_get_installed_versions"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file LangPHP_php_get_installed_versions.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/LangPHP_php_get_installed_versions.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/LangPHP/,\n    q/php_get_installed_versions/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file LangPHP_php_get_installed_versions.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/LangPHP_php_get_installed_versions.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'LangPHP',\n    'php_get_installed_versions'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.52"}},"/DNSSEC/deactivate_zone_key":{"get":{"description":"This function deactivates a DNSSEC security key.\n\n**Important:**\n\nWhen you disable the [*DNS* role](https://go.cpanel.net/serverroles/), the system **disables** this function.","operationId":"deactivate_zone_key","parameters":[{"description":"The security key's domain.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"The security key's ID.","in":"query","name":"key_id","required":true,"schema":{"example":1,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"deactivate_zone_key","type":"string"},"module":{"description":"The name of the module called.","example":"DNSSEC","type":"string"},"result":{"properties":{"data":{"properties":{"domain":{"description":"The domain for which the system deactivated a security key.","example":"example.com","format":"domain","type":"string"},"error":{"description":"An error message that describes why the system could not\ndeactivate the security key.\n\n**Note**\n\nThe function **only** displays this return when the `success` return is a `0` value.","example":"Error:  Invalid key_id or domain specified: No such key present for domain.","type":"string"},"key_id":{"description":"The security key's ID.","example":"1","type":"string"},"success":{"description":"Whether the system deactivated the security key.\n\n* `1` - Deactivated.\n* `0` - The system failed to deactivate the security key.","enum":[1,0],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed. Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Disable DNSSEC security key","tags":["DNSSEC","DNS Security"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DNSSEC \\\n  deactivate_zone_key \\\n  domain='example.com' \\\n  key_id='1'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DNSSEC/deactivate_zone_key?domain=example.com&key_id=1"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DNSSEC_deactivate_zone_key.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DNSSEC_deactivate_zone_key.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DNSSEC/,\n    q/deactivate_zone_key/,\n    {\n        'domain' => 'example.com',\n        'key_id' => '1',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DNSSEC_deactivate_zone_key.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DNSSEC_deactivate_zone_key.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DNSSEC',\n    'deactivate_zone_key',\n    array (\n        'domain' => 'example.com',\n        'key_id' => '1',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 84"}},"/LangPHP/php_ini_get_user_content":{"get":{"description":"This function returns the contents of a virtual host's `php.ini` file.\n\n**Note:**\n\n  This document **only** applies to systems that run EasyApache 4 with MultiPHP enabled.\n\n**Important:**\n\n  When you disable the [WebServer role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"php_ini_get_user_content","parameters":[{"description":"The type of `php.ini` file.\n\n* `home`\n* `vhost`\n\n**Important:**\n\nIf you set this parameter to `vhost`, you **must** also include the `vhost` parameter.","in":"query","name":"type","required":true,"schema":{"example":"vhost","type":"string"}},{"description":"The name of a virtual host.\n\n**Important:**\n\n If the type value is `vhost`, you **must** use this parameter.","in":"query","name":"vhost","required":false,"schema":{"example":"clearly.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"php_ini_get_user_content","type":"string"},"module":{"description":"The name of the module called.","example":"LangPHP","type":"string"},"result":{"properties":{"data":{"properties":{"content":{"description":"The contents of the requested user's `php.ini` file.","example":"allow_url_fopen = On\\nallow_url_include = On\\nasp_tags = Off\\ndisplay_errors = On\\nenable_dl = Off\\nfile_uploads = On\\ninclude_path = &quot;.;/path/to/php/pear&quot;\\nmax_execution_time = 30\\nmax_input_time = 60\\nmax_input_vars = 1050\\nmemory_limit = 32M\\nupload_max_filesize = 2M","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return virtual host's php.ini content","tags":["LangPHP","PHP Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  LangPHP \\\n  php_ini_get_user_content \\\n  type='vhost'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/LangPHP/php_ini_get_user_content?type=vhost"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file LangPHP_php_ini_get_user_content.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/LangPHP_php_ini_get_user_content.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/LangPHP/,\n    q/php_ini_get_user_content/,\n    {\n        'type' => 'vhost',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file LangPHP_php_ini_get_user_content.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/LangPHP_php_ini_get_user_content.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'LangPHP',\n    'php_ini_get_user_content',\n    array (\n        'type' => 'vhost',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.52"}},"/LangPHP/php_get_system_default_version":{"get":{"description":"This function lists the system’s default PHP version.\n\n**Important**:\n\n  When you disable the [Web Server role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"php_get_system_default_version","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"php_get_system_default_version","type":"string"},"module":{"description":"The name of the module called.","example":"LangPHP","type":"string"},"result":{"properties":{"data":{"properties":{"version":{"description":"The system’s default PHP version.\n\nPossible values include:\n  * An installed PHP package that cPanel provides. For example, `ea-php80`\n  * An installed PHP package that another vendor provides. For example, `alt-php42`\n  * `null` – This value means PHP is **not** installed. Also, the `errors` return will contain a message that indicates that PHP is not installed.\n\n**Note**:\n\n  If no default is explicitly set, the package for the newest installed version of PHP is chosen.","example":"ea-php73","nullable":true,"type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` — Success.\n- `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return default PHP version","tags":["LangPHP","PHP Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  LangPHP \\\n  php_get_system_default_version\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/LangPHP/php_get_system_default_version"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file LangPHP_php_get_system_default_version.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/LangPHP_php_get_system_default_version.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/LangPHP/,\n    q/php_get_system_default_version/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file LangPHP_php_get_system_default_version.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/LangPHP_php_get_system_default_version.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'LangPHP',\n    'php_get_system_default_version'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.52"}},"/LangPHP/php_ini_get_user_basic_directives":{"get":{"description":"This function lists a virtual host's basic PHP directives. The Basic Mode section of cPanel's [MultiPHP INI Editor](https://go.cpanel.net/cPanelMultiPHPINI)  interface (Home >> Software >> MultiPHP INI Editor) also lists these directives.\n\n**Note:**\n\n  This document **only** applies to systems that run EasyApache 4 with MultiPHP enabled.\n\n**Important:**\n\n  When you disable the [WebServer role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"php_ini_get_user_basic_directives","parameters":[{"description":"The type of `php.ini` file.\n\n- `home`\n- `vhost`\n\n**Important:**\n\n If you set this parameter to `vhost`, you **must** also include the `vhost` parameter.","in":"query","name":"type","required":true,"schema":{"enum":["home","vhost"],"example":"vhost","type":"string"}},{"description":"The name of a virtual host.\n\n**Important:**\n\n If the type value is `vhost`, you **must** use this parameter.","in":"query","name":"vhost","required":false,"schema":{"example":"clearly.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"php_ini_get_user_basic_directives","type":"string"},"module":{"description":"The name of the module called.","example":"LangPHP","type":"string"},"result":{"properties":{"data":{"properties":{"directives":{"description":"An array of the available directives in the `php.ini` file of the selected user's PHP version.","items":{"properties":{"default_value":{"description":"The directive's default value.","example":1,"oneOf":[{"type":"string"},{"type":"boolean"},{"type":"integer"},{"type":"number"}]},"info":{"description":"The purpose of the directive.","example":"This option enables the URL-aware fopen wrappers that enable accessing URL object like files. Default wrappers are provided for the access of remote files using the ftp or http protocol, some extensions like zlib may register additional wrappers.","type":"string"},"key":{"description":"The directive's name.","example":"allow_url_fopen","type":"string"},"php_ini_mode":{"description":"The directive's [PHP_INI mode](http://php.net/manual/en/configuration.changes.modes.php).\n\n* `PHP_INI_SYSTEM`\n* `PHP_INI_PERDIR`\n* `PHP_INI_ALL`\n* `PHPINI_ONLY`","enum":["PHP_INI_SYSTEM","PHP_INI_PERDIR","PHP_INI_ALL","PHPINI_ONLY"],"example":"PHP_INI_SYSTEM","type":"string"},"type":{"description":"The type of value that the directive uses.\n\n* `string`\n* `boolean`\n* `integer`\n* `float`","enum":["string","boolean","integer","float"],"example":"integer","type":"string"},"value":{"description":"The directive's current value.","example":"On","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return basic PHP directives","tags":["LangPHP","PHP Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  LangPHP \\\n  php_ini_get_user_basic_directives \\\n  type='vhost'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/LangPHP/php_ini_get_user_basic_directives?type=vhost"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file LangPHP_php_ini_get_user_basic_directives.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/LangPHP_php_ini_get_user_basic_directives.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/LangPHP/,\n    q/php_ini_get_user_basic_directives/,\n    {\n        'type' => 'vhost',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file LangPHP_php_ini_get_user_basic_directives.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/LangPHP_php_ini_get_user_basic_directives.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'LangPHP',\n    'php_ini_get_user_basic_directives',\n    array (\n        'type' => 'vhost',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.52"}},"/LangPHP/php_ini_get_user_paths":{"get":{"description":"This function lists the `php.ini` file paths for the user's home directory and virtual host document roots.\n\n**Note:**\n\n  This document **only** applies to systems that run EasyApache 4 with MultiPHP enabled.\n\n**Important:**\n\n  When you disable the [WebServer role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"php_ini_get_user_paths","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"php_ini_get_user_paths","type":"string"},"module":{"description":"The name of the module called.","example":"LangPHP","type":"string"},"result":{"properties":{"data":{"properties":{"paths":{"description":"An array of objects of `php.ini` file information.","items":{"properties":{"account":{"description":"The account's name.","example":"allthethings","type":"string"},"documentroot":{"description":"The virtual host's document root.","example":"/home/allthethings/public_html","type":"string"},"homedir":{"description":"The home directory.","example":"/home/allthethings/","type":"string"},"main_domain":{"description":"Whether the virtual host is the account's primary domain.\n* `1` - Primary domain.\n* `0` - **Not** the primary domain.","enum":[1,0],"example":1,"type":"integer"},"path":{"description":"The name of the virtual host's `php.ini` file.","example":"php.ini","type":"string"},"type":{"description":"The record's type.\n* `home`\n* `vhost`","enum":["home","vhost"],"example":"vhost","type":"string"},"version":{"description":"The default PHP version.\n- `ea-php##`, where `##` represents the major and minor versions of PHP (for example, `ea-php72` represents PHP 7.2).\n- Any custom PHP package name.","example":"ea-php72","type":"string"},"vhost":{"description":"The name of the virtual host.","example":"clearly.com","format":"domain","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return php.ini file paths","tags":["LangPHP","PHP Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  LangPHP \\\n  php_ini_get_user_paths\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/LangPHP/php_ini_get_user_paths"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file LangPHP_php_ini_get_user_paths.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/LangPHP_php_ini_get_user_paths.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/LangPHP/,\n    q/php_ini_get_user_paths/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file LangPHP_php_ini_get_user_paths.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/LangPHP_php_ini_get_user_paths.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'LangPHP',\n    'php_ini_get_user_paths'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.52"}},"/LangPHP/php_ini_set_user_basic_directives":{"get":{"description":"This function sets the values of any basic PHP directive. The *Basic Mode* section of cPanel's\n[*MultiPHP INI Editor*](https://go.cpanel.net/whmdocsMultiPHPINIEditor) interface (*WHM >> Home >> Software >> MultiPHP INI Editor*) lists these directives.\n\n**Note:**\n\n  This document **only** applies to systems that run EasyApache 4 with MultiPHP enabled.\n\n**Important:**\n\n  When you disable the [Web Server role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"php_ini_set_user_basic_directives","parameters":[{"description":"The type of `php.ini` file.\n\n* `home`\n* `vhost`\n\n**Important:**\n\n If you set this parameter to `vhost`, you **must** also include the `vhost` parameter.","in":"query","name":"type","required":true,"schema":{"enum":["home","vhost"],"example":"vhost","type":"string"}},{"description":"The name of a PHP directive and its value.\n\n**Note:**\n\n* To change the directive's value for multiple PHP directives, increment the parameter name. For example, the `directive-1`, `directive-2`, and `directive-3` parameters.\n* You **must** format values as `<directive>:<value>`  ","examples":{"multiple":{"summary":"Multiple PHP directives.","value":"directive-1=allow_url_fopen%3A0&directive-2=upload_max_filesize%3A4M&directive-3=post_max_size"},"single":{"summary":"A single PHP directive.","value":"allow_url_fopen:0"}},"in":"query","name":"directive","required":true,"schema":{"type":"string"}},{"description":"The name of a virtual host.\n\n**Important:**\n\n If the `type` value is `vhost`, you **must** use this parameter.","in":"query","name":"vhost","required":false,"schema":{"example":"clearly.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"php_ini_set_user_basic_directives","type":"string"},"module":{"description":"The name of the module called.","example":"LangPHP","type":"string"},"result":{"properties":{"data":{},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"LangPHP":{"description":"An object containing the virtual host's PHP directive information.","properties":{"path":{"description":"The absolute file path to the `php.ini` file.","example":"/home/allthethings/public_html/php.ini","format":"path","type":"string"},"phpversion":{"description":"The virtual host's installed version of PHP.","example":"ea-php55","type":"string"},"type":{"description":"The type of `php.ini` file.\n\n* `home`\n* `vhost`","enum":["home","vhost"],"example":"vhost","type":"string"},"vhost":{"description":"The virtual host's name.","example":"clearly.com","type":"string"}},"type":"object"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update basic PHP directives","tags":["LangPHP","PHP Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  LangPHP \\\n  php_ini_set_user_basic_directives \\\n  type='vhost' \\\n  directive='allow_url_fopen:0'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/LangPHP/php_ini_set_user_basic_directives?type=vhost&directive=allow_url_fopen%3a0"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file LangPHP_php_ini_set_user_basic_directives.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/LangPHP_php_ini_set_user_basic_directives.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/LangPHP/,\n    q/php_ini_set_user_basic_directives/,\n    {\n        'type' => 'vhost',\n        'directive' => 'allow_url_fopen:0',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file LangPHP_php_ini_set_user_basic_directives.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/LangPHP_php_ini_set_user_basic_directives.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'LangPHP',\n    'php_ini_set_user_basic_directives',\n    array (\n        'type' => 'vhost',\n        'directive' => 'allow_url_fopen:0',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.52"}},"/LangPHP/php_ini_set_user_content":{"get":{"description":"This function changes the contents of a virtual host's `php.ini` file.\n\n**Note:**\n\n  This document **only** applies to systems that run EasyApache 4 with MultiPHP enabled.\n\n**Important:**\n\n  When you disable the [WebServer role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"php_ini_set_user_content","parameters":[{"description":"The type of `php.ini` file.\n\n* `home`\n* `vhost`\n\n**Important:**\n\n If you set this parameter to `vhost`, you **must** also include the `vhost` parameter.","in":"query","name":"type","required":true,"schema":{"enum":["host","vhost"],"example":"vhost","type":"string"}},{"description":"The content of the `php.ini` file to change.","in":"query","name":"content","required":true,"schema":{"example":"%5BPHP%5D%0D%0A%3B+About+php.ini%0D%0A%3B+php.ini+is+responsible+for+configuring+many+of+the+aspects+of+PHP%27s+behavior.%0D%0Apcre.backtrack_limit%3D100000","type":"string"}},{"description":"The name of a virtual host.\n\n**Important:**\n\n If the type value is `vhost` , you **must** use this parameter.","in":"query","name":"vhost","required":false,"schema":{"example":"clearly.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"php_ini_set_user_content","type":"string"},"module":{"description":"The name of the module called.","example":"LangPHP","type":"string"},"result":{"properties":{"data":{"description":"This value will always be `null`.","nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update virtual host's php.ini content","tags":["LangPHP","PHP Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  LangPHP \\\n  php_ini_set_user_content \\\n  type='vhost' \\\n  content='%5BPHP%5D%0D%0A%3B+About+php.ini%0D%0A%3B+php.ini+is+responsible+for+configuring+many+of+the+aspects+of+PHP%27s+behavior.%0D%0Apcre.backtrack_limit%3D100000'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/LangPHP/php_ini_set_user_content?type=vhost&content=%255BPHP%255D%250D%250A%253B%2bAbout%2bphp.ini%250D%250A%253B%2bphp.ini%2bis%2bresponsible%2bfor%2bconfiguring%2bmany%2bof%2bthe%2baspects%2bof%2bPHP%2527s%2bbehavior.%250D%250Apcre.backtrack_limit%253D100000"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file LangPHP_php_ini_set_user_content.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/LangPHP_php_ini_set_user_content.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/LangPHP/,\n    q/php_ini_set_user_content/,\n    {\n        'type' => 'vhost',\n        'content' => '%5BPHP%5D%0D%0A%3B+About+php.ini%0D%0A%3B+php.ini+is+responsible+for+configuring+many+of+the+aspects+of+PHP%27s+behavior.%0D%0Apcre.backtrack_limit%3D100000',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file LangPHP_php_ini_set_user_content.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/LangPHP_php_ini_set_user_content.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'LangPHP',\n    'php_ini_set_user_content',\n    array (\n        'type' => 'vhost',\n        'content' => '%5BPHP%5D%0D%0A%3B+About+php.ini%0D%0A%3B+php.ini+is+responsible+for+configuring+many+of+the+aspects+of+PHP%27s+behavior.%0D%0Apcre.backtrack_limit%3D100000',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.52"}},"/LangPHP/php_set_vhost_versions":{"get":{"description":"This function sets a virtual host's PHP version.\n\n**Note:**\n\n  This document **only** applies to systems that run EasyApache 4.\n\n**Important:**\n\n  When you disable the [WebServer role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"php_set_vhost_versions","parameters":[{"description":"The PHP version of a virtual host.","in":"query","name":"version","required":true,"schema":{"example":"ea-php72","type":"string"}},{"description":"The virtual host's name.\n\n**Note:**\n\n  To change the PHP version of multiple virtual hosts, duplicate or increment the parameter name. For example, `vhost-1`, `vhost-2`, and `vhost-3`.","examples":{"multiple":{"summary":"Set a multiple vhosts.","value":"vhost-1=example.com&vhost-2=example2.com&vhost-3=example3.com"},"single":{"summary":"Set a single vhost.","value":"example.com"}},"in":"query","name":"vhost","required":true,"schema":{"format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"php_set_vhost_versions","type":"string"},"module":{"description":"The name of the module called.","example":"LangPHP","type":"string"},"result":{"properties":{"data":{"properties":{"vhosts":{"description":"The names of the changed virtual hosts.","items":{"example":"example.com","format":"domain","type":"string"},"type":"array"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update virtual host's PHP version","tags":["LangPHP","PHP Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  LangPHP \\\n  php_set_vhost_versions \\\n  version='ea-php72' \\\n  vhost='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/LangPHP/php_set_vhost_versions?version=ea-php72&vhost=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file LangPHP_php_set_vhost_versions.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/LangPHP_php_set_vhost_versions.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/LangPHP/,\n    q/php_set_vhost_versions/,\n    {\n        'version' => 'ea-php72',\n        'vhost' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file LangPHP_php_set_vhost_versions.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/LangPHP_php_set_vhost_versions.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'LangPHP',\n    'php_set_vhost_versions',\n    array (\n        'version' => 'ea-php72',\n        'vhost' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.52"}},"/LastLogin/get_last_or_current_logged_in_ip":{"get":{"description":"This function returns the IP address of the user who most recently logged in.","operationId":"get_last_or_current_logged_in_ip","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_last_or_current_logged_in_ip","type":"string"},"module":{"description":"The name of the module called.","example":"LastLogin","type":"string"},"result":{"properties":{"data":{"description":"The IP address of the user who most recently logged in.","items":{"example":"192.168.0.1","format":"ipv4","type":"string"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` Success.\n* `0` Failed. Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return last authenticated login IP address","tags":["LastLogin","Login Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  LastLogin \\\n  get_last_or_current_logged_in_ip\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/LastLogin/get_last_or_current_logged_in_ip"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file LastLogin_get_last_or_current_logged_in_ip.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/LastLogin_get_last_or_current_logged_in_ip.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/LastLogin/,\n    q/get_last_or_current_logged_in_ip/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file LastLogin_get_last_or_current_logged_in_ip.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/LastLogin_get_last_or_current_logged_in_ip.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'LastLogin',\n    'get_last_or_current_logged_in_ip'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.48"}},"/Locale/set_locale":{"get":{"description":"This function sets the account's locale.","operationId":"set_locale","parameters":[{"description":"The locale's abbreviated name according to UAPI's `Locale::list_locales` function.","in":"query","name":"locale","required":true,"schema":{"example":"en","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_locale","type":"string"},"module":{"description":"The name of the module called.","example":"Locale","type":"string"},"result":{"properties":{"data":{},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update cPanel account locale","tags":["Locale","Language"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Locale \\\n  set_locale \\\n  locale='en'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Locale/set_locale?locale=en"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Locale_set_locale.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Locale_set_locale.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Locale/,\n    q/set_locale/,\n    {\n        'locale' => 'en',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Locale_set_locale.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Locale_set_locale.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Locale',\n    'set_locale',\n    array (\n        'locale' => 'en',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/Locale/list_locales":{"get":{"description":"This function lists an account's available interface languages.","operationId":"list_locales","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_locales","type":"string"},"module":{"description":"The name of the module called.","example":"Locale","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"direction":{"description":"The locale's text direction.\n* `ltr` - Left to right.\n* `rtl` - Right to left.","enum":["ltr","rtl"],"example":"ltr","type":"string"},"local_name":{"description":"The locale's full name, in the locale's language.","example":"Deutsch","type":"string"},"locale":{"description":"The locale's two-letter [ISO-3166 code](http://www.iso.org/iso/country_codes.htm).","example":"de","format":"ISO-3166-1 (alpha-2)","type":"string"},"name":{"description":"The locale's full name.","example":"German","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return available locales","tags":["Locale","Language"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Locale \\\n  list_locales\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Locale/list_locales"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Locale_list_locales.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Locale_list_locales.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Locale/,\n    q/list_locales/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Locale_list_locales.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Locale_list_locales.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Locale',\n    'list_locales'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/LogManager/get_settings":{"get":{"description":"This function retrieves the account's log archival settings.","operationId":"LogManager_get_settings","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_settings","type":"string"},"module":{"description":"The name of the module called.","example":"LogManager","type":"string"},"result":{"properties":{"data":{"properties":{"archive_logs":{"description":"Whether the system archives log files to your home directory.\n* `1` — Archives the logs.\n* `0` — Does **not** archive the logs.","enum":[1,0],"example":1,"type":"integer"},"prune_archive":{"description":"Whether the system removes the previous month's archived log files from your home directory.\n* `1` — Removes the logs.\n* `0` — Does **not** remove the logs.","enum":[1,0],"example":1,"type":"integer"},"retention_days":{"description":"The number of days the system retains archived log files before automatic removal.\nA value of `0` means the system retains logs indefinitely.\nWhen the user has not set a custom value, this returns the server-wide default.","example":30,"type":"integer"},"using_default":{"description":"Whether the user uses the server-wide default retention period.\n* `1` — Uses the server default.\n* `0` — Uses a custom retention value.","enum":[1,0],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Retrieve cPanel account's log archival settings","tags":["LogManager","Logs"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  LogManager \\\n  get_settings\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/LogManager/get_settings"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file LogManager_get_settings.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/LogManager_get_settings.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/LogManager/,\n    q/get_settings/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file LogManager_get_settings.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/LogManager_get_settings.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'LogManager',\n    'get_settings'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/LogManager/list_archives":{"get":{"description":"This function returns a list of the user's archive files.","operationId":"LogManager_list_archives","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_archives","type":"string"},"module":{"description":"The name of the module called.","example":"LogManager","type":"string"},"result":{"properties":{"data":{"description":"An array of objects that contain information about the archive files. These files reside in the cPanel user's `~/logs` directory.","items":{"properties":{"file":{"description":"The archive file's name.","example":"domain.com-May-2019.gz","type":"string"},"mtime":{"description":"The archive file's last modified date.","example":1557835866,"format":"unix_timestamp","type":"integer"},"path":{"description":"The archive file's path.","example":"/home/user/logs/domain.com-May-2019.gz","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel account's archive files list","tags":["LogManager","Logs"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  LogManager \\\n  list_archives\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/LogManager/list_archives"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file LogManager_list_archives.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/LogManager_list_archives.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/LogManager/,\n    q/list_archives/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file LogManager_list_archives.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/LogManager_list_archives.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'LogManager',\n    'list_archives'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/Locale/get_attributes":{"get":{"description":"This function retrieves information about the user's current locale setting.","operationId":"get_attributes","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_attributes","type":"string"},"module":{"description":"The name of the module called.","example":"Locale","type":"string"},"result":{"properties":{"data":{"properties":{"direction":{"description":"The locale's text direction.\n* `ltr` - left to right.\n* `rtl` - right to left.","enum":["ltr","rtl"],"example":"ltr","type":"string"},"encoding":{"description":"The user's character set.","example":"utf-8","type":"string"},"locale":{"description":"The locale's two-letter ISO-3166 code.","example":"en","format":"ISO-3166-1 (alpha-2)","type":"string"},"name":{"description":"The locale's full name.","example":"English","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return current locale settings","tags":["Locale","Language"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Locale \\\n  get_attributes\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Locale/get_attributes"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Locale_get_attributes.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Locale_get_attributes.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Locale/,\n    q/get_attributes/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Locale_get_attributes.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Locale_get_attributes.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Locale',\n    'get_attributes'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/LogManager/set_settings":{"get":{"description":"This function saves the account's log archive settings.\n\n**Note:**\n\nYou **must** pass at least one of the `archive_logs`, `prune_archive`, or `retention_days` parameters.","operationId":"LogManager_set_settings","parameters":[{"description":"Whether to archive log files to your home directory after the\nsystem processes statistics.\n* `1` — Archive the logs.\n* `0` — Do **not** archive the logs.\n\n**Note:**\n\n* This parameter defaults to the `archive-logs` setting's value in the user's `~/.cpanel-logs` file.\n* If this file does **not** exist, this parameter defaults to the `default_archive-logs` key's value in the [`cpanel.config`](https://go.cpanel.net/cpanelconfiginvalid) file.","in":"query","name":"archive_logs","required":false,"schema":{"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to remove the previous month's archived logs from the `~/logs directory` at the end of each month.\n* `1` — Remove the logs.\n* `0` — Do **not** remove the logs.\n\n**Note:**\n\n* This parameter defaults to the `remove-old-archived-logs` setting's value in the user's `~/.cpanel-logs` file.\n* If this file doesn't exist, this parameter defaults to the `default_remove-old-archive-logs` key's value in the [`cpanel.config`](https://go.cpanel.net/cpanelconfiginvalid) file.","in":"query","name":"prune_archive","required":false,"schema":{"enum":[0,1],"example":1,"type":"integer"}},{"description":"The number of days to retain archived log files before automatic removal.\n* `0` — Retain logs indefinitely.\n* `-1` — Clear the per-user override and revert to the server default.\n* Any positive integer — Retain logs for that many days.\n\nWhen not provided, the existing value is preserved.","in":"query","name":"retention_days","required":false,"schema":{"example":30,"minimum":-1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_settings","type":"string"},"module":{"description":"The name of the module called.","example":"LogManager","type":"string"},"result":{"properties":{"data":{},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Save cPanel account's log archive settings","tags":["LogManager","Logs"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  LogManager \\\n  set_settings \\\n  archive_logs=1 \\\n  prune_archive=1 \\\n  retention_days=30\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/LogManager/set_settings"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file LogManager_set_settings.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/LogManager_set_settings.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/LogManager/,\n    q/set_settings/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file LogManager_set_settings.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/LogManager_set_settings.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'LogManager',\n    'set_settings'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/Mailboxes/get_mailbox_status_list":{"get":{"description":"This function lists the account's mailbox size and globally unique identifier (GUID) by folder.","operationId":"get_mailbox_status_list","parameters":[{"description":"The email account for which you you wish to request the status.","in":"query","name":"account","required":true,"schema":{"example":"user@example.com","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_mailbox_status_list","type":"string"},"module":{"description":"The name of the module called.","example":"Mailboxes","type":"string"},"result":{"properties":{"data":{"example":[{"guid":"1234560f0c58d158c92a000044f0d230","mailbox":"INBOX.marla_singer@example_com","messages":0,"vsize":0},{"guid":"11234560f0c58d158c92a000044f0d23","mailbox":"INBOX.angel_face@example_com","messages":0,"vsize":0},{"guid":"111234560f0c58d158c92a000044f0d2","mailbox":"INBOX.tyler_durden@example_com","messages":0,"vsize":0},{"guid":"1111234560f0c58d158c92a000044f0d","mailbox":"INBOX.Trash","messages":0,"vsize":0},{"guid":"11111234560f0c58d158c92a000044f0","mailbox":"INBOX.narrator@example_com","messages":0,"vsize":0},{"guid":"111111234560f0c58d158c92a000044f","mailbox":"INBOX","messages":0,"vsize":0},{"guid":"1111111234560f0c58d158c92a000004","mailbox":"INBOX.Sent","messages":0,"vsize":0},{"guid":"11111111234560f0c58d158c92a00000","mailbox":"INBOX.Drafts","messages":0,"vsize":0},{"guid":"111111111234560f0c58d158c92a0000","mailbox":"INBOX.robert_paulsen@example_com","messages":0,"vsize":0}],"items":{"properties":{"guid":{"description":"The mailbox GUID.","example":"1234560f0c58d158c92a000044f0d230","type":"string"},"mailbox":{"description":"The mailbox name.","example":"INBOX.marla_singer@example_com","type":"string"},"messages":{"description":"The number of messages in the folder.","example":410,"minimum":0,"type":"integer"},"vsize":{"description":"The size of the folder, in bytes.","example":1052299,"format":"bytes","minimum":0,"type":"integer"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel account's mailbox status","tags":["Mailboxes","Mailbox Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mailboxes \\\n  get_mailbox_status_list \\\n  account='user@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mailboxes/get_mailbox_status_list?account=user%40example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mailboxes_get_mailbox_status_list.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mailboxes_get_mailbox_status_list.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mailboxes/,\n    q/get_mailbox_status_list/,\n    {\n        'account' => 'user@example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mailboxes_get_mailbox_status_list.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mailboxes_get_mailbox_status_list.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mailboxes',\n    'get_mailbox_status_list',\n    array (\n        'account' => 'user@example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 64"}},"/Mailboxes/expunge_mailbox_messages":{"get":{"description":"This function marks the selected mail messages as deleted.","operationId":"expunge_mailbox_messages","parameters":[{"description":"The email account's name.","examples":{"_mainaccount":{"summary":"The `_mainaccount` alias, which represents the cPanel user's mailbox.","value":"_mainaccount@example.com"},"cpanel-user":{"summary":"The cPanel user's account name.","value":"example"},"email":{"summary":"A valid email account.","value":"user@example.com"}},"in":"query","name":"account","required":true,"schema":{"anyOf":[{"format":"email","type":"string"},{"format":"username","type":"string"}]}},{"description":"The mailbox to operate on.\n\n**Note:**\n\n* Use the `Mailboxes::get_mailbox_status_list` function to list possible values for the mailbox parameter.\n* Because you cannot escape wildcard characters such as (`*`), we recommend that you use functions that use the `mailbox_guid` parameter instead. For example, the `Mailboxes::expunge_messages_for_mailbox_guid` function.","in":"query","name":"mailbox","required":true,"schema":{"example":"INBOX.user@example_com","type":"string"}},{"description":"The Dovecot query to execute.\n\n**Note:**\n\nThe query parameter prevents accidental removal of all messages in the mailbox. For more information, read Dovecot's [Search Query](http://wiki2.dovecot.org/Tools/Doveadm/SearchQuery) documentation.","in":"query","name":"query","required":true,"schema":{"example":"savedbefore 52w","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"expunge_mailbox_messages","type":"string"},"module":{"description":"The name of the module called.","example":"Mailboxes","type":"string"},"result":{"properties":{"data":{},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete selected messages in mailbox","tags":["Mailboxes","Mailbox Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mailboxes \\\n  expunge_mailbox_messages \\\n  account='_mainaccount@example.com' \\\n  mailbox='INBOX.user@example_com' \\\n  query='savedbefore 52w'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mailboxes/expunge_mailbox_messages?account=_mainaccount%40example.com&mailbox=INBOX.user%40example_com&query=savedbefore%2052w"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mailboxes_expunge_mailbox_messages.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mailboxes_expunge_mailbox_messages.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mailboxes/,\n    q/expunge_mailbox_messages/,\n    {\n        'account' => '_mainaccount@example.com',\n        'mailbox' => 'INBOX.user@example_com',\n        'query' => 'savedbefore 52w',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mailboxes_expunge_mailbox_messages.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mailboxes_expunge_mailbox_messages.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mailboxes',\n    'expunge_mailbox_messages',\n    array (\n        'account' => '_mainaccount@example.com',\n        'mailbox' => 'INBOX.user@example_com',\n        'query' => 'savedbefore 52w',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 64"}},"/Mailboxes/expunge_messages_for_mailbox_guid":{"get":{"description":"This function marks the selected mailbox's messages as deleted.","operationId":"expunge_messages_for_mailbox_guid","parameters":[{"description":"The email account's name.","examples":{"_mainaccount":{"summary":"The `_mainaccount` alias, which represents the cPanel user's mailbox.","value":"_mainaccount@example.com"},"cpanel-user":{"summary":"The cPanel user's account name.","value":"example"},"email":{"summary":"A valid email account.","value":"user@example.com"}},"in":"query","name":"account","required":true,"schema":{"anyOf":[{"format":"email","type":"string"},{"format":"username","type":"string"}]}},{"description":"The mailbox's globally unique identifier (GUID).\n\nUse the `Mailboxes::get_mailbox_status_list` function to list possible values for the `mailbox_guid` parameter.","in":"query","name":"mailbox_guid","required":true,"schema":{"example":"2550860f0c58d158c92a000044f0d230","type":"string"}},{"description":"The query to select which messages you wish to remove from the mailbox.","in":"query","name":"query","required":true,"schema":{"example":"savedbefore 52w","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"expunge_messages_for_mailbox_guid","type":"string"},"module":{"description":"The name of the module called.","example":"Mailboxes","type":"string"},"result":{"properties":{"data":{"properties":{},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete selected messages in mailbox by GUID","tags":["Mailboxes","Mailbox Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mailboxes \\\n  expunge_messages_for_mailbox_guid \\\n  account='_mainaccount@example.com' \\\n  mailbox_guid='2550860f0c58d158c92a000044f0d230' \\\n  query='savedbefore 52w'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mailboxes/expunge_messages_for_mailbox_guid?account=_mainaccount%40example.com&mailbox_guid=2550860f0c58d158c92a000044f0d230&query=savedbefore%2052w"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mailboxes_expunge_messages_for_mailbox_guid.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mailboxes_expunge_messages_for_mailbox_guid.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mailboxes/,\n    q/expunge_messages_for_mailbox_guid/,\n    {\n        'account' => '_mainaccount@example.com',\n        'mailbox_guid' => '2550860f0c58d158c92a000044f0d230',\n        'query' => 'savedbefore 52w',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mailboxes_expunge_messages_for_mailbox_guid.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mailboxes_expunge_messages_for_mailbox_guid.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mailboxes',\n    'expunge_messages_for_mailbox_guid',\n    array (\n        'account' => '_mainaccount@example.com',\n        'mailbox_guid' => '2550860f0c58d158c92a000044f0d230',\n        'query' => 'savedbefore 52w',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 64"}},"/Mailboxes/has_utf8_mailbox_names":{"get":{"description":"This function determines whether a cPanel user currently uses UTF-8 character-encoded mailbox names.","operationId":"has_utf8_mailbox_names","parameters":[{"description":"The user for whom to determine whether they currently use UTF-8\ncharacter-encoded mailbox names.\n\n**Note:**\n\nThis parameter defaults to the currently-logged in user.","in":"query","name":"user","required":false,"schema":{"example":"user","format":"username","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"has_utf8_mailbox_names","type":"string"},"module":{"description":"The name of the module called.","example":"Mailboxes","type":"string"},"result":{"properties":{"data":{"properties":{"enabled":{"description":"Whether the user currently uses UTF-8 character-encoded mailbox names.\n* `1` - Uses UTF-8 character-encoded mailbox names.\n* `0` - Does **not** use UTF-8 character-encoded mailbox names.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return if cPanel account's mailboxes use UTF-8","tags":["Mailboxes","Mailbox Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mailboxes \\\n  has_utf8_mailbox_names\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mailboxes/has_utf8_mailbox_names"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mailboxes_has_utf8_mailbox_names.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mailboxes_has_utf8_mailbox_names.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mailboxes/,\n    q/has_utf8_mailbox_names/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mailboxes_has_utf8_mailbox_names.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mailboxes_has_utf8_mailbox_names.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mailboxes',\n    'has_utf8_mailbox_names'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 78"}},"/Market/cancel_pending_ssl_certificate":{"get":{"description":"This function cancels an order and removes the polling for a pending certificate.","operationId":"cancel_pending_ssl_certificate","parameters":[{"description":"The cPanel Market provider's name.","in":"query","name":"provider","required":true,"schema":{"example":"cPStore","type":"string"}},{"description":"The ID of the ordered item to cancel.","in":"query","name":"order_item_id","required":true,"schema":{"example":"10427508","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"cancel_pending_ssl_certificate","type":"string"},"module":{"description":"The name of the module called.","example":"Market","type":"string"},"result":{"properties":{"data":{"description":"An object containing order information.","items":{"properties":{"created_time":{"description":"When the system created the order.","example":1458061262,"format":"unix_timestamp","type":"integer"},"csr":{"description":"The text of the Certificate Request (CSR).","example":"-----BEGIN CERTIFICATE REQUEST-----\nMIIC0TCCAbkCAQAwGzEZMBcGA1UEAxMQY29icmFzc2x0ZXN0Lm9yZzCCASIwDQYJ\nKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKsZWNkF8hjUjoCDNNSkXO0CTp/z/0pu\niFiDMzdFAa6mg5wr97EwRBCniSvJEJ1rdQ0Sus2AAK9hg7TeZAWbFf97r7mS0chm\nr27Ht9qfit3r0EJLYcjRjnZ/wj21ZhsdjQIjjTRiI1TvXtOQRAQpWNsGxK7QV3Q3\nnjkSM/gTpteHuC3JAQxbpv72B+IjiyzUZr8DOUOoB94IO5iP27UXnkSbExInDvqu\nK43zVGYNU0Zev20A6SBWU3BALjWXHlYjwbC109FxOWNssHTg3xvePsBxzk6BFDcT\nS/QAS0tFYPfHZKmCBg6irBGFOdTjSDVmFk8zAoFYibev0juRJCMn2XsCAwEAAaBx\nMG8GCSqGSIb3DQEJDjFiMGAwXgYDVR0RAQH/BFQwUoIQY29icmFzc2x0ZXN0Lm9y\nZ4IUd3d3LmNvYnJhc3NsdGVzdC5vcmeCEWNwYW5lbHNzbHRlc3Qub3JnghV3d3cu\nY3BhbmVsc3NsdGVzdC5vcmcwDQYJKoZIhvcNAQELBQADggEBAG0l4aChMO1rSmgR\nSF5qlKu785n5YS5rTE9ev+OFu0952DvjVAB0R8y5+TZSXfg+9CH7pa2VDosAEYF4\nyjUJOuiwwVEUD/9Qhrls/2xT8KKk0QSxuWmOgP2YQy/QRH+W7ykoigtiWdXEIUuF\niJmeavS8JOYt560366V3dw7YT+QstUHQ7UlGEFDeWQI3osUN1wDrtW5qcaq09Q/G\nTcphzXrRkL5lRjKXKLIcY/HVYzOnoEX30ALX2I3bJ9s4IMRfpnhTqLmWalcr+4vq\nvqVnlB0B/nXf/qaB/xvxmEtSGx/GZ/8Gsrf5PB7GhRuStUtJoXcLuADK0bgug3X2\nGxEruS4=\n-----END CERTIFICATE REQUEST-----\n","format":"base64 certificate","type":"string"},"domains":{"description":"A list of domains on the certificate.","example":["example1.com","example2.com"],"items":{"format":"domain","type":"string"},"type":"array"},"expired":{"description":"Whether the system has deleted the item from the pending queue.\n* `1` - Deleted.\n* `0` - **Not** deleted.","enum":[0,1],"example":0,"type":"integer"},"first_poll_time":{"description":"The first time that the system polled the provider for the certificate.","example":1458061262,"format":"unix_timestamp","type":"integer"},"last_poll_time":{"description":"The last time that the system polled the\nprovider for the certificate. ","example":1458061262,"format":"unix_timestamp","type":"integer"},"last_status_code":{"description":"The last status code of the order.\n* `CertificateNotFound` - The system cannot locate the specified certificate.\n* `RequiresApproval` - The specified certificate requires approval.\n* `OrderCanceled` - The system cancelled the order of the specified certificate.\n* `OrderItemCanceled` - The system cancelled the order item of the specified certificate.","enum":["CertificateNotFound","RequiresApproval","OrderCanceled","OrderItemCanceled"],"example":"CertificateNotFound","type":"string"},"order_id":{"description":"The ID of the order.","example":"1392472","type":"string"},"order_item_id":{"description":"The ID of the ordered item.","example":"10427508","type":"string"},"product_id":{"description":"The product's ID.","example":"143","type":"string"},"provider":{"description":"The cPanel Market provider's name.","example":"cPStore","type":"string"},"status":{"description":"The status of the order.\n* `confirmed` - Payment confirmed.\n* `unconfirmed` - Payment **not** confirmed.","enum":["confirmed","unconfirmed"],"example":"confirmed","type":"string"},"support_uri":{"description":"The URI of the cPanel Market Provider's support site.","example":"http://support.example.com/","format":"uri","type":"string"},"vhost_names":{"description":"A list of virtual host names.","example":["abcde.com"],"items":{"type":"string"},"type":"array"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings\ndescribe non-critical failures or other problematic conditions\nnoted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete an order","tags":["Market","SSL Certificates"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Market \\\n  cancel_pending_ssl_certificate \\\n  provider='cPStore' \\\n  order_item_id='10427508'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Market/cancel_pending_ssl_certificate?provider=cPStore&order_item_id=10427508"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Market_cancel_pending_ssl_certificate.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Market_cancel_pending_ssl_certificate.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Market/,\n    q/cancel_pending_ssl_certificate/,\n    {\n        'provider' => 'cPStore',\n        'order_item_id' => '10427508',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Market_cancel_pending_ssl_certificate.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Market_cancel_pending_ssl_certificate.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Market',\n    'cancel_pending_ssl_certificate',\n    array (\n        'provider' => 'cPStore',\n        'order_item_id' => '10427508',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 56"}},"/Market/get_all_products":{"get":{"description":"This function lists all products available through all enabled cPanel Market providers.","operationId":"Market-get_all_products","parameters":[],"responses":{"200":{"content":{"application/json":{"examples":{"ssl_certificate":{"description":"product_group=ssl_certificate","value":{"apiversion":3,"func":"get_all_products","module":"Market","result":{"data":[{"base_name":"","billing_type":"one-time","description":"An extended-validated (EV) SSL certificate signed by COMODO.","display_name":"Comodo EV SSL Certificate","enabled":1,"icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iNTUwIiB3aWR0aD0iNDE3LjE2Ij48ZyBmaWxsPSIjMzViNTZjIj48cGF0aCBkPSJNNDE0LjM5NiAyNmM3LTExIDAtMjYtMTMtMjZIMTg3LjM5NWMtNDUgMC04MSAxMi0xMDcgMzZzLTQyIDU4LTQ2IDEwM2wtMTAgMTE2Yy00IDQ1IDUgNzkgMjggMTAzIDIyIDI0IDU2IDM2IDEwMSAzNmg0OXYtMWM5LjAwMS0xIDE1LjAwMS03IDE2LjAwMS0xN2w1LTU3YzAtMTEtNy0xOS0xOC4wMDEtMTloLTI3Yy0xNyAwLTMwLTQtMzctMTItNy03LTEwLTIwLTgtMzlsOS0xMDRjMi0xOCA3LTMxIDE1LTM5czIxLTEyIDM5LTEyaDE0NC4wMDFjMTcgMCAzNC05IDQ0LTIzbDMwLTQ1Ii8+PHBhdGggZD0iTTMuMzk1IDUyNGMtOCAxMS0xIDI2IDEyIDI2aDIxNy4wMDFjNDUgMCA4MS0xMiAxMDgtMzYgMjYtMjQgNDEtNTggNDUtMTAybDExLTExN2MzLTQ1LTYtNzktMjgtMTAzLTIzLTI0LTU2LTM2LTEwMS0zNmgtNDl2MWMtMTAuMDAxIDEtMTUuMDAxIDctMTYuMDAxIDE3bC01IDU4Yy0xIDEwIDcgMTggMTcuMDAxIDE4aDI3YzE4IDAgMzAgNCAzNyAxMnMxMCAyMSA5IDM5bC0xMCAxMDRjLTEgMTktNiAzMi0xNCAzOS05IDgtMjIgMTItNDAgMTJINzYuMzk1Yy0xNyAwLTMzIDktNDMgMjRsLTMwIDQ0Ii8+PC9nPjwvc3ZnPg==","icon_mime_type":"image/svg+xml","license_term":0,"max_users":null,"maximum_server_price":null,"minimum_server_price":null,"price":null,"price_unit":"USD","product":"Comodo EV Certificate","product_category":"N/A","product_group":"ssl_certificate","product_id":155,"provider_display_name":"cPanel Store","provider_name":"cPStore","recommended":0,"requires_ip":0,"x_certificate_term":[1,"year"],"x_identity_verification":[{"label":"Organization Name","name":"organizationName"},{"is_optional":1,"label":"Department Name","name":"organizationalUnitName"},{"description":"9 consecutive digits or “##-###-####” (More information (https://go.cpanel.net/get_duns))","is_optional":1,"label":"Dun & Bradstreet D-U-N-S (Data Universal Numbering System) Number","name":"duns_number","pattern":"^[0-9]{2}(?:-[0-9]{3}-[0-9]{4}|[0-9]{7})$"},{"label":"Street Address","name":"streetAddress"},{"label":"City","name":"localityName"},{"label":"State or Province","name":"stateOrProvinceName"},{"label":"Postal Code","name":"postalCode"},{"label":"Country Code","name":"countryName","type":"country_code"},{"label":"Representative’s Given (First) Name","name":"rep_forename"},{"label":"Representative’s Surname (Last Name)","name":"rep_surname"},{"label":"Representative’s Email Address","name":"rep_email_address","type":"email"},{"description":"This should be one of the organization’s publicly-listed telephone numbers.","is_optional":1,"label":"Representative’s Telephone Number","name":"rep_telephone","type":"tel"},{"description":"Consult the EV SSL Certificate Guidelines (https://cabforum.org/extended-validation/) for more information about this field’s options.","label":"Business Category","name":"business_category","options":[["b","Incorporated Business (“Private Organization”)"],["d","Non-incorporated Business (“Business Entity”)"],["c","Government Entity (“Government Entity”)"]],"type":"choose_one"},{"is_optional":1,"label":"City Where Incorporated (JOI (Jurisdiction of Incorporation))","name":"joi_locality_name"},{"is_optional":1,"label":"State or Province Where Incorporated (JOI (Jurisdiction of Incorporation))","name":"joi_state_or_province_name"},{"label":"Country Code Where Incorporated (JOI (Jurisdiction of Incorporation))","name":"joi_country_name","type":"country_code"},{"is_optional":1,"label":"Date of Incorporation","name":"date_of_incorporation","type":"date"},{"is_optional":1,"label":"Assumed Name (DBA (Doing Business As))","name":"assumed_name"}],"x_max_http_redirects":0,"x_payment_trigger":"checkout","x_price_per_domain":108,"x_price_per_domain_maximum":1080,"x_price_per_domain_minimum":108,"x_ssl_per_domain_pricing":1,"x_supports_dns_dcv":1,"x_validation_type":"ev","x_warn_after":604800},{"base_name":"","billing_type":"one-time","description":"An organization-validated (OV) SSL certificate signed by COMODO.","display_name":"Comodo OV SSL Certificate","enabled":1,"icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iNTUwIiB3aWR0aD0iNDE3LjE2Ij48ZyBmaWxsPSIjMzViNTZjIj48cGF0aCBkPSJNNDE0LjM5NiAyNmM3LTExIDAtMjYtMTMtMjZIMTg3LjM5NWMtNDUgMC04MSAxMi0xMDcgMzZzLTQyIDU4LTQ2IDEwM2wtMTAgMTE2Yy00IDQ1IDUgNzkgMjggMTAzIDIyIDI0IDU2IDM2IDEwMSAzNmg0OXYtMWM5LjAwMS0xIDE1LjAwMS03IDE2LjAwMS0xN2w1LTU3YzAtMTEtNy0xOS0xOC4wMDEtMTloLTI3Yy0xNyAwLTMwLTQtMzctMTItNy03LTEwLTIwLTgtMzlsOS0xMDRjMi0xOCA3LTMxIDE1LTM5czIxLTEyIDM5LTEyaDE0NC4wMDFjMTcgMCAzNC05IDQ0LTIzbDMwLTQ1Ii8+PHBhdGggZD0iTTMuMzk1IDUyNGMtOCAxMS0xIDI2IDEyIDI2aDIxNy4wMDFjNDUgMCA4MS0xMiAxMDgtMzYgMjYtMjQgNDEtNTggNDUtMTAybDExLTExN2MzLTQ1LTYtNzktMjgtMTAzLTIzLTI0LTU2LTM2LTEwMS0zNmgtNDl2MWMtMTAuMDAxIDEtMTUuMDAxIDctMTYuMDAxIDE3bC01IDU4Yy0xIDEwIDcgMTggMTcuMDAxIDE4aDI3YzE4IDAgMzAgNCAzNyAxMnMxMCAyMSA5IDM5bC0xMCAxMDRjLTEgMTktNiAzMi0xNCAzOS05IDgtMjIgMTItNDAgMTJINzYuMzk1Yy0xNyAwLTMzIDktNDMgMjRsLTMwIDQ0Ii8+PC9nPjwvc3ZnPg==","icon_mime_type":"image/svg+xml","license_term":0,"max_users":null,"maximum_server_price":null,"minimum_server_price":null,"price":null,"price_unit":"USD","product":"Comodo OV Certificate","product_category":"N/A","product_group":"ssl_certificate","product_id":217,"provider_display_name":"cPanel Store","provider_name":"cPStore","recommended":0,"requires_ip":0,"x_certificate_term":[1,"year"],"x_identity_verification":[{"label":"Organization Name","name":"organizationName"},{"is_optional":1,"label":"Department Name","name":"organizationalUnitName"},{"description":"9 consecutive digits or “##-###-####” (More information (https://go.cpanel.net/get_duns))","is_optional":1,"label":"Dun & Bradstreet D-U-N-S (Data Universal Numbering System) Number","name":"duns_number","pattern":"^[0-9]{2}(?:-[0-9]{3}-[0-9]{4}|[0-9]{7})$"},{"label":"Street Address","name":"streetAddress"},{"label":"City","name":"localityName"},{"label":"State or Province","name":"stateOrProvinceName"},{"label":"Postal Code","name":"postalCode"},{"label":"Country Code","name":"countryName","type":"country_code"},{"label":"Representative’s Given (First) Name","name":"rep_forename"},{"label":"Representative’s Surname (Last Name)","name":"rep_surname"},{"label":"Representative’s Email Address","name":"rep_email_address","type":"email"},{"description":"This should be one of the organization’s publicly-listed telephone numbers.","is_optional":1,"label":"Representative’s Telephone Number","name":"rep_telephone","type":"tel"}],"x_max_http_redirects":0,"x_payment_trigger":"checkout","x_price_per_domain":36,"x_price_per_domain_maximum":360,"x_price_per_domain_minimum":36,"x_price_per_wildcard_domain":"150.00","x_price_per_wildcard_domain_maximum":"1500.00","x_price_per_wildcard_domain_minimum":"150.00","x_ssl_per_domain_pricing":1,"x_supports_dns_dcv":1,"x_validation_type":"ov","x_warn_after":604800,"x_wildcard_parent_domain_free":1},{"base_name":"","billing_type":"one-time","description":"A domain-validated (DV) SSL certificate signed by cPanel.","display_name":"cPanel DV SSL Certificate","enabled":1,"icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzNTlwdCIgaGVpZ2h0PSIzMjAiIHZpZXdCb3g9IjAgMCAzNTkgMjQwIj48ZGVmcz48Y2xpcFBhdGggaWQ9ImEiPjxwYXRoIGQ9Ik0xMjMgMGgyMzUuMzd2MjQwSDEyM3ptMCAwIi8+PC9jbGlwUGF0aD48L2RlZnM+PHBhdGggZD0iTTg5LjY5IDU5LjEwMmg2Ny44MDJsLTEwLjUgNDAuMmMtMS42MDUgNS42LTQuNjA1IDEwLjEtOSAxMy41LTQuNDAyIDMuNC05LjUwNCA1LjA5Ni0xNS4zIDUuMDk2aC0zMS41Yy03LjIgMC0xMy41NSAyLjEwMi0xOS4wNSA2LjMtNS41MDUgNC4yLTkuMzUzIDkuOTA0LTExLjU1MiAxNy4xMDMtMS40IDUuNDAzLTEuNTUgMTAuNS0uNDUgMTUuMzAyIDEuMDk4IDQuNzk2IDMuMDQ3IDkuMDUgNS44NTIgMTIuNzUgMi43OTcgMy43MDMgNi40IDYuNjUyIDEwLjc5NyA4Ljg1IDQuMzk3IDIuMiA5LjE5OCAzLjI5OCAxNC40IDMuMjk4aDE5LjJjMy42MDIgMCA2LjU0NyAxLjQ1MyA4Ljg1MiA0LjM1MiAyLjI5NyAyLjkwMiAyLjk0NSA2LjE0OCAxLjk1IDkuNzVsLTEyIDQ0LjM5OGgtMjFjLTE0LjQwMyAwLTI3LjY1My0zLjE0OC0zOS43NS05LjQ1LTEyLjEwMi02LjMtMjIuMTUzLTE0LjY0OC0zMC4xNTMtMjUuMDUtOC0xMC4zOTUtMTMuNDU0LTIyLjI0Ni0xNi4zNS0zNS41NDctMi45LTEzLjMtMi41NS0yNi45NSAxLjA1Mi00MC45NTNsMS4yLTQuNWMyLjU5Ny05LjYwMiA2LjY0OC0xOC40NSAxMi4xNDgtMjYuNTUgNS41LTguMDk4IDEyLTE1IDE5LjUtMjAuNyA3LjUtNS43IDE1Ljg1LTEwLjE0OCAyNS4wNS0xMy4zNTIgOS4yLTMuMTk1IDE4Ljc5Ny00Ljc5NiAyOC44LTQuNzk2IiBmaWxsPSIjZmY2YzJjIi8+PGcgY2xpcC1wYXRoPSJ1cmwoI2EpIj48cGF0aCBkPSJNMTIzLjg5IDI0MEwxODIuOTkgMTguNjAyYzEuNTk4LTUuNTk4IDQuNTk4LTEwLjA5OCA5LTEzLjVDMTk2LjM4OCAxLjcgMjAxLjQ4NCAwIDIwNy4yODggMGg2Mi43YzE0LjQwMyAwIDI3LjY1IDMuMTQ4IDM5Ljc1IDkuNDUgMTIuMTAyIDYuMyAyMi4xNTMgMTQuNjU1IDMwLjE1MyAyNS4wNSA3Ljk5NyAxMC40MDIgMTMuNSAyMi4yNTQgMTYuNSAzNS41NSAzIDEzLjMwNSAyLjU5NCAyNi45NTQtMS4yMDIgNDAuOTVsLTEuMiA0LjVjLTIuNTk3IDkuNjAyLTYuNTk3IDE4LjQ1LTEyIDI2LjU1LTUuMzk4IDguMDk4LTExLjg0NyAxNS4wNTItMTkuMzQ3IDIwLjg0OC03LjUgNS44MDUtMTUuODU1IDEwLjMwNS0yNS4wNSAxMy41LTkuMiAzLjIwNC0xOC44MDUgNC44MDUtMjguODA1IDQuODA1aC01NC4yOTdsMTAuOC00MC41YzEuNi01LjQwMiA0LjYtOS44IDktMTMuMjAzIDQuMzk2LTMuMzk4IDkuNDk3LTUuMTAyIDE1LjMwMi01LjEwMmgxNy4zOThjNy4yIDAgMTMuNjUzLTIuMiAxOS4zNTItNi41OTcgNS42OTUtNC4zOTggOS40NDUtMTAuMDk3IDExLjI1LTE3LjEgMS4zOTQtNC45OTcgMS41NDctOS45LjQ0NS0xNC43LTEuMS00LjgtMy4wNS05LjA0Ny01Ljg0OC0xMi43NS0yLjgtMy42OTUtNi40MDItNi42OTUtMTAuNzk2LTktNC40MDYtMi4yOTctOS4yMDYtMy40NS0xNC40MDItMy40NUgyMzMuMzlsLTQzLjggMTYyLjkwM2MtMS42MDYgNS40LTQuNjA2IDkuNzk3LTkgMTMuMTk1LTQuNDAzIDMuNDA3LTkuNDA2IDUuMTAyLTE1IDUuMTAyaC00MS43IiBmaWxsPSIjZmY2YzJjIi8+PC9nPjwvc3ZnPgo=","icon_mime_type":"image/svg+xml","license_term":0,"max_users":null,"maximum_server_price":null,"minimum_server_price":null,"price":null,"price_unit":"USD","product":"cPanel DV Certificate","product_category":"N/A","product_group":"ssl_certificate","product_id":159,"provider_display_name":"cPanel Store","provider_name":"cPStore","recommended":0,"requires_ip":0,"x_certificate_term":[1,"year"],"x_identity_verification":null,"x_max_http_redirects":0,"x_payment_trigger":"issuance","x_price_per_domain":9,"x_price_per_domain_maximum":30,"x_price_per_domain_minimum":3,"x_price_per_wildcard_domain":"75.00","x_price_per_wildcard_domain_maximum":"750.00","x_price_per_wildcard_domain_minimum":"75.00","x_ssl_per_domain_pricing":1,"x_supports_dns_dcv":1,"x_validation_type":"dv","x_warn_after":604800,"x_wildcard_parent_domain_free":1},{"base_name":"","billing_type":"one-time","description":"An organization-validated (OV) SSL certificate signed by cPanel.","display_name":"cPanel OV SSL Certificate","enabled":1,"icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzNTlwdCIgaGVpZ2h0PSIzMjAiIHZpZXdCb3g9IjAgMCAzNTkgMjQwIj48ZGVmcz48Y2xpcFBhdGggaWQ9ImEiPjxwYXRoIGQ9Ik0xMjMgMGgyMzUuMzd2MjQwSDEyM3ptMCAwIi8+PC9jbGlwUGF0aD48L2RlZnM+PHBhdGggZD0iTTg5LjY5IDU5LjEwMmg2Ny44MDJsLTEwLjUgNDAuMmMtMS42MDUgNS42LTQuNjA1IDEwLjEtOSAxMy41LTQuNDAyIDMuNC05LjUwNCA1LjA5Ni0xNS4zIDUuMDk2aC0zMS41Yy03LjIgMC0xMy41NSAyLjEwMi0xOS4wNSA2LjMtNS41MDUgNC4yLTkuMzUzIDkuOTA0LTExLjU1MiAxNy4xMDMtMS40IDUuNDAzLTEuNTUgMTAuNS0uNDUgMTUuMzAyIDEuMDk4IDQuNzk2IDMuMDQ3IDkuMDUgNS44NTIgMTIuNzUgMi43OTcgMy43MDMgNi40IDYuNjUyIDEwLjc5NyA4Ljg1IDQuMzk3IDIuMiA5LjE5OCAzLjI5OCAxNC40IDMuMjk4aDE5LjJjMy42MDIgMCA2LjU0NyAxLjQ1MyA4Ljg1MiA0LjM1MiAyLjI5NyAyLjkwMiAyLjk0NSA2LjE0OCAxLjk1IDkuNzVsLTEyIDQ0LjM5OGgtMjFjLTE0LjQwMyAwLTI3LjY1My0zLjE0OC0zOS43NS05LjQ1LTEyLjEwMi02LjMtMjIuMTUzLTE0LjY0OC0zMC4xNTMtMjUuMDUtOC0xMC4zOTUtMTMuNDU0LTIyLjI0Ni0xNi4zNS0zNS41NDctMi45LTEzLjMtMi41NS0yNi45NSAxLjA1Mi00MC45NTNsMS4yLTQuNWMyLjU5Ny05LjYwMiA2LjY0OC0xOC40NSAxMi4xNDgtMjYuNTUgNS41LTguMDk4IDEyLTE1IDE5LjUtMjAuNyA3LjUtNS43IDE1Ljg1LTEwLjE0OCAyNS4wNS0xMy4zNTIgOS4yLTMuMTk1IDE4Ljc5Ny00Ljc5NiAyOC44LTQuNzk2IiBmaWxsPSIjZmY2YzJjIi8+PGcgY2xpcC1wYXRoPSJ1cmwoI2EpIj48cGF0aCBkPSJNMTIzLjg5IDI0MEwxODIuOTkgMTguNjAyYzEuNTk4LTUuNTk4IDQuNTk4LTEwLjA5OCA5LTEzLjVDMTk2LjM4OCAxLjcgMjAxLjQ4NCAwIDIwNy4yODggMGg2Mi43YzE0LjQwMyAwIDI3LjY1IDMuMTQ4IDM5Ljc1IDkuNDUgMTIuMTAyIDYuMyAyMi4xNTMgMTQuNjU1IDMwLjE1MyAyNS4wNSA3Ljk5NyAxMC40MDIgMTMuNSAyMi4yNTQgMTYuNSAzNS41NSAzIDEzLjMwNSAyLjU5NCAyNi45NTQtMS4yMDIgNDAuOTVsLTEuMiA0LjVjLTIuNTk3IDkuNjAyLTYuNTk3IDE4LjQ1LTEyIDI2LjU1LTUuMzk4IDguMDk4LTExLjg0NyAxNS4wNTItMTkuMzQ3IDIwLjg0OC03LjUgNS44MDUtMTUuODU1IDEwLjMwNS0yNS4wNSAxMy41LTkuMiAzLjIwNC0xOC44MDUgNC44MDUtMjguODA1IDQuODA1aC01NC4yOTdsMTAuOC00MC41YzEuNi01LjQwMiA0LjYtOS44IDktMTMuMjAzIDQuMzk2LTMuMzk4IDkuNDk3LTUuMTAyIDE1LjMwMi01LjEwMmgxNy4zOThjNy4yIDAgMTMuNjUzLTIuMiAxOS4zNTItNi41OTcgNS42OTUtNC4zOTggOS40NDUtMTAuMDk3IDExLjI1LTE3LjEgMS4zOTQtNC45OTcgMS41NDctOS45LjQ0NS0xNC43LTEuMS00LjgtMy4wNS05LjA0Ny01Ljg0OC0xMi43NS0yLjgtMy42OTUtNi40MDItNi42OTUtMTAuNzk2LTktNC40MDYtMi4yOTctOS4yMDYtMy40NS0xNC40MDItMy40NUgyMzMuMzlsLTQzLjggMTYyLjkwM2MtMS42MDYgNS40LTQuNjA2IDkuNzk3LTkgMTMuMTk1LTQuNDAzIDMuNDA3LTkuNDA2IDUuMTAyLTE1IDUuMTAyaC00MS43IiBmaWxsPSIjZmY2YzJjIi8+PC9nPjwvc3ZnPgo=","icon_mime_type":"image/svg+xml","license_term":0,"max_users":null,"maximum_server_price":null,"minimum_server_price":null,"price":null,"price_unit":"USD","product":"cPanel OV Certificate","product_category":"N/A","product_group":"ssl_certificate","product_id":213,"provider_display_name":"cPanel Store","provider_name":"cPStore","recommended":0,"requires_ip":0,"x_certificate_term":[1,"year"],"x_identity_verification":[{"label":"Organization Name","name":"organizationName"},{"is_optional":1,"label":"Department Name","name":"organizationalUnitName"},{"description":"9 consecutive digits or “##-###-####” (More information (https://go.cpanel.net/get_duns))","is_optional":1,"label":"Dun & Bradstreet D-U-N-S (Data Universal Numbering System) Number","name":"duns_number","pattern":"^[0-9]{2}(?:-[0-9]{3}-[0-9]{4}|[0-9]{7})$"},{"label":"Street Address","name":"streetAddress"},{"label":"City","name":"localityName"},{"label":"State or Province","name":"stateOrProvinceName"},{"label":"Postal Code","name":"postalCode"},{"label":"Country Code","name":"countryName","type":"country_code"},{"label":"Representative’s Given (First) Name","name":"rep_forename"},{"label":"Representative’s Surname (Last Name)","name":"rep_surname"},{"label":"Representative’s Email Address","name":"rep_email_address","type":"email"},{"description":"This should be one of the organization’s publicly-listed telephone numbers.","is_optional":1,"label":"Representative’s Telephone Number","name":"rep_telephone","type":"tel"}],"x_max_http_redirects":0,"x_payment_trigger":"checkout","x_price_per_domain":30,"x_price_per_domain_maximum":300,"x_price_per_domain_minimum":30,"x_price_per_wildcard_domain":"99.00","x_price_per_wildcard_domain_maximum":"990.00","x_price_per_wildcard_domain_minimum":"99.00","x_ssl_per_domain_pricing":1,"x_supports_dns_dcv":1,"x_validation_type":"ov","x_warn_after":604800,"x_wildcard_parent_domain_free":1},{"base_name":"","billing_type":"one-time","description":"A domain-validated (DV) SSL certificate signed by COMODO.","display_name":"Comodo DV SSL Certificate","enabled":1,"icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iNTUwIiB3aWR0aD0iNDE3LjE2Ij48ZyBmaWxsPSIjMzViNTZjIj48cGF0aCBkPSJNNDE0LjM5NiAyNmM3LTExIDAtMjYtMTMtMjZIMTg3LjM5NWMtNDUgMC04MSAxMi0xMDcgMzZzLTQyIDU4LTQ2IDEwM2wtMTAgMTE2Yy00IDQ1IDUgNzkgMjggMTAzIDIyIDI0IDU2IDM2IDEwMSAzNmg0OXYtMWM5LjAwMS0xIDE1LjAwMS03IDE2LjAwMS0xN2w1LTU3YzAtMTEtNy0xOS0xOC4wMDEtMTloLTI3Yy0xNyAwLTMwLTQtMzctMTItNy03LTEwLTIwLTgtMzlsOS0xMDRjMi0xOCA3LTMxIDE1LTM5czIxLTEyIDM5LTEyaDE0NC4wMDFjMTcgMCAzNC05IDQ0LTIzbDMwLTQ1Ii8+PHBhdGggZD0iTTMuMzk1IDUyNGMtOCAxMS0xIDI2IDEyIDI2aDIxNy4wMDFjNDUgMCA4MS0xMiAxMDgtMzYgMjYtMjQgNDEtNTggNDUtMTAybDExLTExN2MzLTQ1LTYtNzktMjgtMTAzLTIzLTI0LTU2LTM2LTEwMS0zNmgtNDl2MWMtMTAuMDAxIDEtMTUuMDAxIDctMTYuMDAxIDE3bC01IDU4Yy0xIDEwIDcgMTggMTcuMDAxIDE4aDI3YzE4IDAgMzAgNCAzNyAxMnMxMCAyMSA5IDM5bC0xMCAxMDRjLTEgMTktNiAzMi0xNCAzOS05IDgtMjIgMTItNDAgMTJINzYuMzk1Yy0xNyAwLTMzIDktNDMgMjRsLTMwIDQ0Ii8+PC9nPjwvc3ZnPg==","icon_mime_type":"image/svg+xml","license_term":0,"max_users":null,"maximum_server_price":null,"minimum_server_price":null,"price":null,"price_unit":"USD","product":"Comodo DV Certificate","product_category":"N/A","product_group":"ssl_certificate","product_id":151,"provider_display_name":"cPanel Store","provider_name":"cPStore","recommended":0,"requires_ip":0,"x_certificate_term":[1,"year"],"x_identity_verification":null,"x_max_http_redirects":0,"x_payment_trigger":"issuance","x_price_per_domain":12,"x_price_per_domain_maximum":120,"x_price_per_domain_minimum":12,"x_price_per_wildcard_domain":"99.00","x_price_per_wildcard_domain_maximum":"990.00","x_price_per_wildcard_domain_minimum":"99.00","x_ssl_per_domain_pricing":1,"x_supports_dns_dcv":1,"x_validation_type":"dv","x_warn_after":604800,"x_wildcard_parent_domain_free":1},{"base_name":"","billing_type":"one-time","description":"An extended-validated (EV) SSL certificate signed by cPanel.","display_name":"cPanel EV SSL Certificate","enabled":1,"icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzNTlwdCIgaGVpZ2h0PSIzMjAiIHZpZXdCb3g9IjAgMCAzNTkgMjQwIj48ZGVmcz48Y2xpcFBhdGggaWQ9ImEiPjxwYXRoIGQ9Ik0xMjMgMGgyMzUuMzd2MjQwSDEyM3ptMCAwIi8+PC9jbGlwUGF0aD48L2RlZnM+PHBhdGggZD0iTTg5LjY5IDU5LjEwMmg2Ny44MDJsLTEwLjUgNDAuMmMtMS42MDUgNS42LTQuNjA1IDEwLjEtOSAxMy41LTQuNDAyIDMuNC05LjUwNCA1LjA5Ni0xNS4zIDUuMDk2aC0zMS41Yy03LjIgMC0xMy41NSAyLjEwMi0xOS4wNSA2LjMtNS41MDUgNC4yLTkuMzUzIDkuOTA0LTExLjU1MiAxNy4xMDMtMS40IDUuNDAzLTEuNTUgMTAuNS0uNDUgMTUuMzAyIDEuMDk4IDQuNzk2IDMuMDQ3IDkuMDUgNS44NTIgMTIuNzUgMi43OTcgMy43MDMgNi40IDYuNjUyIDEwLjc5NyA4Ljg1IDQuMzk3IDIuMiA5LjE5OCAzLjI5OCAxNC40IDMuMjk4aDE5LjJjMy42MDIgMCA2LjU0NyAxLjQ1MyA4Ljg1MiA0LjM1MiAyLjI5NyAyLjkwMiAyLjk0NSA2LjE0OCAxLjk1IDkuNzVsLTEyIDQ0LjM5OGgtMjFjLTE0LjQwMyAwLTI3LjY1My0zLjE0OC0zOS43NS05LjQ1LTEyLjEwMi02LjMtMjIuMTUzLTE0LjY0OC0zMC4xNTMtMjUuMDUtOC0xMC4zOTUtMTMuNDU0LTIyLjI0Ni0xNi4zNS0zNS41NDctMi45LTEzLjMtMi41NS0yNi45NSAxLjA1Mi00MC45NTNsMS4yLTQuNWMyLjU5Ny05LjYwMiA2LjY0OC0xOC40NSAxMi4xNDgtMjYuNTUgNS41LTguMDk4IDEyLTE1IDE5LjUtMjAuNyA3LjUtNS43IDE1Ljg1LTEwLjE0OCAyNS4wNS0xMy4zNTIgOS4yLTMuMTk1IDE4Ljc5Ny00Ljc5NiAyOC44LTQuNzk2IiBmaWxsPSIjZmY2YzJjIi8+PGcgY2xpcC1wYXRoPSJ1cmwoI2EpIj48cGF0aCBkPSJNMTIzLjg5IDI0MEwxODIuOTkgMTguNjAyYzEuNTk4LTUuNTk4IDQuNTk4LTEwLjA5OCA5LTEzLjVDMTk2LjM4OCAxLjcgMjAxLjQ4NCAwIDIwNy4yODggMGg2Mi43YzE0LjQwMyAwIDI3LjY1IDMuMTQ4IDM5Ljc1IDkuNDUgMTIuMTAyIDYuMyAyMi4xNTMgMTQuNjU1IDMwLjE1MyAyNS4wNSA3Ljk5NyAxMC40MDIgMTMuNSAyMi4yNTQgMTYuNSAzNS41NSAzIDEzLjMwNSAyLjU5NCAyNi45NTQtMS4yMDIgNDAuOTVsLTEuMiA0LjVjLTIuNTk3IDkuNjAyLTYuNTk3IDE4LjQ1LTEyIDI2LjU1LTUuMzk4IDguMDk4LTExLjg0NyAxNS4wNTItMTkuMzQ3IDIwLjg0OC03LjUgNS44MDUtMTUuODU1IDEwLjMwNS0yNS4wNSAxMy41LTkuMiAzLjIwNC0xOC44MDUgNC44MDUtMjguODA1IDQuODA1aC01NC4yOTdsMTAuOC00MC41YzEuNi01LjQwMiA0LjYtOS44IDktMTMuMjAzIDQuMzk2LTMuMzk4IDkuNDk3LTUuMTAyIDE1LjMwMi01LjEwMmgxNy4zOThjNy4yIDAgMTMuNjUzLTIuMiAxOS4zNTItNi41OTcgNS42OTUtNC4zOTggOS40NDUtMTAuMDk3IDExLjI1LTE3LjEgMS4zOTQtNC45OTcgMS41NDctOS45LjQ0NS0xNC43LTEuMS00LjgtMy4wNS05LjA0Ny01Ljg0OC0xMi43NS0yLjgtMy42OTUtNi40MDItNi42OTUtMTAuNzk2LTktNC40MDYtMi4yOTctOS4yMDYtMy40NS0xNC40MDItMy40NUgyMzMuMzlsLTQzLjggMTYyLjkwM2MtMS42MDYgNS40LTQuNjA2IDkuNzk3LTkgMTMuMTk1LTQuNDAzIDMuNDA3LTkuNDA2IDUuMTAyLTE1IDUuMTAyaC00MS43IiBmaWxsPSIjZmY2YzJjIi8+PC9nPjwvc3ZnPgo=","icon_mime_type":"image/svg+xml","license_term":0,"max_users":null,"maximum_server_price":null,"minimum_server_price":null,"price":null,"price_unit":"USD","product":"cPanel EV Certificate","product_category":"N/A","product_group":"ssl_certificate","product_id":209,"provider_display_name":"cPanel Store","provider_name":"cPStore","recommended":0,"requires_ip":0,"x_certificate_term":[1,"year"],"x_identity_verification":[{"label":"Organization Name","name":"organizationName"},{"is_optional":1,"label":"Department Name","name":"organizationalUnitName"},{"description":"9 consecutive digits or “##-###-####” (More information (https://go.cpanel.net/get_duns))","is_optional":1,"label":"Dun & Bradstreet D-U-N-S (Data Universal Numbering System) Number","name":"duns_number","pattern":"^[0-9]{2}(?:-[0-9]{3}-[0-9]{4}|[0-9]{7})$"},{"label":"Street Address","name":"streetAddress"},{"label":"City","name":"localityName"},{"label":"State or Province","name":"stateOrProvinceName"},{"label":"Postal Code","name":"postalCode"},{"label":"Country Code","name":"countryName","type":"country_code"},{"label":"Representative’s Given (First) Name","name":"rep_forename"},{"label":"Representative’s Surname (Last Name)","name":"rep_surname"},{"label":"Representative’s Email Address","name":"rep_email_address","type":"email"},{"description":"This should be one of the organization’s publicly-listed telephone numbers.","is_optional":1,"label":"Representative’s Telephone Number","name":"rep_telephone","type":"tel"},{"description":"Consult the EV SSL Certificate Guidelines (https://cabforum.org/extended-validation/) for more information about this field’s options.","label":"Business Category","name":"business_category","options":[["b","Incorporated Business (“Private Organization”)"],["d","Non-incorporated Business (“Business Entity”)"],["c","Government Entity (“Government Entity”)"]],"type":"choose_one"},{"is_optional":1,"label":"City Where Incorporated (JOI (Jurisdiction of Incorporation))","name":"joi_locality_name"},{"is_optional":1,"label":"State or Province Where Incorporated (JOI (Jurisdiction of Incorporation))","name":"joi_state_or_province_name"},{"label":"Country Code Where Incorporated (JOI (Jurisdiction of Incorporation))","name":"joi_country_name","type":"country_code"},{"is_optional":1,"label":"Date of Incorporation","name":"date_of_incorporation","type":"date"},{"is_optional":1,"label":"Assumed Name (DBA (Doing Business As))","name":"assumed_name"}],"x_max_http_redirects":0,"x_payment_trigger":"checkout","x_price_per_domain":60,"x_price_per_domain_maximum":600,"x_price_per_domain_minimum":60,"x_ssl_per_domain_pricing":1,"x_supports_dns_dcv":1,"x_validation_type":"ev","x_warn_after":604800}],"errors":null,"messages":null,"metadata":{"transformed":1},"status":1,"warnings":null}}}},"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_all_products","type":"string"},"module":{"description":"The name of the module called.","example":"Market","type":"string"},"result":{"properties":{"data":{"items":{"$ref":"#/components/schemas/MarketProviderProductMetaDataType"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return provider's available products","tags":["Market","Market Integration"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Market \\\n  get_all_products\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Market/get_all_products"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Market_get_all_products.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Market_get_all_products.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Market/,\n    q/get_all_products/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Market_get_all_products.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Market_get_all_products.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Market',\n    'get_all_products'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 56"}},"/Market/create_shopping_cart":{"get":{"description":"This function creates a shopping cart with which the system sends an order to the cPanel Store. Typically, the system will send shopping cart orders for SSL certificates to UAPI’s `Market::request_ssl_certificates` function.","operationId":"create_shopping_cart","parameters":[{"description":"The cPanel Market provider’s name.","in":"query","name":"provider","required":true,"schema":{"example":"cPStore","type":"string"}},{"description":"The access token to connect to the provider.","in":"query","name":"access_token","required":true,"schema":{"example":"1a676e6f-99fc-11e6-9ab6-e60a769b73bc","format":"uuid","type":"string"}},{"description":"The location to which the provider directs the user after the checkout process is complete.","in":"query","name":"url_after_checkout","required":true,"schema":{"example":"http://www.example.com/thenextplace","format":"url","type":"string"}},{"description":"The items to add to the shopping cart.\n\n**Note**:\n\n  The value is a JSON string.\n\n  This object has one required key, `product_id`, which is a string.\n\n  The other keys/values in this object vary depending on the provider.","example":["{\"product_id\":123456,\"provider-specfic-key\":\"provider-specfic-value\",\"another-provider-specfic-key\":\"another-provider-specfic-value\"}","{\"product_id\":123457,\"provider-specfic-key\":\"provider-specfic-value\",\"another-provider-specfic-key\":\"another-provider-specfic-value\"}"],"explode":true,"in":"query","name":"item","required":true,"schema":{"items":{"format":"json","type":"string"},"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"create_shopping_cart","type":"string"},"module":{"description":"The name of the module called.","example":"Market","type":"string"},"result":{"properties":{"data":{"properties":{"checkout_url":{"description":"The location of the provider’s check out page.","example":"http://www.example.com/checkout","format":"url","type":"string"},"order_id":{"description":"The order’s ID.","example":"8765309","type":"string"},"order_items":{"description":"An array of objects that contain information about Items in the shopping cart. The function returns these values in the order in which you called them. This array of objects returns values that vary between providers.","items":{"type":"object"},"type":"array"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create shopping cart","tags":["Market","Market Integration"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Market \\\n  create_shopping_cart \\\n  provider='cPStore' \\\n  access_token='1a676e6f-99fc-11e6-9ab6-e60a769b73bc' \\\n  url_after_checkout='http://www.example.com/thenextplace' \\\n  item='{\"product_id\":123456,\"provider-specfic-key\":\"provider-specfic-value\",\"another-provider-specfic-key\":\"another-provider-specfic-value\"}' item='{\"product_id\":123457,\"provider-specfic-key\":\"provider-specfic-value\",\"another-provider-specfic-key\":\"another-provider-specfic-value\"}'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Market/create_shopping_cart?provider=cPStore&access_token=1a676e6f-99fc-11e6-9ab6-e60a769b73bc&url_after_checkout=http%3a%2f%2fwww.example.com%2fthenextplace&item=%7b%22product_id%22%3a123456%2c%22provider-specfic-key%22%3a%22provider-specfic-value%22%2c%22another-provider-specfic-key%22%3a%22another-provider-specfic-value%22%7d&item=%7b%22product_id%22%3a123457%2c%22provider-specfic-key%22%3a%22provider-specfic-value%22%2c%22another-provider-specfic-key%22%3a%22another-provider-specfic-value%22%7d"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Market_create_shopping_cart.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Market_create_shopping_cart.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Market/,\n    q/create_shopping_cart/,\n    {\n        'provider' => 'cPStore',\n        'access_token' => '1a676e6f-99fc-11e6-9ab6-e60a769b73bc',\n        'url_after_checkout' => 'http://www.example.com/thenextplace',\n        'item' => '{\"product_id\":123456,\"provider-specfic-key\":\"provider-specfic-value\",\"another-provider-specfic-key\":\"another-provider-specfic-value\"}'&item='{\"product_id\":123457,\"provider-specfic-key\":\"provider-specfic-value\",\"another-provider-specfic-key\":\"another-provider-specfic-value\"}',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Market_create_shopping_cart.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Market_create_shopping_cart.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Market',\n    'create_shopping_cart',\n    array (\n        'provider' => 'cPStore',\n        'access_token' => '1a676e6f-99fc-11e6-9ab6-e60a769b73bc',\n        'url_after_checkout' => 'http://www.example.com/thenextplace',\n        'item' => '{\"product_id\":123456,\"provider-specfic-key\":\"provider-specfic-value\",\"another-provider-specfic-key\":\"another-provider-specfic-value\"}'&item='{\"product_id\":123457,\"provider-specfic-key\":\"provider-specfic-value\",\"another-provider-specfic-key\":\"another-provider-specfic-value\"}',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 62"}},"/Mailboxes/set_utf8_mailbox_names":{"get":{"description":"This function enables or disables UTF-8-encoded mailbox names on Roundcube webmail for a cPanel user's email accounts.","operationId":"set_utf8_mailbox_names","parameters":[{"description":"Whether to enable or disable UTF-8 character-encoded mailbox\nnames.\n\n* `1` - Enable UTF-8 encoded mailbox names.\n* `0` - Disable UTF-8 encoded mailbox names.","in":"query","name":"enabled","required":true,"schema":{"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_utf8_mailbox_names","type":"string"},"module":{"description":"The name of the module called.","example":"Mailboxes","type":"string"},"result":{"properties":{"data":{"properties":{"success":{"description":"Whether the system changed mailbox name setting's status.\n* `1` - Success.\n* `0` - Failure.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable or disable Webmail mailbox UTF-8 encoding","tags":["Mailboxes","Mailbox Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mailboxes \\\n  set_utf8_mailbox_names \\\n  enabled='1'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mailboxes/set_utf8_mailbox_names?enabled=1"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mailboxes_set_utf8_mailbox_names.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mailboxes_set_utf8_mailbox_names.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mailboxes/,\n    q/set_utf8_mailbox_names/,\n    {\n        'enabled' => '1',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mailboxes_set_utf8_mailbox_names.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mailboxes_set_utf8_mailbox_names.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mailboxes',\n    'set_utf8_mailbox_names',\n    array (\n        'enabled' => '1',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 78"}},"/Market/get_certificate_status_details":{"get":{"description":"This function returns the status of an SSL certificate request. The returns include\nactionable URLs for users to expedite the validation process, if applicable.\n\n**Important:**\n\nBecause this function returns data from a dynamic source, the returns in each\nobject can vary.","operationId":"get_certificate_status_details","parameters":[{"description":"The order ID that the cPanel Market provider assigned.","in":"query","name":"order_item_id","required":true,"schema":{"example":1234567890,"minimum":1,"type":"integer"}},{"description":"The cPanel Market provider's name.","in":"query","name":"provider","required":true,"schema":{"example":"cPStore","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_certificate_status_details","type":"string"},"module":{"description":"The name of the module called.","example":"Market","type":"string"},"result":{"properties":{"data":{"properties":{"actionUrls":{"description":"An object that contains actionable URLs.","properties":{"evClickThroughStatus":{"description":"A URL that a user can use to expedite the validation process for Extended Validation (EV) certificates.","example":"https://example.com/action","format":"url","type":"string"},"ovCallbackStatus":{"description":"A URL that a user can use to expedite the validation process for Organization Validated (OV) certificates.","example":"https://example.com/action","format":"url","type":"string"}},"type":"object"},"domain_details":{"description":"An object that contains information about the domain.","properties":{"domain":{"description":"The Fully Qualified Domain Name (FQDN) that the function queries.","example":"www.example.com","format":"domain","type":"string"},"status":{"description":"The status of the domain's certificate.\n\n* `VALIDATED` - The domain has been validated.\n* `NOTVALIDATED` - The domain has **not** been validated.\n* `AWAITINGBRAND` - The domain has **not** been validated, and is awaiting brand approval.","enum":["VALIDATED","NOTVALIDATED","AWAITINGBRAND"],"example":"AWAITINGBRAND","type":"string"}},"type":"object"},"status_details":{"description":"An object that contains specific information about the validation process.","properties":{"brandValStatus":{"description":"Whether the brand validation status has completed.\n\n* `not applicable` - This is **not** applicable for the certificate.\n* `not-completed` - The certificate's brand validation is **not** complete.\n* `completed` - The certificate's brand validation is complete.\n* `in-progress` - The certificate's brand validation is in progress.","enum":["not applicable","not-completed","completed","in-progress"],"example":"in-progress","type":"string"},"certificateStatus":{"description":"Whether the provider has issued the SSL certificate.\n\n* `not applicable` - This is **not** applicable for the certificate.\n* `not-completed` - The certificate's issue is **not** completed.\n* `completed` - The provider has issued the certificate.\n* `in-progress` - The certificate's issue is in progress.","enum":["not applicable","not-completed","completed","in-progress"],"example":"in-progress","type":"string"},"csrStatus":{"description":"Whether the certificate signing request (CSR) has completed.\n\n* `not applicable` - This is **not** applicable for the certificate.\n* `not-completed` - The CSR for the certificate is **not** complete.\n* `completed` - The CSR for the certificate is complete.\n* `in-progress` - The CSR for the certificate is in progress.","enum":["not applicable","not-completed","completed","in-progress"],"example":"completed","type":"string"},"dcvStatus":{"description":"Whether Domain Control Validation (DCV) has completed.\n\n* `not applicable` - This is **not** applicable for the certificate.\n* `not-completed` - The DCV for the certificate is **not** complete.\n* `completed` - The DCV for the certificate is complete.\n* `in-progress` - The DCV for the certificate is in progress.","enum":["not applicable","not-completed","completed","in-progress"],"example":"completed","type":"string"},"evClickThroughStatus":{"description":"Whether every requirement for the EV certificate has completed.\n\n* `not applicable` - This is **not** applicable for the certificate.\n* `not-completed` - The EV certificate's requirements check is **not** complete.\n* `completed` - The EV certificate's requirements check is complete.\n* `in-progress` - The EV certificate's requirements check is in progress.\n\nFor more information, read Sectigo's [What is required for validation?](https://support.sectigo.com/Com_KnowledgeDetailPage?Id=kA01N000000zFOr) documentation.","enum":["not applicable","not-completed","completed","in-progress"],"example":"in-progress","type":"string"},"freeDVUPStatus":{"description":"Whether every requirement for the Domain Validated (DV) certificate has completed.\n\n* `not applicable` - This is **not** applicable for the certificate.\n* `not-completed` - The DV certificate's requirements check is **not** complete.\n* `completed` - The DV certificate's requirements check is complete.\n* `in-progress` - The DV certificate's requirements check is in progress.","enum":["not applicable","not-completed","completed","in-progress"],"example":"not applicable","type":"string"},"organizationValidationStatus":{"description":"Whether every requirement for the OV certificate has completed.\n\n* `not applicable` - This is **not** applicable for the certificate.\n* `not-completed` - The OV certificate's requirements check is **not** complete.\n* `completed` - The OV certificate's requirements check is complete.\n* `in-progress` - The OV certificate's requirements check is in progress.","enum":["not applicable","not-completed","completed","in-progress"],"example":"not applicable","type":"string"},"ovCallbackStatus":{"description":"Whether the Certificate Authority (CA) has verified the organization's validity via a phone call.\n\n* `not applicable` - This is **not** applicable for the certificate.\n* `not-completed` - The CA has **not** verified the organization's validity via phone.\n* `completed` - The CA has verified the organization's validity via phone.\n* `in-progress` - The CA's verification of the organization's validity via phone is in progress.","enum":["not applicable","not-completed","completed","in-progress"],"example":"not applicable","type":"string"},"validationStatus":{"description":"Whether the validation process has completed.\n\n* `not applicable` - This is **not** applicable for the certificate.\n* `not-completed` - The certificate's validation is **not** complete.\n* `completed` - The certificate's validation is complete.\n* `in-progress` - The certificate's validation is in progress.","enum":["not applicable","not-completed","completed","in-progress"],"example":"in-progress","type":"string"}},"type":"object"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":["Certificate request is still being processed."],"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return provider's SSL certificate request status","tags":["Market","SSL Certificates"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Market \\\n  get_certificate_status_details \\\n  order_item_id='1234567890' \\\n  provider='cPStore'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Market/get_certificate_status_details?order_item_id=1234567890&provider=cPStore"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Market_get_certificate_status_details.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Market_get_certificate_status_details.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Market/,\n    q/get_certificate_status_details/,\n    {\n        'order_item_id' => '1234567890',\n        'provider' => 'cPStore',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Market_get_certificate_status_details.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Market_get_certificate_status_details.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Market',\n    'get_certificate_status_details',\n    array (\n        'order_item_id' => '1234567890',\n        'provider' => 'cPStore',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPStore 76"}},"/Market/get_login_url":{"get":{"description":"This function retrieves the login URL for the cPanel Market provider.","operationId":"get_login_url","parameters":[{"description":"The cPanel Market provider's name.","in":"query","name":"provider","required":true,"schema":{"example":"cPStore","type":"string"}},{"description":"Where the cPanel Market provider redirects the user's browser after they log in.","in":"query","name":"url_after_login","required":true,"schema":{"example":"http://hostname.example.com/redirectionlocation.cgi?state","format":"url","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_login_url","type":"string"},"module":{"description":"The name of the module called.","example":"Market","type":"string"},"result":{"properties":{"data":{"description":"The URL to which to redirect the browser after login.","example":"https://example.com/api/?client_id=MyHearseIsAmazing&function=login&module=bogoSSL&redirect_uri=https%3A%2F%2Fqaportal.cpanel.net%2Fbogus.cgi&response_type=token","format":"url","type":"string"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return provider's login URL","tags":["Market","Market Integration"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Market \\\n  get_login_url \\\n  provider='cPStore' \\\n  url_after_login='http://hostname.example.com/redirectionlocation.cgi?state'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Market/get_login_url?provider=cPStore&url_after_login=http%3a%2f%2fhostname.example.com%2fredirectionlocation.cgi%3fstate"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Market_get_login_url.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Market_get_login_url.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Market/,\n    q/get_login_url/,\n    {\n        'provider' => 'cPStore',\n        'url_after_login' => 'http://hostname.example.com/redirectionlocation.cgi?state',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Market_get_login_url.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Market_get_login_url.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Market',\n    'get_login_url',\n    array (\n        'provider' => 'cPStore',\n        'url_after_login' => 'http://hostname.example.com/redirectionlocation.cgi?state',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 56"}},"/Market/get_pending_ssl_certificates":{"get":{"description":"This function lists all pending SSL certificates from a cPanel Market provider for which the system currently polls.","operationId":"get_pending_ssl_certificates","parameters":[{"description":"The cPanel Market provider's name.","in":"query","name":"provider","required":true,"schema":{"example":"cPStore","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_pending_ssl_certificates","type":"string"},"module":{"description":"The name of the module called.","example":"Market","type":"string"},"result":{"properties":{"data":{"description":"An array of objects that contain information about each certificate for which the system polls the provider.","items":{"properties":{"created_time":{"description":"When the system placed the order.","example":1417475501,"format":"unix_timestamp","type":"integer"},"csr":{"description":"The certificate signing request's (CSR) text. A CSR file in Base64 PEM format.","example":"Click to view...-----BEGIN CERTIFICATE REQUEST----- MIIC4DCCAcgCAQAwgZoxFjAUBgNVBAMTDXRlc3RzaW1vbi5jb20xFjAUBgNVBAsT DURvY3VtZW50YXRpb24xDjAMBgNVBAgTBVRleGFzMQ8wDQYDVQQKEwZjUGFuZWwx KDAmBgkqhkiG9w0BCQEWGWxhdXJlbmNlLnNpbW9uQGNwYW5lbC5uZXQxCzAJBgNV BAYTAlVTMRAwDgYDVQQHEwdIb3VzdG9uMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A MIIBCgKCAQEA4AVM6J4Qg3DIFWr/eJ5GRmIATYsJIepKbrDy70sq+udcO8R8xxak 0oMZ/9mUdpjSNK/fLVTuCO0kxTfQ9VUWJllX7ThD6Zh9ZvlC/nf/OEZLm3ZbnBgu 8rbC8E9wuDOkKbJLnINgdhtowIydLK2MJ++q62bFV89jkHWTMcKyyqHENo3hc+lk pd9vnp8rZTinaVb7nX26uQqAFZYRo+WU0G/NPsq40QVSMoqPxyEz4qXo0hvuIlCX mzFZq/6fCVPEKPLhQgMmpdBkMz4dVOazREfqXdjMD2+QXSNiA1AwWr8l0r4rtzlx EYDJIR41yXp0xMl3KoolxMyvLBqZy32niQIDAQABoAAwDQYJKoZIhvcNAQEFBQAD ggEBAEaCn+rg6qlhp6SEKuZg1G6z1M+1XQoTN3E6bTdM3rD1wXjqtyFfYGTy5Bvv gUKrl6t312owJ2si8/K9v/ocVxdjc0rPWSOWScfSc1Od3i1L1YuqbboL2aQSak3y gpGnZMHCUED1y4xyABAFOaXUurFiZj5u3P2mBAYGt2ez2afiPlo5YpTRNCoTUlVz KNKkyUnptBLOvlwGgerBmOoP4QdVhTSuxO9TECsiPdldE1BVZrlFclDFvoP01jFZ WOTWz+k3O202gK4w/tPP2VMVldNFrC0QoENu85ohT1nJj6F3mrM1CZ+1c8zYzr+S 6aAXFhHE6FweeunRAGjEJggoTPo= -----END CERTIFICATE REQUEST-----","format":"base64 certificate","type":"string"},"domains":{"description":"The domains on the certificate.","items":{"example":"example.com","format":"domain","type":"string"},"type":"array"},"expired":{"description":"Whether the pending queue item has been deleted.\n* `1` - Deleted.\n* `0` - **Not** deleted.","enum":[0,1],"example":0,"type":"integer"},"first_poll_time":{"description":"The first time that the system polled the provider for the certificate.","example":1437475501,"format":"unix_timestamp","type":"integer"},"identity_verification":{"description":"hash that contains information to verify an OV or EV certificate request.\n\n**Notes:**\n\n The function returns this hash for OV or EV certificate requests. This hash includes returns that vary between certificate providers. The output example demonstrates what the cPStore returns for an OV certificate.","example":{"assumed_name":"cPanel","business_category":"b","countryName":"US","date_of_incorporation":"1996-01-01","duns_number":"12-345-6789","joi_country_name":"US","joi_locality_name":"Somewhere","joi_state_or_province_name":"PA","localityName":"Houston","organizationName":"WebPros International, LLC","organizationalUnitName":"Team Cobra","postalCode":"77092","rep_email_address":"richard.ang@cpanel.net","rep_forename":"Richard","rep_surname":"Ang","rep_telephone":"713-529-0800","stateOrProvinceName":"TX","streetAddress":"2500 N. Loop W."},"type":"object"},"last_poll_time":{"description":"The last time that the system polled the provider for the certificate.","example":1457475501,"format":"unix_timestamp","type":"integer"},"last_status_code":{"description":"The last status code of the order. The function returns the value in the unnamed hash.\n* `CertificateNotFound` - The system cannot locate the specified certificate.\n* `RequiresApproval` - The specified certificate requires approval.\n* `OrderCanceled` - The system canceled the order of the specified certificate.\n* `OrderItemCanceled` - The system canceled the order item of the specified certificate.","enum":["CertificateNotFound","RequiresApproval","OrderCanceled","OrderItemCanceled"],"example":"CertificateNotFound","type":"string"},"order_id":{"description":"The ID of the order.","example":"AAE35B28-E57B-11E5-A5DD-B633DD41FB49","type":"string"},"order_item_id":{"description":"The ID of the ordered item.","example":"1","type":"string"},"product_id":{"description":"The product's ID.","example":"12345","type":"string"},"provider":{"description":"The cPanel Market provider's name.","example":"cPStore","type":"string"},"status":{"description":"The status of the order.\n* `confirmed` - Payment confirmed.\n* `unconfirmed` - Payment not confirmed.","example":"confirmed","type":"string"},"support_uri":{"description":"The URI of the cPanel Market Provider's support site.","example":"http://support.example.com/","format":"url","type":"string"},"vhost_names":{"description":"The virtual host domains on the certificate.","items":{"example":"example.com","format":"domain","type":"string"},"type":"array"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return provider's pending SSL certificates","tags":["Market","SSL Certificates"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Market \\\n  get_pending_ssl_certificates \\\n  provider='cPStore'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Market/get_pending_ssl_certificates?provider=cPStore"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Market_get_pending_ssl_certificates.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Market_get_pending_ssl_certificates.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Market/,\n    q/get_pending_ssl_certificates/,\n    {\n        'provider' => 'cPStore',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Market_get_pending_ssl_certificates.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Market_get_pending_ssl_certificates.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Market',\n    'get_pending_ssl_certificates',\n    array (\n        'provider' => 'cPStore',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 56"}},"/Market/get_providers_list":{"get":{"description":"This function lists the names of enabled cPanel Market providers.","operationId":"Market-get_providers_list","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_providers_list","type":"string"},"module":{"description":"The name of the module called.","example":"Market","type":"string"},"result":{"properties":{"data":{"description":"An array of objects that lists enabled providers in the cPanel Market.","items":{"properties":{"display_name":{"description":"The cPanel Market provider's display name.","example":"cPanel Store","type":"string"},"name":{"description":"The cPanel Market provider's name.","example":"cPStore","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return enabled providers","tags":["Market","Market Integration"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Market \\\n  get_providers_list\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Market/get_providers_list"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Market_get_providers_list.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Market_get_providers_list.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Market/,\n    q/get_providers_list/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Market_get_providers_list.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Market_get_providers_list.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Market',\n    'get_providers_list'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 56"}},"/Market/get_ssl_certificate_if_available":{"get":{"description":"This function retrieves SSL certificates when they are available from the cPanel Market provider.","operationId":"get_ssl_certificate_if_available","parameters":[{"description":"The cPanel Market provider's name.","in":"query","name":"provider","required":true,"schema":{"example":"cPStore","type":"string"}},{"description":"The order item for which to poll.","in":"query","name":"order_item_id","required":true,"schema":{"example":"8675309","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_ssl_certificate_if_available","type":"string"},"module":{"description":"The name of the module called.","example":"Market","type":"string"},"result":{"properties":{"data":{"properties":{"certificate_pem":{"description":"The certificate's text.\n* `null` - The certificate is not available.\n* A certificate file in [Base64 PEM](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) format.","example":"-----BEGIN CERTIFICATE----- MIIDcTCCAlmgAwIBAgIFAU+BNVgwDQYJKoZIhvcNAQEFBQAwUTESMBAGA1UEAwwJ c2lza28udGxkMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGY1BhbmVsMQswCQYDVQQI DAJUWDEQMA4GA1UEBwwHSG91c3RvbjAeFw0xNDEwMDYyMjI2MTlaFw0xNTEwMDYy MjI2MTlaMFExEjAQBgNVBAMMCXNpc2tvLnRsZDELMAkGA1UEBhMCVVMxDzANBgNV BAoMBmNQYW5lbDELMAkGA1UECAwCVFgxEDAOBgNVBAcMB0hvdXN0b24wggEiMA0G CSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9zx6zGiHdmWA0dKtoXmJiWXpZ9E3P Xx3YHsjFEWW7e5pH0vZ+jVMzDmm5nsJ7RXrAkZO1IvpIpVLvoQfiJOWVvkD+o9fW voK1tWJS72FSgPju+58mA2ieBuc87A790Pzuv1P3NR3zFLAjUR99zkHR1fpri/da M3PBWO8ET48FWkyU1kOeZaUlF67/+wrEiNgg+t1qhKOCAB61PdNVkLaSGHimksuC +Czk8Kq9nuS0E0TCnDtjjEyJ455FUcaCfczlTb8xkB/F9ORe74yTzD+vlk0tFMG6 PLj/ajIwWqwO0qmQ8wX3NRxkWgGz5kVO1wrVJarKQ5EYQ3/mgvit0v6dAgMBAAGj UDBOMB0GA1UdDgQWBBRw+wKBo34+bgexjAa3EMDsgSCd7zAfBgNVHSMEGDAWgBRw +wKBo34+bgexjAa3EMDsgSCd7zAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUA A4IBAQCHRXIs53opzKM2rM8Qe8lcw524WK6hqy2EWrZHp78N7rU7/6DQ/I3hv3Wh cDDIO04I2/Xhe88MLBaLoM367Ya+vy7CaLr14aLi/SfQszMA0ALBvMao+Fis0iVw FYq/NLgSXw+fgnpFskt8v8iQZ+4Kaal8U8e9sVgu8m0RgO7rzym1eRiIKpsKd1rh /SD7LbSN7M7TRL3QqF7ltw9sQhAAsQcRaBBF21pdWrqhiGZ+Eioo3hhgwNavH2ag qz78ddHwrFpHFwrEeUk1OfpPb76MYIce7xIy/4oQNdg6fOq4l/FrajBv+WkzDVPa Km6r7YmwfLN/YMZBHXSR58oOGP9W -----END CERTIFICATE-----","format":"base64 certificate","nullable":true,"type":"string"},"encrypted_action_urls":{"description":"An object that contains encrypted URLs a user must click to complete their SSL certificate order.\n\n**Note:**\n\nThis return may also contain additional key values. For more information, read [Sectigo's documentation](https://sectigo.com/uploads/files/CollectSSL-v1.17.pdf).","properties":{"evClickThroughStatus":{"description":"A URL the user must click to electronically sign an agreement for their Extended Validation (EV) certificate.\n* An encrypted URL.\n* `null` - No action required.","example":"mgs8RgnN0rkRmJz0SAMvjLokoPoXm5LdzEkmKA7IsGmzvU5XTrFInOegFBbWFycToS7FPOevzkH9\\nZp0+QG1xcC/0bWKB1cNeTiYB3Fmv0HGu2ZsA+AYgIhSsZikyD9M6YbHk1IZA3GLNPl8DxX5zG9LQ\\nHiv7Ll2QMJcPmMaJ3xktTY9NuiaPiPmYBljEE094LeqabP3w/kRALDnhR4FcwjsTn7iDJKoxtKju\\nP/DbgV32vhESwWoaKrIYPkSJ/Dav0a/LQqLqD3Jg27WgrW+GaZSbHlHr09UQW/2CIiIK7jbUoLG3\\nANL0fKevyjxrBjCfXQq0umXcZIJPWo4gfukfkQ==\\n","nullable":true,"type":"string"},"ovCallbackStatus":{"description":"URL the user must click to verify their identity by phone to complete their Organization Validation (OV) certificate order.\n* An encrypted URL.\n* `null` - No action required.","example":"mgs8RgnN0rkRmJz0SAMvjLokoPoXm5LdzEkmKA7IsGmzvU5XTrFInOegFBbWFycToS7FPOevzkH9\\nZp0+QG1xcC/0bWKB1cNeTiYB3Fmv0HGu2ZsA+AYgIhSsZikyD9M6YbHk1IZA3GLNPl8DxX5zG9LQ\\nHiv7Ll2QMJcPmMaJ3xktTY9NuiaPiPmYBljEE094LeqabP3w/kRALDnhR4FcwjsTn7iDJKoxtKju\\nP/DbgV32vhESwWoaKrIYPkSJ/Dav0a/LQqLqD3Jg27WgrW+GaZSbHlHr09UQW/2CIiIK7jbUoLG3\\nANL0fKevyjxrBjCfXQq0umXcZIJPWo4gfukfkQ==\\n","nullable":true,"type":"string"}},"type":"object"},"status_code":{"description":"The status code of the certificate.","example":"RequiresApproval","type":"string"},"status_message":{"description":"An error message from the certificate provider. For example, why a certificate authority rejected an SSL certificate.\n\n**Note:**\n\nIf no error message exists, this will return an empty string.","example":"PRE-SIGN FAILED: CAA: Processing error","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings\ndescribe non-critical failures or other problematic conditions\nnoted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return provider's available SSL certificates","tags":["Market","SSL Certificates"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Market \\\n  get_ssl_certificate_if_available \\\n  provider='cPStore' \\\n  order_item_id='8675309'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Market/get_ssl_certificate_if_available?provider=cPStore&order_item_id=8675309"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Market_get_ssl_certificate_if_available.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Market_get_ssl_certificate_if_available.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Market/,\n    q/get_ssl_certificate_if_available/,\n    {\n        'provider' => 'cPStore',\n        'order_item_id' => '8675309',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Market_get_ssl_certificate_if_available.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Market_get_ssl_certificate_if_available.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Market',\n    'get_ssl_certificate_if_available',\n    array (\n        'provider' => 'cPStore',\n        'order_item_id' => '8675309',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 56"}},"/Market/get_provider_specific_dcv_constraints":{"get":{"description":"This function returns the provider's filename requirements for Domain Control Validation (DCV) checks.","operationId":"Market-get_provider_specific_dcv_constraints","parameters":[{"description":"The cPanel Market provider's name.","in":"query","name":"provider","required":true,"schema":{"example":"cPStore","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_provider_specific_dcv_constraints","type":"string"},"module":{"description":"The name of the module called.","example":"Market","type":"string"},"result":{"properties":{"data":{"properties":{"dcv_file_allowed_characters":{"description":"An array that lists the characters which the provider allows in the DCV check file's filename.","items":{"example":[0,1,2,3,4,5,6,7,8,9,"A","B","C","D","E","F"],"type":"array"},"type":"array"},"dcv_file_extension":{"description":"The DCV check file extension that the provider requires.","example":"txt","type":"string"},"dcv_file_random_character_count":{"description":"The number of characters that the provider allows in the DCV check file's filename.","example":32,"minimum":1,"type":"integer"},"dcv_file_relative_path":{"description":"The path to the DCV check file, relative to the domain's document root directory.","example":".well-known/pki-validation","format":"path","type":"string"},"dcv_max_redirects":{"description":"The maximum number of HTTP redirects the provider allows.","example":0,"minimum":0,"type":"integer"},"dcv_user_agent_string":{"description":"The user agent string that the system will use for the imitated local DCV check.","example":"COMODO DCV","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return provider's DCV filename requirements","tags":["Market","SSL Certificates"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Market \\\n  get_provider_specific_dcv_constraints \\\n  provider='cPStore'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Market/get_provider_specific_dcv_constraints?provider=cPStore"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Market_get_provider_specific_dcv_constraints.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Market_get_provider_specific_dcv_constraints.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Market/,\n    q/get_provider_specific_dcv_constraints/,\n    {\n        'provider' => 'cPStore',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Market_get_provider_specific_dcv_constraints.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Market_get_provider_specific_dcv_constraints.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Market',\n    'get_provider_specific_dcv_constraints',\n    array (\n        'provider' => 'cPStore',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 62"}},"/Market/request_ssl_certificates":{"get":{"description":"This function submits a request for a certificate order to the cPanel Market provider.","operationId":"request_ssl_certificates","parameters":[{"description":"The access token for the session to the cPanel Market provider.","in":"query","name":"access_token","required":true,"schema":{"example":"725431a1-d5bc-11e5-a28b-8b0e09a93f05","type":"string"}},{"content":{"application/json":{"schema":{"example":{"price":6,"product_id":"143","subject_names":[{"dNSName":"example.com"},{"dNSName":"example.org"}],"validity_period":["1, \"year\""],"vhost_names":["example.com"]},"properties":{"price":{"description":"The certificate's price.","format":"currency","type":"number"},"product_id":{"description":"The product's ID.","type":"string"},"subject_names":{"anyOf":[{"description":"HTTP-based DCV only.","items":{"type":"string"},"type":"array"},{"description":"DNS-based DCV or HTTP-based DCV.","items":{"type":"object"},"type":"array"}],"description":"An array of strings or array of objects containing the certificate's subject names:\n\n**For HTTP-based DCV only:**\n\nUse an array of strings that contains `dNSName` and the domain.\n\nFor example:\n\n`[[\"dNSName\",\"example.com\"],[\"dNSName\",\"example.org\"]]`\n\n**DNS-based DCV or HTTP-based DCV:**\n\nUse an array of objects that consits of:\n\n* `type:dNSName`\n* `name` — The domain name.\n* `dcv_method` — Either the `dns` or `http` value for for DNS-based or HTTP-based Domain Control Validation (DCV).\n\nFor example:\n\n`[{type:“dNSName”,name:“text.example.com”,dcv_method:“dns”},{type:“dNSName”,name:“text.example.com”,dcv_method:“http”}]`\n\n**Note:**\n\n* Custom provider modules that include DNS-based DCV requests **must** use the array of\nobjects format, **not** the array of strings format.\n* This function does **not** automatically include the corresponding `www.` subdomain for each domain\nthat you declare in this parameter.\n* If you wish to order the `www.` subdomain for a domain, you **must** explicitly declare it in an additional\narray or object within the `subject_names` parameter."},"validity_period":{"description":"The period of time the certificate will remain valid.\nThis array consists of a number value and string that represents a unit of time (for example, `year`).","items":{"type":"string"},"type":"array"},"vhost_names":{"description":"A comma-separated list of web virtual hosts (vhosts) for which the system will install the certificate.\n\n**Note:**\n\nAn asterisk (`*`) chraracter represents every vhost with which the certificate is compatible.","items":{"type":"string"},"type":"array"}},"required":["product_id","price","subject_names","validity_period"]}}},"description":"A JSON-encoded string that contains the details of the certificate.\n\n**Note:**\n\nTo request multiple certificates, duplicate or increment the parameter name.\nFor example, to request three certificates, use the `certificate` parameter multiple times or use the `certificate-1`,\n`certificate-2`, and `certificate-3` parameters.","in":"query","name":"certificate","required":true},{"description":"The cPanel Market provider's name.","in":"query","name":"provider","required":true,"schema":{"example":"cPStore","type":"string"}},{"description":"The URL to send the browser after the user checks out.\n\n**Note:**\n\nThis URL does **not** contain a query string.","in":"query","name":"url_after_checkout","required":false,"schema":{"example":"http://checkout.example.com","format":"url","type":"string"}},{"content":{"application/json":{"schema":{"example":{"countryName":"US","duns_number":"12-345-6789","localityName":"City Name","organizationName":"Company, Inc.","organizationalUnitName":"Team Company,","postalCode":55555,"rep_email_address":"username@example.com","rep_forename":"First Name","rep_surname":"Last Name","rep_telephone":"123-456-7891","stateOrProvinceName":"ST","streetAddress":"555 Street Name"},"type":"object"}}},"description":"An object containing the required information for an EV or OV certificate. This information depends on the provider of the certificate.\n\n**Note:**\n\nThe function returns this object for OV or EV certificate requests.","in":"query","name":"identity_verification","required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"request_ssl_certificates","type":"string"},"module":{"description":"The name of the module called.","example":"Market","type":"string"},"result":{"properties":{"data":{"properties":{"certificates":{"description":"Information about each certificate in the order.","properties":{"key_id":{"description":"The private key's ID.","example":"ac90f_639fd_6c236062f0d7a4579a30e01612c4cee0","type":"string"},"order_item_id":{"description":"The ID of the ordered item.","example":12345,"minimum":1,"type":"integer"}},"type":"object"},"checkout_url":{"description":"The URL that the cPanel Market provider uses to process payment.","example":"http://store.example.com/showmethemoney.cgi","format":"url","type":"string"},"order_id":{"description":"The order ID that the cPanel Market provider assigned.","example":123456,"minimum":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings\ndescribe non-critical failures or other problematic conditions\nnoted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Request SSL certificate order","tags":["Market","SSL Certificates"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output-jsonpretty --user=username Market request_ssl_certificates access_token='725431a1-d5bc-11e5-a28b-8b0e09a93f05' certificate='{\"price\":\"6\",\"product_id\":\"143\",\"subject_names\":[{\"dNSName\":\"example.com\"},{\"dNSName\":\"example.org\"}],\"validity_period\":[\"1, \\\"year\\\"\"],\"vhost_names\":[\"example.com\"]}' provider='cPStore'"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Market/request_ssl_certificates?access_token=725431a1-d5bc-11e5-a28b-8b0e09a93f05&certificate=%7b%22price%22%3a%226%22%2c%22product_id%22%3a%22143%22%2c%22subject_names%22%3a%5b%7b%22dNSName%22%3a%22example.com%22%7d%2c%7b%22dNSName%22%3a%22example.org%22%7d%5d%2c%22validity_period%22%3a%5b%221%2c%20%5c%22year%5c%22%22%5d%2c%22vhost_names%22%3a%5b%22example.com%22%5d%7d&provider=cPStore"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Market_request_ssl_certificates.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Market_request_ssl_certificates.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Market/,\n    q/request_ssl_certificates/,\n    {\n        'access_token' => '725431a1-d5bc-11e5-a28b-8b0e09a93f05',\n        'certificate' => '{\"price\":\"6\",\"product_id\":\"143\",\"subject_names\":[{\"dNSName\":\"example.com\"},{\"dNSName\":\"example.org\"}],\"validity_period\":[\"1, \\\"year\\\"\"],\"vhost_names\":[\"example.com\"]}',\n        'provider' => 'cPStore',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Market_request_ssl_certificates.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Market_request_ssl_certificates.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Market',\n    'request_ssl_certificates',\n    array (\n        'access_token' => '725431a1-d5bc-11e5-a28b-8b0e09a93f05',\n        'certificate' => '{\"price\":\"6\",\"product_id\":\"143\",\"subject_names\":[{\"dNSName\":\"example.com\"},{\"dNSName\":\"example.org\"}],\"validity_period\":[\"1, \\\"year\\\"\"],\"vhost_names\":[\"example.com\"]}',\n        'provider' => 'cPStore',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 56"}},"/Market/set_status_of_pending_queue_items":{"get":{"description":"This function sets the status of an item or items in the cPanel Market pending queue.","operationId":"set_status_of_pending_queue_items","parameters":[{"description":"The cPanel Market provider's name.","in":"query","name":"provider","required":true,"schema":{"example":"cPStore","type":"string"}},{"description":"The ID of the ordered item.\n\n**Note:**\n\nTo set the status for multiple items, duplicate or increment the parameter name. For example, to change the status for three certificates, use the `order_item_id` parameter multiple times or use the `order_item_id-1`, `order_item_id-2`, and `order_item_id-3` parameters.","examples":{"multiple":{"summary":"Multiple IDs.","value":"order_item_id-1=12345&order_item_id-2=12346&order_item_id-3=12347"},"multiple-alternative":{"summary":"Multiple IDs alternative.","value":"order_item_id=12345&order_item_id=12346&order_item_id=12347"},"single":{"summary":"A single ID.","value":"12345"}},"in":"query","name":"order_item_id","required":true,"schema":{"type":"string"}},{"description":"The new status of the item in the cPanel Market pending queue.\n\n* `confirmed` — The system confirmed payment for the item with the provider.","in":"query","name":"status","required":true,"schema":{"enum":["confirmed"],"example":"confirmed","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"failure":{"summary":"The function failed.","value":{"apiversion":3,"func":"set_status_of_pending_queue_items","module":"Market","result":{"data":{"error_type":"EntryDoesNotExist","order_item_ids":[8675309]},"errors":["The order item ID “8675309” does not match any entries in the pending queue."],"messages":null,"metadata":{},"status":0,"warnings":null}}},"success":{"summary":"The function succeeded.","value":{"apiversion":3,"func":"set_status_of_pending_queue_items","module":"Market","result":{"data":null,"errors":null,"messages":null,"metadata":{},"status":1,"warnings":null}}}},"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_status_of_pending_queue_items","type":"string"},"module":{"description":"The name of the module called.","example":"Market","type":"string"},"result":{"properties":{"data":{"description":"The function only returns these values if the user or users do **not** have the `order_item_id` item in the cPanel Market pending queue.","nullable":true,"properties":{"error_type":{"description":"The type of error that the function encountered.\n\n* `EntryDoesNotExist` — The returned `order_item_ids` do not exist in the cPanel Market pending queue for the user.","enum":["EntryDoesNotExist"],"example":"EntryDoesNotExist","type":"string"},"order_item_ids":{"description":"An array that lists order item IDs which do not exist in the cPanel Market pending queue for the user.","items":{"example":8675309,"minimum":0,"type":"integer"},"type":"array"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update status of items in pending queue","tags":["Market","Market Integration"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Market \\\n  set_status_of_pending_queue_items \\\n  provider='cPStore' \\\n  order_item_id='12345' \\\n  status='confirmed'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Market/set_status_of_pending_queue_items?provider=cPStore&order_item_id=12345&status=confirmed"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Market_set_status_of_pending_queue_items.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Market_set_status_of_pending_queue_items.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Market/,\n    q/set_status_of_pending_queue_items/,\n    {\n        'provider' => 'cPStore',\n        'order_item_id' => '12345',\n        'status' => 'confirmed',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Market_set_status_of_pending_queue_items.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Market_set_status_of_pending_queue_items.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Market',\n    'set_status_of_pending_queue_items',\n    array (\n        'provider' => 'cPStore',\n        'order_item_id' => '12345',\n        'status' => 'confirmed',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 56"}},"/Market/set_url_after_checkout":{"get":{"description":"This function updates the URL to which a provider sends a user after they check out.","operationId":"set_url_after_checkout","parameters":[{"description":"The cPanel Market provider's name.","in":"query","name":"provider","required":true,"schema":{"example":"cPStore","type":"string"}},{"description":"The access token for the session to the cPanel Market provider.","in":"query","name":"access_token","required":true,"schema":{"example":"725431a1-d5bc-11e5-a28b-8b0e09a93f05","type":"string"}},{"description":"The order ID that the cPanel Market provider assigned.","in":"query","name":"order_id","required":true,"schema":{"example":123456,"type":"integer"}},{"description":"The URL to send the browser after the user checks out.","in":"query","name":"url_after_checkout","required":true,"schema":{"example":"http://checkout.example.com","format":"url","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_url_after_checkout","type":"string"},"module":{"description":"The name of the module called.","example":"Market","type":"string"},"result":{"properties":{"data":{"properties":{"error_type":{"description":"Any errors that the function encounters.","example":"This is an error.","nullable":true,"type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update URL after checkout","tags":["Market","Market Integration"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Market \\\n  set_url_after_checkout \\\n  provider='cPStore' \\\n  access_token='725431a1-d5bc-11e5-a28b-8b0e09a93f05' \\\n  order_id='123456' \\\n  url_after_checkout='http://checkout.example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Market/set_url_after_checkout?provider=cPStore&access_token=725431a1-d5bc-11e5-a28b-8b0e09a93f05&order_id=123456&url_after_checkout=http%3a%2f%2fcheckout.example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Market_set_url_after_checkout.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Market_set_url_after_checkout.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Market/,\n    q/set_url_after_checkout/,\n    {\n        'provider' => 'cPStore',\n        'access_token' => '725431a1-d5bc-11e5-a28b-8b0e09a93f05',\n        'order_id' => '123456',\n        'url_after_checkout' => 'http://checkout.example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Market_set_url_after_checkout.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Market_set_url_after_checkout.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Market',\n    'set_url_after_checkout',\n    array (\n        'provider' => 'cPStore',\n        'access_token' => '725431a1-d5bc-11e5-a28b-8b0e09a93f05',\n        'order_id' => '123456',\n        'url_after_checkout' => 'http://checkout.example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 56"}},"/Market/validate_login_token":{"get":{"description":"This function validates a login token to a cPanel Market provider and returns an access token.","operationId":"validate_login_token","parameters":[{"description":"The name of the cPanel Market provider.","in":"query","name":"provider","required":true,"schema":{"example":"cPStore","type":"string"}},{"description":"The login token for the cPanel Market provider.","in":"query","name":"login_token","required":true,"schema":{"example":"8675309","type":"string"}},{"description":"The `url_after_login` value that you sent to UAPI's `Market::get_login_url` function.","in":"query","name":"url_after_login","required":true,"schema":{"example":"http://hostname.example.com/redirectionlocation.cgi?state","format":"url","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"validate_login_token","type":"string"},"module":{"description":"The name of the module called.","example":"Market","type":"string"},"result":{"properties":{"data":{"properties":{"access_token":{"description":"The access token that returns from the code parameter after you log in.","example":"8675309","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` Success.\n* `0` Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Validate login token","tags":["Market","Market Integration"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Market \\\n  validate_login_token \\\n  provider='cPStore' \\\n  login_token='8675309' \\\n  url_after_login='http://hostname.example.com/redirectionlocation.cgi?state'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Market/validate_login_token?provider=cPStore&login_token=8675309&url_after_login=http%3a%2f%2fhostname.example.com%2fredirectionlocation.cgi%3fstate"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Market_validate_login_token.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Market_validate_login_token.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Market/,\n    q/validate_login_token/,\n    {\n        'provider' => 'cPStore',\n        'login_token' => '8675309',\n        'url_after_login' => 'http://hostname.example.com/redirectionlocation.cgi?state',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Market_validate_login_token.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Market_validate_login_token.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Market',\n    'validate_login_token',\n    array (\n        'provider' => 'cPStore',\n        'login_token' => '8675309',\n        'url_after_login' => 'http://hostname.example.com/redirectionlocation.cgi?state',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 56"}},"/Market/process_ssl_pending_queue":{"get":{"description":"This function manually processes the cPanel Market's SSL certificate request pending queue.","operationId":"process_ssl_pending_queue","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"process_ssl_pending_queue","type":"string"},"module":{"description":"The name of the module called.","example":"Market","type":"string"},"result":{"properties":{"data":{"description":"Information about each certificate request in the pending queue.","items":{"properties":{"certificate_pem":{"description":"The text of the certificate, if available.\n* `null` - The certificate is not available.","example":"null","format":"base64 certificate","nullable":true,"type":"string"},"created_time":{"description":"When the system placed the order.","example":1460136406,"format":"unix_timestamp","type":"integer"},"csr":{"description":"The Certificate Signing Request's (CSR's) text.","example":"-----BEGIN CERTIFICATE REQUEST-----\\nMIICqjCCAZICAQAwHDEaMBgGA1UEAxMRY3BhbmVsc3NsdGVzdC5vcmcwggEiMA0G\\nCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCqu4KLPxCgAENTJFjcUyc4v5KaF8Lu\\n2OldjIT/vB58IRCIUxdDSD29v/qHFVBaUFEtr+Ssey0strMcc6JYSl8Vdwfe2qwv\\npB6+Ufg+hlN4lAgojxgwz7iZlPnGuRVfNTvNMmljVRzGDc4SSzskpDxZhk+aaMgP\\nSkMLFg6f6pFZ+44alridlSG5gxD34xWAtt8Qy2v+6Q4XVuMNCd9KlyAoCV9Q+wH1\\nq49yoRdwvcY6G6mqlFWtHsToz4tdYk/Nt7odZnyKcjHWGWnlRzO2FGbbBxVKF8s6\\ns3DL5OwPRfQQD18V7eL7NmcFo45zmdndBOevrLuwXJ1yWITM2bmYgF1nAgMBAAGg\\nSTBHBgkqhkiG9w0BCQ4xOjA4MDYGA1UdEQEB/wQsMCqCEWNwYW5lbHNzbHRlc3Qu\\nb3JnghV3d3cuY3BhbmVsc3NsdGVzdC5vcmcwDQYJKoZIhvcNAQELBQADggEBAFAJ\\nSqTvd3d8PN26UiT4uX0WjofaX8u1/11hU5Saekai0Dxl/ijq2R7TpebXe9r0t6Cr\\ns7NXKszVoKzQHV4nSFbfb3ZxEsnVDXbPUv3D+oLfGpMASLG+P2yOjmDhzZBNJgo4\\nQu6nf6ggJxJ0PRM81xL234FAKqsOvvTwTLXtYVrwbUCzfB+yKJXvfeGETR/3HGxR\\nqoJ97Zmjsbw78fETEsZ6rsBHDPuxtxum73BC7qoLjCl4psPznHshXvWTeV9fyR3c\\nqpdpLvwBxhI8ZOWoNGgJlUpY9jUFgqG+YI/Mkmzmxk9QC9edIHSScTXxroYkmwMC\\nginnKRLDafSp+7FyIzs=\\n-----END CERTIFICATE REQUEST-----","format":"base64 certificate","type":"string"},"deleted":{"description":"Whether the system has deleted the item from the pending queue.\n* `0` - Deleted.\n* `1` - **Not** deleted.","enum":[0,1],"example":0,"type":"integer"},"domains":{"description":"A list of domains that the certificate request covers.","items":{"example":"example.com","format":"domain","type":"string"},"type":"array"},"expired":{"description":"Whether the system has deleted the item from the pending queue.\n* `1` - Deleted.\n* `0` - **Not** deleted.","enum":[0,1],"example":0,"type":"integer"},"first_poll_time":{"description":"The first time that the system polled the provider for the certificate.","example":1458061262,"format":"unix_timestamp","type":"integer"},"installed":{"description":"Whether the system installed the certificate.\n* `1` - Installed.\n* `0` - **Not** installed.","enum":[0,1],"example":0,"type":"integer"},"last_poll_time":{"description":"The last time that the system polled the provider for the certificate.","example":1458061299,"format":"unix_timestamp","type":"integer"},"last_status_code":{"description":"The last status code of the order.\n* `CertificateNotFound` - The system cannot locate the specified certificate.\n* `RequiresApproval` - The specified certificate requires approval.\n* `OrderCanceled` - The system canceled the order of the specified certificate.\n* `OrderItemCanceled` - The system canceled the order item of the specified certificate.","enum":["CertificateNotFound","RequiresApproval","OrderCanceled","OrderItemCanceled"],"example":"CertificateNotFound","type":"string"},"last_status_message":{"description":"An error message from the certificate provider.\nFor example, why a certificate authority rejected an SSL certificate.\n\n**Note:**\n\nIf no error message exists, this will return an empty string.","example":"PRE-SIGN FAILED: CAA: Processing error","type":"string"},"order_id":{"description":"A unique identifier for the order.","example":"19461","type":"string"},"order_item_id":{"description":"A unique identifier of each item in the order.","example":"f9d7","type":"string"},"product_id":{"description":"An identifier for a given product.","example":"fg2","type":"string"},"provider":{"description":"The cPanel Market provider's name.","example":"cPStore","type":"string"},"status":{"description":"The status of the order.\n* `confirmed` - Payment confirmed.\n* `unconfirmed` - Payment **not** confirmed.","enum":["confirmed","unconfirmed"],"example":"confirmed","type":"string"},"vhost_names":{"description":"A list of virtual host names.","items":{"example":"example.com","format":"domain","type":"string"},"type":"array"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings\ndescribe non-critical failures or other problematic conditions\nnoted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Start processing pending queue's SSL certificates","tags":["Market","SSL Certificates"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Market \\\n  process_ssl_pending_queue\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Market/process_ssl_pending_queue"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Market_process_ssl_pending_queue.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Market_process_ssl_pending_queue.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Market/,\n    q/process_ssl_pending_queue/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Market_process_ssl_pending_queue.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Market_process_ssl_pending_queue.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Market',\n    'process_ssl_pending_queue'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 56"}},"/Mime/add_handler":{"get":{"description":"This function creates an Apache MIME type handler for a file extension.\n\n**Important:**\n\nWhen you disable the [Web Server](https://go.cpanel.net/serverroles) role, the system **disables** this function.","operationId":"add_handler","parameters":[{"description":"The file extension.","in":"query","name":"extension","required":true,"schema":{"example":".foo","type":"string"}},{"description":"The Apache MIME handler.","in":"query","name":"handler","required":true,"schema":{"example":"txt-foo","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"add_handler","type":"string"},"module":{"description":"The name of the module called.","example":"Mime","type":"string"},"result":{"properties":{"data":{"enum":[null],"example":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add web server MIME type handler","tags":["Mime","Handler Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mime \\\n  add_handler \\\n  extension='.foo' \\\n  handler='txt-foo'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mime/add_handler?extension=.foo&handler=txt-foo"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mime_add_handler.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mime_add_handler.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mime/,\n    q/add_handler/,\n    {\n        'extension' => '.foo',\n        'handler' => 'txt-foo',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mime_add_handler.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mime_add_handler.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mime',\n    'add_handler',\n    array (\n        'extension' => '.foo',\n        'handler' => 'txt-foo',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Mime/add_redirect":{"get":{"description":"This function adds a redirect to a domain.\n\n**Important:**\n\n  When you disable the [*Web Server* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"add_redirect","parameters":[{"description":"The domain from which to redirect.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"A specific page from which to redirect.","in":"query","name":"src","required":false,"schema":{"default":"/","example":"/specific-page","format":"url-path","type":"string"}},{"description":"The URL to which to redirect.","in":"query","name":"redirect","required":true,"schema":{"example":"http://example.com/","format":"url","type":"string"}},{"description":"Whether the redirect is temporary.\n * `permanent`\n * `temp`","in":"query","name":"type","required":false,"schema":{"default":"permanent","enum":["permanent","temp"],"example":"permanent","type":"string"}},{"description":"Whether to redirect all files within a directory to the same\nfilename within the destination directory.\n* `1` - Redirect all files within the directory.\n* `0` - Do **not** redirect all files within the directory.","in":"query","name":"redirect_wildcard","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to redirect domains with or without `www`.\n* `2` - Redirect with `www`.\n* `1` - Redirect without `www`.\n* `0` - Redirect with **and** without `www`.","in":"query","name":"redirect_www","required":false,"schema":{"default":0,"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"add_redirect","type":"string"},"module":{"description":"The name of the module called.","example":"Mime","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":["Htaccess Installed"],"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add redirect to domain","tags":["Mime","Domain Redirection"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mime \\\n  add_redirect \\\n  domain='example.com' \\\n  redirect='http://example.com/'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mime/add_redirect?domain=example.com&redirect=http%3a%2f%2fexample.com%2f"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mime_add_redirect.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mime_add_redirect.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mime/,\n    q/add_redirect/,\n    {\n        'domain' => 'example.com',\n        'redirect' => 'http://example.com/',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mime_add_redirect.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mime_add_redirect.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mime',\n    'add_redirect',\n    array (\n        'domain' => 'example.com',\n        'redirect' => 'http://example.com/',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Mime/delete_handler":{"get":{"description":"This function deletes an Apache MIME type handler.\n\n**Important:**\n\n  When you disable the [WebServer role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"delete_handler","parameters":[{"description":"The file extension.","in":"query","name":"extension","required":true,"schema":{"example":".foo","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"delete_handler","type":"string"},"module":{"description":"The name of the module called.","example":"Mime","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed: Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove web server MIME type handler","tags":["Mime","Handler Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mime \\\n  delete_handler \\\n  extension='.foo'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mime/delete_handler?extension=.foo"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mime_delete_handler.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mime_delete_handler.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mime/,\n    q/delete_handler/,\n    {\n        'extension' => '.foo',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mime_delete_handler.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mime_delete_handler.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mime',\n    'delete_handler',\n    array (\n        'extension' => '.foo',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Mime/add_mime":{"get":{"description":"This function adds a MIME type to Apache.\n\n**Important:**\n\nWhen you disable the [Web Server](https://go.cpanel.net/serverroles) role, the system **disables** this function.","operationId":"add_mime","parameters":[{"description":"The MIME type.","in":"query","name":"type","required":true,"schema":{"example":"text/foo","format":"MIME","type":"string"}},{"description":"The file extension.","in":"query","name":"extension","required":true,"schema":{"example":".foo","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"add_mime","type":"string"},"module":{"description":"The name of the module called.","example":"Mime","type":"string"},"result":{"properties":{"data":{"enum":[null],"example":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add MIME type to web server","tags":["Mime","Mime Type Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mime \\\n  add_mime \\\n  type='text/foo' \\\n  extension='.foo'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mime/add_mime?type=text%2ffoo&extension=.foo"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mime_add_mime.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mime_add_mime.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mime/,\n    q/add_mime/,\n    {\n        'type' => 'text/foo',\n        'extension' => '.foo',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mime_add_mime.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mime_add_mime.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mime',\n    'add_mime',\n    array (\n        'type' => 'text/foo',\n        'extension' => '.foo',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Mime/delete_mime":{"get":{"description":"This function removes a MIME type from Apache.\n\n**Important:**\n\n  When you disable the [WebServer role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"delete_mime","parameters":[{"description":"The MIME type.","in":"query","name":"type","required":true,"schema":{"example":"text/foo","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"delete_mime","type":"string"},"module":{"description":"The name of the module called.","example":"Mime","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove MIME type from web server","tags":["Mime","Mime Type Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mime \\\n  delete_mime \\\n  type='text/foo'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mime/delete_mime?type=text%2ffoo"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mime_delete_mime.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mime_delete_mime.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mime/,\n    q/delete_mime/,\n    {\n        'type' => 'text/foo',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mime_delete_mime.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mime_delete_mime.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mime',\n    'delete_mime',\n    array (\n        'type' => 'text/foo',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Mime/delete_hotlink":{"get":{"description":"This function removes hotlink protection.\n\n**Important:**\n\n  When you disable the [Web Server](https://go.cpanel.net/serverroles) role, the system **disables** this function.","operationId":"delete_hotlink","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"delete_hotlink","type":"string"},"module":{"description":"The name of the module called.","example":"Mime","type":"string"},"result":{"properties":{"data":{},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Disable hotlink protection","tags":["Mime","Direct Link Protection (Hotlink)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mime \\\n  delete_hotlink\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mime/delete_hotlink"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mime_delete_hotlink.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mime_delete_hotlink.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mime/,\n    q/delete_hotlink/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mime_delete_hotlink.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mime_delete_hotlink.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mime',\n    'delete_hotlink'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Mime/delete_redirect":{"get":{"description":"This function removes a redirect from a domain.\n\n**Important:**\n\nWhen you disable the [Web Server role](https://go.cpanel.net/serverroles#roles), the system **disables** this function.","operationId":"delete_redirect","parameters":[{"description":"The domain name.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"The absolute file path to the document root containing the `.htaccess` file to change.\n\nIf you don't pass this parameter, the system looks up the document root from the `domain` parameter's value.","in":"query","name":"docroot","required":false,"schema":{"example":"/home/example/public_html/","format":"path","type":"string"}},{"description":"The specific page that redirects visitors.","in":"query","name":"src","required":false,"schema":{"default":"","example":"redirectpage.html","type":"string"}},{"description":"An argument string that contains the arguments of a `Redirect` or `RedirectMatch` directives.","in":"query","name":"args","required":false,"schema":{"default":"","example":"redirectme http://redirectme.com/","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"delete_redirect","type":"string"},"module":{"description":"The name of the module called.","example":"Mime","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove redirect from domain","tags":["Mime","Domain Redirection"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mime \\\n  delete_redirect \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mime/delete_redirect?domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mime_delete_redirect.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mime_delete_redirect.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mime/,\n    q/delete_redirect/,\n    {\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mime_delete_redirect.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mime_delete_redirect.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mime',\n    'delete_redirect',\n    array (\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Mime/add_hotlink":{"get":{"description":"This function adds hotlink protection for a site. Hotlink protection will redirect users to another URL if they navigate to a file with a specified extension, but an allowed URL did not refer them.\n\n**Important:**\n\n  When you disable the [WebServer role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"add_hotlink","parameters":[{"description":"The site to hotlink protect.\n\n**Note:**\n\nTo protect multiple URLs, separate each URL with a newline character.","examples":{"multiple":{"summary":"Add hotlink protection for multiple sites.","value":"http://example.com/\nhttp://foobar.com/"},"single":{"summary":"Add hotlink protection for a single site.","value":"http://example.com/"}},"in":"query","name":"urls","required":true,"schema":{"type":"string"}},{"description":"File types to hotlink protect.\n\n**Note:**\n\nTo protect multiple file types, use a comma-separated list.","examples":{"multiple":{"summary":"Add hotlink protection for multiple file extensions.","value":"foo,bar"},"single":{"summary":"Add hotlink protection for a single file extension.","value":"foo"}},"in":"query","name":"extensions","required":true,"schema":{"type":"string"}},{"description":"Whether the domain allows hotlinks.\n* `1` - Allows.\n* `0` - Does **not** allow.","in":"query","name":"allow_null","required":false,"schema":{"enum":[0,1],"example":1,"type":"integer"}},{"description":"The URL to which the system sends hotlinkers.","in":"query","name":"redirect_url","required":true,"schema":{"example":"http://redirect.example.com/","format":"url","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"add_hotlink","type":"string"},"module":{"description":"The name of the module called.","example":"Mime","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable hotlink protection","tags":["Mime","Direct Link Protection (Hotlink)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mime \\\n  add_hotlink \\\n  urls='http://example.com/' \\\n  extensions='foo' \\\n  redirect_url='http://redirect.example.com/'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mime/add_hotlink?urls=http%3a%2f%2fexample.com%2f&extensions=foo&redirect_url=http%3a%2f%2fredirect.example.com%2f"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mime_add_hotlink.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mime_add_hotlink.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mime/,\n    q/add_hotlink/,\n    {\n        'urls' => 'http://example.com/',\n        'extensions' => 'foo',\n        'redirect_url' => 'http://redirect.example.com/',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mime_add_hotlink.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mime_add_hotlink.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mime',\n    'add_hotlink',\n    array (\n        'urls' => 'http://example.com/',\n        'extensions' => 'foo',\n        'redirect_url' => 'http://redirect.example.com/',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Mime/list_handlers":{"get":{"description":"This function lists all of Apache's MIME handlers.\n\n**Important:**\n\n  When you disable the [WebServer role](https://go.cpanel.net/serverroles),\n  the system **disables** this function.","operationId":"list_handlers","parameters":[{"description":"Whether to retrieve system or user handlers.","in":"query","name":"type","required":true,"schema":{"enum":["system","user"],"example":"user","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_handlers","type":"string"},"module":{"description":"The name of the module called.","example":"Mime","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"extension":{"description":"The handler's extension. A valid file extension.","example":".foo","type":"string"},"handler":{"description":"The handler's name. A valid string.","example":"text-foo","type":"string"},"origin":{"description":"The handler's owner.\n- system\n- user","example":"user","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return web server's MIME handlers","tags":["Mime","Handler Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mime \\\n  list_handlers \\\n  type='user'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mime/list_handlers?type=user"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mime_list_handlers.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mime_list_handlers.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mime/,\n    q/list_handlers/,\n    {\n        'type' => 'user',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mime_list_handlers.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mime_list_handlers.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mime',\n    'list_handlers',\n    array (\n        'type' => 'user',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Mime/get_redirect":{"get":{"description":"This function retrieves a redirection URL for a domain.","operationId":"get_redirect","parameters":[{"description":"The domain's name.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_redirect","type":"string"},"module":{"description":"The name of the module called.","example":"Mime","type":"string"},"result":{"properties":{"data":{"properties":{"redirection_enabled":{"description":"Whether the domain redirects to another URL.\n* `1` - Redirects.\n* `0` - Doesn't redirect.","enum":[0,1],"example":1,"type":"integer"},"url":{"description":"The URL to which to the domain redirects.","example":"http://www.domain.com","format":"url","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return redirect URL for domain","tags":["Mime","Domain Redirection"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mime \\\n  get_redirect \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mime/get_redirect?domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mime_get_redirect.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mime_get_redirect.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mime/,\n    q/get_redirect/,\n    {\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mime_get_redirect.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mime_get_redirect.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mime',\n    'get_redirect',\n    array (\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 88"}},"/Mime/list_hotlinks":{"get":{"description":"This function lists domains with hotlink protection.\n\n**Important:**\n\nWhen you **disable** the [Web Server](https://go.cpanel.net/serverroles) role, the system **disables** this function.","operationId":"list_hotlinks","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_hotlinks","type":"string"},"module":{"description":"The name of the module called.","example":"Mime","type":"string"},"result":{"properties":{"data":{"properties":{"allow_null":{"description":"Whether the domain allows hotlinks from an empty or null referral URL.\n* `1` - Allows hotlinks.\n* `0` - Does not allow hotlinks.","enum":[0,1],"example":1,"type":"integer"},"extensions":{"description":"A comma-separated list of file types to hotlink protect.","example":"jpg,jpeg,gif,png,bmp","type":"string"},"redirect_url":{"description":"The URL to which to send hotlinkers.","example":"http://redirect.example.com/","format":"url","type":"string"},"state":{"description":"Whether hotlink protection is enabled.\n\n* `enabled`\n* `disabled`","enum":["enabled","disabled"],"example":"disabled","type":"string"},"urls":{"description":"An array of the domains with hotlink protection.","items":{"example":"http://example.com/","format":"url","type":"string"},"type":"array"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return domains with hotlink protection","tags":["Mime","Direct Link Protection (Hotlink)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mime \\\n  list_hotlinks\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mime/list_hotlinks"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mime_list_hotlinks.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mime_list_hotlinks.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mime/,\n    q/list_hotlinks/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mime_list_hotlinks.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mime_list_hotlinks.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mime',\n    'list_hotlinks'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Mime/redirect_info":{"get":{"description":"This function retrieves redirect information for a URL or `** All Public Domains **`.\n\n**Important:**\n\nWhen you disable the [Web Server role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"redirect_info","parameters":[{"description":"The URL for which to retrieve redirector information.","in":"query","name":"url","required":true,"schema":{"example":"http://redirect.example.com","format":"url","type":"string"}},{"description":"The domain for which to retrieve redirector information.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"redirect_info","type":"string"},"module":{"description":"The name of the module called.","example":"Mime","type":"string"},"result":{"properties":{"data":{"properties":{"domain":{"anyOf":[{"description":"The redirect's domain.","format":"domain","type":"string"},{"description":"** All Public Domains **","type":"string"}],"description":"The redirect's domain, or `** All Public Domains **`.\n\n* A valid domain.\n* `** All Public Domains **`","example":"example.com","type":"string"},"url":{"description":"The redirect's URL.","example":"http://redirect.example.com","format":"url","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return redirect information","tags":["Mime","Handler Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mime \\\n  redirect_info \\\n  url='http://redirect.example.com' \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mime/redirect_info?url=http%3a%2f%2fredirect.example.com&domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mime_redirect_info.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mime_redirect_info.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mime/,\n    q/redirect_info/,\n    {\n        'url' => 'http://redirect.example.com',\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mime_redirect_info.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mime_redirect_info.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mime',\n    'redirect_info',\n    array (\n        'url' => 'http://redirect.example.com',\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42","x-cpanel-internal-only":false}},"/DNSSEC/disable_dnssec":{"get":{"description":"This function disables DNSSEC on the domain.\n\n**Warning:**\n\n * This action is **irreversible**. If you disable DNSSEC on the domain, you will lose the associated keys. You can only retrieve the previous state with a full backup.\n * If you disable DNSSEC, you **must** remove the DNS records at the registrar.\n\n**Important:**\n\n  When you disable the [DNS role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"disable_dnssec","parameters":[{"description":"The domain on which to disable DNSSEC.\n\n**Note:**\n\n To enable DNSSEC on multiple domains, increment the parameter name. For example: `domain-0`, `domain-1`, `domain-2`.","examples":{"multiple":{"summary":"To enable DNSSEC on multiple domains.","value":"domain-0=example0.com&domain-1=example1.com&domain-2=example2.com"},"single":{"summary":"To enable DNSSEC on a single domain.","value":"example.com"}},"in":"query","name":"domain","required":true,"schema":{"format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"disable_dnssec","type":"string"},"module":{"description":"The name of the module called.","example":"DNSSEC","type":"string"},"result":{"properties":{"data":{"example":{"disabled":{"example.com":1}},"properties":{"disabled":{"description":"An array of objects that contain the domains for which the system disabled DNSSEC.","properties":{"additionalProperties":{"description":"Information about the domains for which the system\ndisabled DNSSEC.\n\n* `1` — Disabled.\n* `0` — The system failed to disable DNSSEC.\n\n**Note:**\n\nThis return's name is the `domain` parameter's value.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Disable DNSSEC","tags":["DNSSEC","DNS Security"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DNSSEC \\\n  disable_dnssec \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DNSSEC/disable_dnssec?domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DNSSEC_disable_dnssec.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DNSSEC_disable_dnssec.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DNSSEC/,\n    q/disable_dnssec/,\n    {\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DNSSEC_disable_dnssec.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DNSSEC_disable_dnssec.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DNSSEC',\n    'disable_dnssec',\n    array (\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 60"}},"/ModSecurity/disable_all_domains":{"get":{"description":"This function disables ModSecurity™ on a cPanel account's domains.\n\n**Important:**\n\nWhen you disable the [WebServer role](https://go.cpanel.net/serverroles#roles), the system **disables** this function.","operationId":"disable_all_domains","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"disable_all_domains","type":"string"},"module":{"description":"The name of the module called.","example":"ModSecurity","type":"string"},"result":{"properties":{"data":{"example":[{"dependencies":["dallas.com"],"domain":"dallas.example.com","enabled":0,"searchhint":"dallas.com","type":"sub"},{"dependencies":["arkansas.com","kansas.com","nevada.com","newmexico.com","texas.com"],"domain":"example.com","enabled":0,"searchhint":"arkansas.com,kansas.com,nevada.com,newmexico.com,texas.com","type":"main"},{"dependencies":["galveston.com"],"domain":"galveston.example.com","enabled":0,"searchhint":"galveston.com","type":"sub"},{"dependencies":["houston.com"],"domain":"houston.example.com","enabled":0,"searchhint":"houston.com","type":"sub"},{"dependencies":["neworleans.com"],"domain":"neworleans.example.com","enabled":0,"searchhint":"neworleans.com","type":"sub"},{"dependencies":["sanantonio.com"],"domain":"sanantonio.example.com","enabled":0,"searchhint":"sanantonio.com","type":"sub"}],"items":{"properties":{"dependencies":{"description":"An array of domains that your changes to a selected domain affect.","example":["arkansas.com","kansas.com","nevada.com","newmexico.com","texas.com"],"items":{"format":"domain","type":"string"},"type":"array"},"domain":{"description":"The cPanel account's domain.","example":"example.com","format":"domain","type":"string"},"enabled":{"description":"Whether ModSecurity is enabled on the account.\n* `1` - Enabled.\n* `0` - Disabled.","enum":[0,1],"example":0,"type":"integer"},"exception":{"description":"An exception error message. The function only returns this value if an error occurs.","example":"An error occurred during the userdata update for domain “example.com”.","type":"string"},"searchhint":{"description":"A comma-separated list of domain-related search terms.","example":"arkansas.com,kansas.com,nevada.com,newmexico.com,texas.com","type":"string"},"type":{"description":"The domain type.\n* `main` - A main domain.\n* `sub` - A subdomain.","enum":["main","sub"],"example":"main","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Disable ModSecurity for all domains","tags":["ModSecurity"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  ModSecurity \\\n  disable_all_domains\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/ModSecurity/disable_all_domains"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file ModSecurity_disable_all_domains.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/ModSecurity_disable_all_domains.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/ModSecurity/,\n    q/disable_all_domains/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file ModSecurity_disable_all_domains.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/ModSecurity_disable_all_domains.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'ModSecurity',\n    'disable_all_domains'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.46"}},"/ModSecurity/disable_domains":{"get":{"description":"This function disables ModSecurity™ on specified domains.\n\n**Important:**\n\nWhen you disable the [WebServer role](https://go.cpanel.net/serverroles#roles), the system **disables** this function.","operationId":"disable_domains","parameters":[{"description":"A comma-separated list of domains that the cPanel account owns.\n\n**Important:**\n\nThe authenticated cPanel account **must** own these domains.","in":"query","name":"domains","required":true,"schema":{"example":"example.com,dallas.example.com,galveston.example.com","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"disable_domains","type":"string"},"module":{"description":"The name of the module called.","example":"ModSecurity","type":"string"},"result":{"properties":{"data":{"oneOf":[{"example":[{"dependencies":["dallas.com"],"domain":"dallas.example.com","enabled":0,"searchhint":"dallas.com","type":"sub"},{"dependencies":["arkansas.com","kansas.com","nevada.com","newmexico.com","texas.com"],"domain":"example.com","enabled":0,"searchhint":"arkansas.com,kansas.com,nevada.com,newmexico.com,texas.com","type":"main"},{"dependencies":["galveston.com"],"domain":"galveston.example.com","enabled":0,"searchhint":"galveston.com","type":"sub"}],"items":{"properties":{"dependencies":{"description":"An array of domains that your changes to a selected domain affect.","example":["arkansas.com","kansas.com","nevada.com","newmexico.com","texas.com"],"items":{"format":"domain","type":"string"},"type":"array"},"domain":{"description":"The cPanel account's domain.","example":"example.com","format":"domain","type":"string"},"enabled":{"description":"Whether ModSecurity is enabled on the domain.\n* `1` - Enabled.\n* `0` - Disabled.","enum":[0,1],"example":1,"type":"integer"},"exception":{"description":"An exception error message. The function only returns this value if an error occurs.","example":"An error occurred during the userdata update for domain “example.com”.","type":"string"},"searchhint":{"description":"A comma-separated list of domain-related search terms.","example":"arkansas.com,kansas.com,nevada.com,newmexico.com,texas.com","type":"string"},"type":{"description":"The domain type.\n* `main` - A main domain.\n* `sub` - A subdomain.","enum":["main","sub"],"example":"main","type":"string"}},"type":"object"},"type":"array"},{"properties":{"no_domains_provided":{"description":"Indicates caller error on API call.","enum":[1],"example":1,"type":"integer"}},"type":"object"},{"properties":{"invalid_domains":{"description":"List of invalid domains provided by caller.","example":["example.invalid"],"items":{"type":"string"},"type":"array"},"invalid_domains_provided":{"description":"Indicates caller error on API call.","enum":[1],"example":1,"type":"integer"}},"type":"object"}]},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Disable ModSecurity for selected domains","tags":["ModSecurity"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  ModSecurity \\\n  disable_domains \\\n  domains='example.com,dallas.example.com,galveston.example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/ModSecurity/disable_domains?domains=example.com%2cdallas.example.com%2cgalveston.example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file ModSecurity_disable_domains.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/ModSecurity_disable_domains.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/ModSecurity/,\n    q/disable_domains/,\n    {\n        'domains' => 'example.com,dallas.example.com,galveston.example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file ModSecurity_disable_domains.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/ModSecurity_disable_domains.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'ModSecurity',\n    'disable_domains',\n    array (\n        'domains' => 'example.com,dallas.example.com,galveston.example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.46"}},"/Mime/list_mime":{"get":{"description":"This function lists all of Apache's MIME types.\n\n**Note:**\n\n  This function does **not** list PHP versions with MIME types when the user or domain enables PHP-FPM. The system displays **only** custom MIME types.\n\n**Important:**\n\n  When you disable the [Web Server role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"list_mime","parameters":[{"description":"The MIME types to list.\n* `system` — List the Apache system MIME types.\n* `user` — List the Apache user MIME types.","in":"query","name":"type","required":true,"schema":{"enum":["system","user"],"example":"user","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_mime","type":"string"},"module":{"description":"The name of the module called.","example":"Mime","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"extension":{"description":"The file extension.","example":".foo","type":"string"},"origin":{"description":"The handler's owner.\n*  `system`\n*  `user`","enum":["system","user"],"example":"user","type":"string"},"type":{"description":"The MIME type.","example":"application/foo","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* 1 - Success\n* 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return web server's MIME types","tags":["Mime","Mime Type Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mime \\\n  list_mime \\\n  type='user'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mime/list_mime?type=user"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mime_list_mime.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mime_list_mime.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mime/,\n    q/list_mime/,\n    {\n        'type' => 'user',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mime_list_mime.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mime_list_mime.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mime',\n    'list_mime',\n    array (\n        'type' => 'user',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/ModSecurity/enable_all_domains":{"get":{"description":"This function enables ModSecurity™ on a cPanel account's domains.\n\n**Important:**\n\nWhen you disable the [WebServer role](https://go.cpanel.net/serverroles#roles), the system **disables** this function","operationId":"enable_all_domains","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"enable_all_domains","type":"string"},"module":{"description":"The name of the module called.","example":"ModSecurity","type":"string"},"result":{"properties":{"data":{"example":[{"dependencies":["dallas.com"],"domain":"dallas.example.com","enabled":1,"searchhint":"dallas.com","type":"sub"},{"dependencies":["arkansas.com","kansas.com","nevada.com","newmexico.com","texas.com"],"domain":"example.com","enabled":1,"searchhint":"arkansas.com,kansas.com,nevada.com,newmexico.com,texas.com","type":"main"},{"dependencies":["galveston.com"],"domain":"galveston.example.com","enabled":1,"searchhint":"galveston.com","type":"sub"},{"dependencies":["houston.com"],"domain":"houston.example.com","enabled":1,"searchhint":"houston.com","type":"sub"},{"dependencies":["neworleans.com"],"domain":"neworleans.example.com","enabled":1,"searchhint":"neworleans.com","type":"sub"},{"dependencies":["sanantonio.com"],"domain":"sanantonio.example.com","enabled":1,"searchhint":"sanantonio.com","type":"sub"}],"items":{"properties":{"dependencies":{"description":"An array of domains that your changes to a selected domain affect.","example":["arkansas.com","kansas.com","nevada.com","newmexico.com","texas.com"],"items":{"format":"domain","type":"string"},"type":"array"},"domain":{"description":"The cPanel account's domain.","example":"example.com","format":"domain","type":"string"},"enabled":{"description":"Whether ModSecurity is enabled on the account.\n* `1` - Enabled.\n* `0` - Disabled.","enum":[0,1],"example":0,"type":"integer"},"exception":{"description":"An exception error message. The function only returns this value if an error occurs.","example":"An error occurred during the userdata update for domain “example.com”.","type":"string"},"searchhint":{"description":"A comma-separated list of domain-related search terms.","example":"arkansas.com,kansas.com,nevada.com,newmexico.com,texas.com","type":"string"},"type":{"description":"The domain type.\n* `main` - A main domain.\n* `sub` - A subdomain.","enum":["main","sub"],"example":"main","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable ModSecurity for all domains","tags":["ModSecurity"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  ModSecurity \\\n  enable_all_domains\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/ModSecurity/enable_all_domains"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file ModSecurity_enable_all_domains.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/ModSecurity_enable_all_domains.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/ModSecurity/,\n    q/enable_all_domains/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file ModSecurity_enable_all_domains.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/ModSecurity_enable_all_domains.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'ModSecurity',\n    'enable_all_domains'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.46"}},"/ModSecurity/enable_domains":{"get":{"description":"This function enables ModSecurity™ for specified domains.\n\n**Important:**\n\nWhen you disable the [WebServer role](https://go.cpanel.net/serverroles#roles), the system **disables** this function.","operationId":"enable_domains","parameters":[{"description":"A comma-separated list of domains for which to enable ModSecurity.\n\n**Important:**\n\nThe authenticated cPanel account **must** own these domains.","in":"query","name":"domains","required":true,"schema":{"example":"example.com,dallas.example.com,galveston.example.com","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"enable_domains","type":"string"},"module":{"description":"The name of the module called.","example":"ModSecurity","type":"string"},"result":{"properties":{"data":{"oneOf":[{"example":[{"dependencies":["dallas.com"],"domain":"dallas.example.com","enabled":1,"searchhint":"dallas.com","type":"sub"},{"dependencies":["arkansas.com","kansas.com","nevada.com","newmexico.com","texas.com"],"domain":"example.com","enabled":1,"searchhint":"arkansas.com,kansas.com,nevada.com,newmexico.com,texas.com","type":"main"},{"dependencies":["galveston.com"],"domain":"galveston.example.com","enabled":1,"searchhint":"galveston.com","type":"sub"}],"items":{"properties":{"dependencies":{"description":"An array of domains that your changes to a selected domain affect.","example":["arkansas.com","kansas.com","nevada.com","newmexico.com","texas.com"],"items":{"format":"domain","type":"string"},"type":"array"},"domain":{"description":"The cPanel account's domain.","example":"example.com","format":"domain","type":"string"},"enabled":{"description":"Whether ModSecurity is enabled on the domain.\n* `1` - Enabled.\n* `0` - Disabled.","enum":[0,1],"example":1,"type":"integer"},"exception":{"description":"An exception error message. The function only returns this value if an error occurs.","example":"An error occurred during the userdata update for domain “example.com”.","type":"string"},"searchhint":{"description":"A comma-separated list of domain-related search terms.","example":"arkansas.com,kansas.com,nevada.com,newmexico.com,texas.com","type":"string"},"type":{"description":"The domain type.\n* `main` - A main domain.\n* `sub` - A subdomain.","enum":["main","sub"],"example":"main","type":"string"}},"type":"object"},"type":"array"},{"properties":{"no_domains_provided":{"description":"Indicates caller error on API call.","enum":[1],"example":1,"type":"integer"}},"type":"object"},{"properties":{"invalid_domains":{"description":"List of invalid domains provided by caller.","example":["example.invalid"],"items":{"type":"string"},"type":"array"},"invalid_domains_provided":{"description":"Indicates caller error on API call.","enum":[1],"example":1,"type":"integer"}},"type":"object"}]},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable ModSecurity for selected domains","tags":["ModSecurity"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  ModSecurity \\\n  enable_domains \\\n  domains='example.com,dallas.example.com,galveston.example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/ModSecurity/enable_domains?domains=example.com%2cdallas.example.com%2cgalveston.example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file ModSecurity_enable_domains.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/ModSecurity_enable_domains.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/ModSecurity/,\n    q/enable_domains/,\n    {\n        'domains' => 'example.com,dallas.example.com,galveston.example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file ModSecurity_enable_domains.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/ModSecurity_enable_domains.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'ModSecurity',\n    'enable_domains',\n    array (\n        'domains' => 'example.com,dallas.example.com,galveston.example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.46"}},"/ModSecurity/has_modsecurity_installed":{"get":{"description":"This function checks whether ModSecurity™ is installed on a server.\n\n**Important:**\n\nWhen you disable the [Web Server role](https://go.cpanel.net/serverroles#roles), the system **disables** this function.","operationId":"has_modsecurity_installed","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"has_modsecurity_installed","type":"string"},"module":{"description":"The name of the module called.","example":"ModSecurity","type":"string"},"result":{"properties":{"data":{"properties":{"installed":{"description":"Whether ModSecurity is installed on the server.\n* `1` - Installed.\n* `0` - Not installed.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return ModSecurity installation status","tags":["ModSecurity"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  ModSecurity \\\n  has_modsecurity_installed\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/ModSecurity/has_modsecurity_installed"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file ModSecurity_has_modsecurity_installed.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/ModSecurity_has_modsecurity_installed.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/ModSecurity/,\n    q/has_modsecurity_installed/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file ModSecurity_has_modsecurity_installed.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/ModSecurity_has_modsecurity_installed.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'ModSecurity',\n    'has_modsecurity_installed'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.46"}},"/ModSecurity/list_domains":{"get":{"description":"This function returns ModSecurity's™ status for a cPanel account's domains.\n\n**Important:**\n\nWhen you disable the [WebServer role](https://go.cpanel.net/serverroles#roles), the system **disables** this function.","operationId":"ModSecurity-list_domains","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_domains","type":"string"},"module":{"description":"The name of the module called.","example":"ModSecurity","type":"string"},"result":{"properties":{"data":{"example":[{"dependencies":["dallas.com"],"domain":"dallas.example.com","enabled":1,"searchhint":"dallas.com","type":"sub"},{"dependencies":["arkansas.com","kansas.com","nevada.com","newmexico.com","texas.com"],"domain":"example.com","enabled":1,"searchhint":"arkansas.com,kansas.com,nevada.com,newmexico.com,texas.com","type":"main"},{"dependencies":["galveston.com"],"domain":"galveston.example.com","enabled":1,"searchhint":"galveston.com","type":"sub"},{"dependencies":["houston.com"],"domain":"houston.example.com","enabled":0,"searchhint":"houston.com","type":"sub"},{"dependencies":["neworleans.com"],"domain":"neworleans.example.com","enabled":0,"searchhint":"neworleans.com","type":"sub"},{"dependencies":["sanantonio.com"],"domain":"sanantonio.example.com","enabled":0,"searchhint":"sanantonio.com","type":"sub"}],"items":{"properties":{"dependencies":{"description":"An array of domains that your changes to a selected domain affect.","example":["arkansas.com","kansas.com","nevada.com","newmexico.com","texas.com"],"items":{"format":"domain","type":"string"},"type":"array"},"domain":{"description":"The cPanel account's domain.","example":"example.com","format":"domain","type":"string"},"enabled":{"description":"Whether ModSecurity is enabled for the account.\n* `1` - Enabled.\n* `0` - Disabled.","enum":[0,1],"example":1,"type":"integer"},"searchhint":{"description":"A comma-separated list of domain-related search terms.","example":"arkansas.com,kansas.com,nevada.com,newmexico.com,texas.com","type":"string"},"type":{"description":"The domain type.\n* `main` - A main domain.\n* `sub` - A subdomain.","enum":["main","sub"],"example":"main","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"modsec":{"properties":{"total_disabled":{"description":"The total number of disabled entries.","example":3,"type":"integer"},"total_enabled":{"description":"The total number of enabled entries.","example":3,"type":"integer"}}},"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return ModSecurity domains' status","tags":["ModSecurity"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  ModSecurity \\\n  list_domains\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/ModSecurity/list_domains"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file ModSecurity_list_domains.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/ModSecurity_list_domains.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/ModSecurity/,\n    q/list_domains/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file ModSecurity_list_domains.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/ModSecurity_list_domains.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'ModSecurity',\n    'list_domains'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.46"}},"/Mysql/add_host_note":{"get":{"description":"This function adds a note about a remote MySQL® server.\n\n**Important:**\n\n* If you attempt to add a note to an unauthorized remote MySQL server, the function will fail.\n* When you **disable** the [MySQL role](https://go.cpanel.net/serverroles), the system disables this function.","operationId":"Mysql-add_host_note","parameters":[{"description":"The remote MySQL server's hostname or IP address.\n\nYou may use the following IP address formats:\n\n* `192.168.1.6` — IP address.\n* `192.168.%.%` — Range with the percent (%) symbol as a wildcard.\n* `192.168.0.0/16` — Range in CIDR format.","example":"192.168.1.6","in":"query","name":"host","required":true,"schema":{"oneOf":[{"example":"192.168.1.6","format":"ipv4","type":"string"},{"example":"remote.example.com","format":"domain","type":"string"},{"description":"IP address range with the percent (%) symbol as a wildcard.","example":"192.168.%.%","type":"string"},{"description":"IP address range in CIDR format.","example":"192.168.0.0/16","type":"string"}]}},{"description":"note that describes the remote MySQL server.","in":"query","name":"note","required":true,"schema":{"example":"A remote mysql server for storing my data","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"add_host_note","type":"string"},"module":{"description":"The name of the module called.","example":"Mysql","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API.\nWarnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add remote MySQL host note","tags":["Mysql","Remote Databases"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mysql \\\n  add_host_note \\\n  host='192.168.1.6' \\\n  note='A remote mysql server for storing my data'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mysql/add_host_note?host=192.168.1.6&note=A%20remote%20mysql%20server%20for%20storing%20my%20data"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mysql_add_host_note.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mysql_add_host_note.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mysql/,\n    q/add_host_note/,\n    {\n        'host' => '192.168.1.6',\n        'note' => 'A remote mysql server for storing my data',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mysql_add_host_note.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mysql_add_host_note.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mysql',\n    'add_host_note',\n    array (\n        'host' => '192.168.1.6',\n        'note' => 'A remote mysql server for storing my data',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 74"}},"/Mysql/add_host":{"get":{"description":"This function authorizes a remote MySQL® host to access the account's databases.\n\n**Important:**\n\nWhen you disable the [MySQL role](https://go.cpanel.net/serverroles)\n and remote MySQL is **not** already configured,\n the system **disables** this function.","operationId":"add_host","parameters":[{"description":"The remote MySQL server's hostname or IP address.\n\nYou may use the following IP address formats:\n\n* `192.168.1.6` — IP address.\n* `192.168.%.%` — Range with the percent (%) symbol as a wildcard.\n* `192.168.0.0/16` — Range in CIDR format.","example":"192.168.1.6","in":"query","name":"host","required":true,"schema":{"oneOf":[{"example":"192.168.1.6","format":"ipv4","type":"string"},{"example":"remote.example.com","format":"domain","type":"string"},{"description":"IP address range with the percent (%) symbol as a wildcard.","example":"192.168.%.%","type":"string"},{"description":"IP address range in CIDR format.","example":"192.168.0.0/16","type":"string"}]}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"add_host","type":"string"},"module":{"description":"The name of the module called.","example":"Mysql","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API.\nWarnings describe non-critical failures or\n other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable remote MySQL host access","tags":["Mysql","Remote Databases"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mysql \\\n  add_host \\\n  host='192.168.1.6'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mysql/add_host?host=192.168.1.6"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mysql_add_host.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mysql_add_host.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mysql/,\n    q/add_host/,\n    {\n        'host' => '192.168.1.6',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mysql_add_host.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mysql_add_host.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mysql',\n    'add_host',\n    array (\n        'host' => '192.168.1.6',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.52"}},"/Mysql/check_database":{"get":{"description":"This function checks for errors in all of the tables in a MySQL® database.\n\n**Important:**\n\nWhen you disable the [MySQL role](https://go.cpanel.net/serverroles) **and**\nremote MySQL is **not** already configured, the system **disables** this function.","operationId":"Mysql-check_database","parameters":[{"description":"The database's name.","in":"query","name":"name","required":true,"schema":{"example":"example_test","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"check_database","type":"string"},"module":{"description":"The name of the module called.","example":"Mysql","type":"string"},"result":{"properties":{"data":{"description":"An array that contains a response message for each of a database's tables in sequence.","items":{"properties":{"msg_text":{"description":"The message's contents.","example":"OK","type":"string"},"msg_type":{"description":"The type of message.\n* `status`\n* `error`\n* `info`\n* `note`\n* `warning`\n\n**Note:**\n\nFor more information, read [MySQL's `CHECK TABLE` documentation](http://dev.mysql.com/doc/refman/5.7/en/check-table.html).","enum":["status","error","info","note","warning"],"example":"status","type":"string"},"table":{"description":"The table's name.","example":"table1","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API.\nWarnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Validate MySQL database integrity","tags":["Mysql","Database Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mysql \\\n  check_database \\\n  name='example_test'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mysql/check_database?name=example_test"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mysql_check_database.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mysql_check_database.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mysql/,\n    q/check_database/,\n    {\n        'name' => 'example_test',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mysql_check_database.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mysql_check_database.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mysql',\n    'check_database',\n    array (\n        'name' => 'example_test',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/Mysql/create_database":{"get":{"description":"This function creates a MySQL® database.\n\n**Important:**\n\n  When you disable the [MySQL/MariaDB role](https://go.cpanel.net/howtouseserverprofiles#roles) **and** remote MySQL is **not** already configured, the system **disables** this function.","operationId":"create_database","parameters":[{"description":"The new database's name.","in":"query","name":"name","required":true,"schema":{"example":"newdb","type":"string"}},{"description":"The desired prefix size.","in":"query","name":"prefix-size","required":false,"schema":{"default":16,"enum":[8,16],"example":16,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"create_database","type":"string"},"module":{"description":"The name of the module called.","example":"Mysql","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create MySQL database","tags":["Mysql","Database Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mysql \\\n  create_database \\\n  name='newdb'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mysql/create_database?name=newdb"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mysql_create_database.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mysql_create_database.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mysql/,\n    q/create_database/,\n    {\n        'name' => 'newdb',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mysql_create_database.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mysql_create_database.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mysql',\n    'create_database',\n    array (\n        'name' => 'newdb',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.44"}},"/Mysql/create_user":{"get":{"description":"This function creates a MySQL® database user.\n\n**Important:**\n\nWhen you **disable** the [MySQL role](https://go.cpanel.net/serverroles) and remote MySQL is not already configured, the system disables this function.","operationId":"Mysql-create_user","parameters":[{"description":"A valid database username.\n\nImportant:\n====\n\nTo learn more about database username limits, check your database type:\n\nMySQL 5.6\n----\n\nMySQL version 5.6 limits the database username to 16 characters. The server uses the first nine characters of this limit for the database prefix. The database prefix uses the cPanel account's username and an underscore (`_`). The server only applies the first eight characters of the cPanel account's username.\n\nFor example:\n\n* A `db_` database prefix allows MySQL usernames of up to 13 characters.\n* An `example_` database prefix allows MySQL usernames of up to eight characters.\n\nMySQL 5.7+\n----\n\nMySQL versions 5.7 and later limit the database username to 32 characters. The server uses the first nine characters of this limit for the database prefix. The database prefix uses the cPanel account's username and an underscore (`_`). The server only applies the first eight characters of the cPanel account's username.\n\nFor example:\n\n* A `db_` database prefix allows MySQL usernames of up to 29 characters.\n* An `example_` database prefix allows MySQL usernames of up to 24 characters.\n\nMariaDB\n----\n\nMariaDB limits the database username to 47 characters. The server uses the first nine characters of this limit for the database prefix. The database prefix uses the cPanel account's username and an underscore (`_`). The server only applies the first eight characters of the cPanel account's username.\n\nFor example:\n\n* A `db_` database prefix allows MariaDB usernames of up to 44 characters.\n* An `example_` database prefix allows MariaDB usernames of up to 39 characters.","in":"query","name":"name","required":true,"schema":{"example":"dbuser","type":"string"}},{"description":"The new user's password.","in":"query","name":"password","required":true,"schema":{"example":"12345luggage","type":"string"}},{"description":"The desired prefix size.","in":"query","name":"prefix-size","required":false,"schema":{"default":16,"enum":[8,16],"example":16,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"create_user","type":"string"},"module":{"description":"The name of the module called.","example":"Mysql","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API.\nWarnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create MySQL user","tags":["Mysql","User Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mysql \\\n  create_user \\\n  name='dbuser' \\\n  password='12345luggage'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mysql/create_user?name=dbuser&password=12345luggage"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mysql_create_user.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mysql_create_user.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mysql/,\n    q/create_user/,\n    {\n        'name' => 'dbuser',\n        'password' => '12345luggage',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mysql_create_user.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mysql_create_user.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mysql',\n    'create_user',\n    array (\n        'name' => 'dbuser',\n        'password' => '12345luggage',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.44"}},"/Mysql/delete_user":{"get":{"description":"This function deletes a MySQL® user.\n\n**Important:**\n\nWhen you disable the [MySQL role](https://go.cpanel.net/serverroles) and remote MySQL is not already configured, the system **disables** this function.","operationId":"Mysql::delete_user","parameters":[{"description":"The MySQL user's name.","in":"query","name":"name","required":true,"schema":{"example":"example","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"delete_user","type":"string"},"module":{"description":"The name of the module called.","example":"Mysql","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete MySQL user","tags":["Mysql","User Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mysql \\\n  delete_user \\\n  name='example'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mysql/delete_user?name=example"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mysql_delete_user.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mysql_delete_user.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mysql/,\n    q/delete_user/,\n    {\n        'name' => 'example',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mysql_delete_user.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mysql_delete_user.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mysql',\n    'delete_user',\n    array (\n        'name' => 'example',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.52"}},"/Mysql/dump_database_schema":{"get":{"description":"This function returns a string that you can give to MySQL® to recreate a particular database’s schema.\n\n**Important:**\n\n  When you disable the [MySQL/MariaDB role](https://go.cpanel.net/serverroles) **and** remote MySQL is **not** configured, the system **disables** this function.","operationId":"dump_database_schema","parameters":[{"description":"The database's name.","in":"query","name":"dbname","required":true,"schema":{"example":"username_example_db","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"dump_database_schema","type":"string"},"module":{"description":"The name of the module called.","example":"Mysql","type":"string"},"result":{"properties":{"data":{"description":"The string to give to MySQL.","example":"-- MySQL dump 10.13  Distrib 5.7.26, for Linux (x86_64)\n--\n-- Host: localhost    Database:username_example_db\n-- ------------------------------------------------------\n-- Serverversion\t5.7.26\n\n/*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT*/;\n/*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */;\n/*!40101 SET@OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */;\n/*!40101 SET NAMES utf8mb4*/;\n/*!40103 SET @OLD_TIME_ZONE=@@TIME_ZONE */;\n/*!40103 SET TIME_ZONE='+00:00'*/;\n/*!40014 SET @OLD_UNIQUE_CHECKS=@@UNIQUE_CHECKS, UNIQUE_CHECKS=0 */;\n/*!40014 SET@OLD_FOREIGN_KEY_CHECKS=@@FOREIGN_KEY_CHECKS, FOREIGN_KEY_CHECKS=0 */;\n/*!40101 SET@OLD_SQL_MODE=@@SQL_MODE, SQL_MODE='NO_AUTO_VALUE_ON_ZERO' */;\n/*!40111 SE@OLD_SQL_NOTES=@@SQL_NOTES, SQL_NOTES=0 */;\n\n--\n-- Current Database:`username_example_db`\n--\n\nCREATE DATABASE /*!32312 IF NOT EXISTS*/ `username_example_d/*!40100 DEFAULT CHARACTER SET latin1 */;\n\nUSE `username_example_db`;\n/*!40103 SETTIME_ZONE=@OLD_TIME_ZONE */;\n\n/*!40101 SET SQL_MODE=@OLD_SQL_MODE */;\n/*!40014 SETFOREIGN_KEY_CHECKS=@OLD_FOREIGN_KEY_CHECKS */;\n/*!40014 SET UNIQUE_CHECKS=@OLD_UNIQUE_CHECKS*/;\n/*!40101 SET CHARACTER_SET_CLIENT=@OLD_CHARACTER_SET_CLIENT */;\n/*!40101 SETCHARACTER_SET_RESULTS=@OLD_CHARACTER_SET_RESULTS */;\n/*!40101 SETCOLLATION_CONNECTION=@OLD_COLLATION_CONNECTION */;\n/*!40111 SET SQL_NOTES=@OLD_SQL_NOTES*/;\n\n-- Dump completed on 2019-06-06  9:44:04\n","type":"string"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return MySQL database schema","tags":["Mysql","Database Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mysql \\\n  dump_database_schema \\\n  dbname='username_example_db'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mysql/dump_database_schema?dbname=username_example_db"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mysql_dump_database_schema.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mysql_dump_database_schema.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mysql/,\n    q/dump_database_schema/,\n    {\n        'dbname' => 'username_example_db',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mysql_dump_database_schema.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mysql_dump_database_schema.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mysql',\n    'dump_database_schema',\n    array (\n        'dbname' => 'username_example_db',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/Mysql/get_host_notes":{"get":{"description":"This function returns the notes associated with the account's remote MySQL® hosts.\n\n**Important:**\n\n  When you disable the [*MySQL/MariaDB* role](https://go.cpanel.net/serverroles)\n  **and** remote MySQL is **not** already configured, the system **disables** this function.","operationId":"get_host_notes","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_host_notes","type":"string"},"module":{"description":"The name of the module called.","example":"Mysql","type":"string"},"result":{"properties":{"data":{"additionalProperties":{"description":"The notes associated with the account's Remote MySQL hosts.","example":"Located somewhere in the Ford Galaxy","type":"string"},"description":"The keys are remote MySQL hostnames or IP addresses and values are their corresponding notes.","example":{"1.2.3.45":"The combination on my luggage","12.34.56.78":"Located somewhere in the Ford Galaxy","8.8.8.8":"Located on Spaceball 1"},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return remote MySQL host notes","tags":["Mysql","Remote Databases"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mysql \\\n  get_host_notes\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mysql/get_host_notes"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mysql_get_host_notes.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mysql_get_host_notes.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mysql/,\n    q/get_host_notes/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mysql_get_host_notes.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mysql_get_host_notes.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mysql',\n    'get_host_notes'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 74"}},"/Mysql/get_restrictions":{"get":{"description":"This function lists a MySQL® database's name, username length restrictions, and database prefix.\n\n**Important:**\n\n  When you disable the [*MySQL/MariaDB* role](https://go.cpanel.net/serverroles)\n  **and** remote MySQL is **not** already configured, the system **disables** this function.","operationId":"get_restrictions","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_restrictions","type":"string"},"module":{"description":"The name of the module called.","example":"Mysql","type":"string"},"result":{"properties":{"data":{"properties":{"max_database_name_length":{"description":"The maximum length of a MySQL database name.","example":64,"minimum":1,"type":"integer"},"max_username_length":{"description":"The maximum length of a MySQL database user's name.","example":16,"minimum":1,"type":"integer"},"prefix":{"description":"The account's database prefix, if database prefixing is enabled.\n* If database prefixing is enabled, a string of up to the first eight characters of the cPanel account username, and an underscore (_).\n* If database prefixing is disabled, this is null.","example":"user_","nullable":true,"type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return MySQL name length restrictions","tags":["Mysql","User Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mysql \\\n  get_restrictions\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mysql/get_restrictions"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mysql_get_restrictions.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mysql_get_restrictions.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mysql/,\n    q/get_restrictions/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mysql_get_restrictions.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mysql_get_restrictions.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mysql',\n    'get_restrictions'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.44"}},"/Mysql/delete_database":{"get":{"description":"This function deletes a MySQL® database.\n\n**Important:**\n\nwhen you disable the [MySQL/MariaDB role](https://go.cpanel.net/serverroles#roles) **and**\nremote MySQL is **not** already configured, the system **disables** this function.","operationId":"delete_database","parameters":[{"description":"The database's name.","in":"query","name":"name","required":true,"schema":{"example":"example","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"delete_database","type":"string"},"module":{"description":"The name of the module called.","example":"Mysql","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API.\nWarnings describe non-critical failures or\n other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete MySQL database","tags":["Mysql","Database Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mysql \\\n  delete_database \\\n  name='example'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mysql/delete_database?name=example"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mysql_delete_database.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mysql_delete_database.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mysql/,\n    q/delete_database/,\n    {\n        'name' => 'example',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mysql_delete_database.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mysql_delete_database.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mysql',\n    'delete_database',\n    array (\n        'name' => 'example',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.52"}},"/Mysql/list_databases":{"get":{"description":"This function lists an account's MySQL® databases.\n\n**Important:**\n\nWhen you disable the [*MySQL/MariaDB* role](https://go.cpanel.net/serverroles) **and** remote MySQL is **not** configured, the system **disables** this function.","operationId":"list_databases","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_databases","type":"string"},"module":{"description":"The name of the module called.","example":"Mysql","type":"string"},"result":{"properties":{"data":{"description":"Information about the database.","items":{"properties":{"database":{"description":"The database name.","example":"user_db","type":"string"},"disk_usage":{"description":"The disk space that the database uses, in bytes.","example":673,"minimum":0,"type":"integer"},"users":{"description":"A list of database usernames.\n\n**Note:**\n\nIf no users exist on a database, the function returns an empty array.","example":["db_user","db2_user"],"items":{"type":"string"},"type":"array"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return MySQL databases","tags":["Mysql","Database Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mysql \\\n  list_databases\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mysql/list_databases"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mysql_list_databases.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mysql_list_databases.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mysql/,\n    q/list_databases/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mysql_list_databases.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mysql_list_databases.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mysql',\n    'list_databases'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/Mysql/get_server_information":{"get":{"description":"This function returns information about the account's MySQL® host.\n\n**Important:**\n\n  When you disable the [MySQL role](https://go.cpanel.net/serverroles) **and** remote MySQL is **not** already configured, the system **disables** this function.","operationId":"get_server_information","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_server_information","type":"string"},"module":{"description":"The name of the module called.","example":"Mysql","type":"string"},"result":{"properties":{"data":{"properties":{"host":{"description":"The MySQL server's hostname or IP address.","oneOf":[{"example":"192.0.2.1","format":"ipv4","type":"string"},{"example":"remote.example.com","format":"domain","type":"string"}]},"is_remote":{"description":"Whether the host is a remote MySQL server.\n* `1` - Remote host.\n* `0` - Local host.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The MySQL server's version.","example":"5.6.23","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return MySQL server host information and version","tags":["Mysql","Database Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mysql \\\n  get_server_information\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mysql/get_server_information"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mysql_get_server_information.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mysql_get_server_information.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mysql/,\n    q/get_server_information/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mysql_get_server_information.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mysql_get_server_information.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mysql',\n    'get_server_information'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/Mysql/list_routines":{"get":{"description":"This function returns a database user's MySQL® routines.\n\n**Important:**\n\n  When you disable the [MySQL/MariaDB role](https://go.cpanel.net/serverroles) **and**\n  remote MySQL is **not** configured, the system **disables** this function.","operationId":"list_routines","parameters":[{"description":"The database user for whom to return MySQL routines. If you don't specify a database user, this function returns the MySQL routines for all database users.","in":"query","name":"database_user","required":false,"schema":{"example":"db_user","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_routines","type":"string"},"module":{"description":"The name of the module called.","example":"Mysql","type":"string"},"result":{"properties":{"data":{"description":"An array of MySQL routines. If no routines exist, the function returns an empty array.","example":["cptest_newdb.hello","cptest_newdb.my_routine"],"items":{"type":"string"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return MySQL user routines","tags":["Mysql","User Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mysql \\\n  list_routines\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mysql/list_routines"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mysql_list_routines.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mysql_list_routines.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mysql/,\n    q/list_routines/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mysql_list_routines.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mysql_list_routines.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mysql',\n    'list_routines'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/Mysql/locate_server":{"get":{"description":"This function returns information about the account's MySQL® host.\n\n**Important:**\n\nWhen you disable the [MySQL/MariaDB role](https://go.cpanel.net/serverroles#roles) **and** remote MySQL is **not** already configured, the system **disables** this function.","operationId":"locate_server","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"locate_server","type":"string"},"module":{"description":"The name of the module called.","example":"Mysql","type":"string"},"result":{"properties":{"data":{"properties":{"is_remote":{"description":"Whether the host is a remote MySQL server.\n* `1` - Remote host.\n* `0` - Local host.","enum":[0,1],"example":1,"type":"integer"},"remote_host":{"description":"The remote MySQL server's hostname or IP address.","oneOf":[{"description":"An IP address.","example":"192.0.2.1","format":"ipv4","type":"string"},{"description":"A hostname.","example":"remote.example.com","format":"domain","type":"string"}]}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return MySQL server host information","tags":["Mysql","Database Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mysql \\\n  locate_server\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mysql/locate_server"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mysql_locate_server.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mysql_locate_server.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mysql/,\n    q/locate_server/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mysql_locate_server.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mysql_locate_server.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mysql',\n    'locate_server'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.52"}},"/Mysql/list_users":{"get":{"description":"This function lists an account's MySQL® database users.\n\n**Important:**\n\n  When you disable the [MySQL/MariaDB role](https://go.cpanel.net/serverroles) **and**\n  remote MySQL is **not** configured, the system **disables** this function.","operationId":"Mysql-list_users","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_users","type":"string"},"module":{"description":"The name of the module called.","example":"Mysql","type":"string"},"result":{"properties":{"data":{"description":"An array of database information objects.","items":{"properties":{"databases":{"description":"An array of databases that belong to the\ndatabase user.\n\n**Note:**\n\nIf no users are assigned to a database, the function returns\nan empty array.","example":["user_database1","user_database2"],"items":{"type":"string"},"type":"array"},"shortuser":{"description":"The short version of the database username.","example":"user1","type":"string"},"user":{"description":"The database username.","example":"example_user1","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return MySQL users","tags":["Mysql","User Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mysql \\\n  list_users\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mysql/list_users"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mysql_list_users.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mysql_list_users.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mysql/,\n    q/list_users/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mysql_list_users.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mysql_list_users.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mysql',\n    'list_users'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/Mysql/rename_database":{"get":{"description":"This function renames a MySQL® database.\n\nMySQL does not allow you to rename a database. When cPanel & WHM \"renames\" a database, the\nsystem performs the following steps:\n1. The system creates a new database.\n2. The system moves data from the old database to the new database.\n3. The system recreates grants and stored code in the new database.\n4. The system deletes the old database and its grants.\n\n**Warning:**\n\n* It is potentially dangerous to rename a MySQL database. We **strongly** recommend that you\nperform a backup of the database before you attempt to rename it.\n* If any of the first three steps fail, the system returns an error and attempts to restore the database's original state.\n If the restoration process fails, the API function's error response describes these additional failures.\n* In rare cases, the system creates the second database successfully, but fails to delete the old database or grants.\n The system treats the rename action as a success; however,\n the API function returns warnings that describe the failure to delete the old database or grants.\n\n**Important:**\n\nWhen you disable the [MySQL/MariaDB role](https://go.cpanel.net/serverroles)\n**and** remote MySQL is **not** already configured, the system **disables** this function.","operationId":"Mysql-rename_database","parameters":[{"description":"The database's current name.","in":"query","name":"oldname","required":true,"schema":{"example":"mydb","type":"string"}},{"description":"The database's new name.\n\n**Important:**\n\n* If database prefixing is enabled, you **must** prefix this value with the account prefix\nand an underscore (`_`). For example, for the `dbuser` database on the user cPanel account,\npass in a value of `user_dbuser`.\n* The maximum length of the database name is 64 characters. However, due to the method that\ncPanel & WHM uses to store MySQL database names, each underscore character requires two\ncharacters of that limit. Therefore, if you enable database prefixing, the maximum length of\nthe database name is 63 characters, which includes both the database prefix and the\nunderscore character. Each additional underscore requires another two characters of that\nlimit.","in":"query","name":"newname","required":true,"schema":{"example":"newlyrenamed","maxLength":64,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"rename_database","type":"string"},"module":{"description":"The name of the module called.","example":"Mysql","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API.\nWarnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update MySQL database name","tags":["Mysql","Database Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mysql \\\n  rename_database \\\n  oldname='mydb' \\\n  newname='newlyrenamed'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mysql/rename_database?oldname=mydb&newname=newlyrenamed"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mysql_rename_database.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mysql_rename_database.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mysql/,\n    q/rename_database/,\n    {\n        'oldname' => 'mydb',\n        'newname' => 'newlyrenamed',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mysql_rename_database.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mysql_rename_database.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mysql',\n    'rename_database',\n    array (\n        'oldname' => 'mydb',\n        'newname' => 'newlyrenamed',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.44"}},"/Mysql/rename_user":{"get":{"description":"This function renames a MySQL® database user.\n\n**Important:**\n\nWhen you disable the [MySQL role](https://go.cpanel.net/serverroles)\n and remote MySQL is **not** already configured,\n the system **disables** this function.","operationId":"rename_user","parameters":[{"description":"The user's current name.","in":"query","name":"oldname","required":true,"schema":{"example":"dbuser","type":"string"}},{"description":"The user's new name.\n\nImportant:\n====\n\nTo learn more about database username limits, check your database type:\n\nMySQL 5.6\n----\n\nMySQL version 5.6 limits the database username to 16 characters. The server uses the first nine characters of this limit for the database prefix. The database prefix uses the cPanel account's username and an underscore (`_`). The server only applies the first eight characters of the cPanel account's username.\n\nFor example:\n\n* A `db_` database prefix allows MySQL usernames of up to 13 characters.\n* An `example_` database prefix allows MySQL usernames of up to eight characters.\n\nMySQL 5.7+\n----\n\nMySQL versions 5.7 and later limit the database username to 32 characters. The server uses the first nine characters of this limit for the database prefix. The database prefix uses the cPanel account's username and an underscore (`_`). The server only applies the first eight characters of the cPanel account's username.\n\nFor example:\n\n* A `db_` database prefix allows MySQL usernames of up to 29 characters.\n* An `example_` database prefix allows MySQL usernames of up to 24 characters.\n\nMariaDB\n----\n\nMariaDB limits the database username to 47 characters. The server uses the first nine characters of this limit for the database prefix. The database prefix uses the cPanel account's username and an underscore (`_`). The server only applies the first eight characters of the cPanel account's username.\n\nFor example:\n\n* A `db_` database prefix allows MariaDB usernames of up to 44 characters.\n* An `example_` database prefix allows MariaDB usernames of up to 39 characters.","in":"query","name":"newname","required":true,"schema":{"example":"mynewusername","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"rename_user","type":"string"},"module":{"description":"The name of the module called.","example":"Mysql","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update MySQL username","tags":["Mysql","User Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mysql \\\n  rename_user \\\n  oldname='dbuser' \\\n  newname='mynewusername'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mysql/rename_user?oldname=dbuser&newname=mynewusername"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mysql_rename_user.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mysql_rename_user.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mysql/,\n    q/rename_user/,\n    {\n        'oldname' => 'dbuser',\n        'newname' => 'mynewusername',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mysql_rename_user.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mysql_rename_user.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mysql',\n    'rename_user',\n    array (\n        'oldname' => 'dbuser',\n        'newname' => 'mynewusername',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.44"}},"/Mysql/get_privileges_on_database":{"get":{"description":"This function lists a MySQL® database user's privileges.\n\n**Important:**\n\nWhen you disable the [MySQL role](https://go.cpanel.net/serverroles)\nand remote MySQL is not already configured, the system disables this function.","operationId":"Mysql-get_privileges_on_database","parameters":[{"description":"The database user's name.\n\n**Important:**\n\nIf database prefixing is enabled, you **must** prefix this value with the account prefix and an underscore (`_`).\n\nFor example, for the `dbuser` user on the `user` cPanel account, pass in a value of `user_dbuser`.","in":"query","name":"user","required":true,"schema":{"example":"dbuser","type":"string"}},{"description":"The database name.","in":"query","name":"database","required":true,"schema":{"example":"mydb","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_privileges_on_database","type":"string"},"module":{"description":"The name of the module called.","example":"Mysql","type":"string"},"result":{"properties":{"data":{"description":"An array of privileges.\n\n**Note:**\n\nIf the database user does not have privileges on the database database,\nthis array will return empty.\n* `ALL PRIVILEGES`\n* One or more of the following individual privileges:\n  * `ALTER`\n  * `ALTER ROUTINE`\n  * `CREATE`\n  * `CREATE ROUTINE`\n  * `CREATE TEMPORARY TABLES`\n  * `CREATE VIEW`\n  * `DELETE`\n  * `DROP`\n  * `EVENT`\n  * `EXECUTE`\n  * `INDEX`\n  * `INSERT`\n  * `LOCK TABLES`\n  * `REFERENCES`\n  * `SELECT`\n  * `SHOW VIEW`\n  * `TRIGGER`\n  * `UPDATE`","items":{"example":"CREATE","type":"string"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API.\nWarnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return MySQL user privileges","tags":["Mysql","User Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mysql \\\n  get_privileges_on_database \\\n  user='dbuser' \\\n  database='mydb'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mysql/get_privileges_on_database?user=dbuser&database=mydb"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mysql_get_privileges_on_database.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mysql_get_privileges_on_database.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mysql/,\n    q/get_privileges_on_database/,\n    {\n        'user' => 'dbuser',\n        'database' => 'mydb',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mysql_get_privileges_on_database.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mysql_get_privileges_on_database.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mysql',\n    'get_privileges_on_database',\n    array (\n        'user' => 'dbuser',\n        'database' => 'mydb',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.44"}},"/Mysql/revoke_access_to_database":{"get":{"description":"This function revokes a MySQL® database user's privileges.\n\n**Important:**\n\nWhen you disable the [MySQL role](https://go.cpanel.net/serverroles) **and**\nremote MySQL is **not** already configured, the system **disables** this function.","operationId":"revoke_access_to_database","parameters":[{"description":"The database user's name.\n\n**Important:**\n\nIf database prefixing is enabled, you **must** prefix this value with the account\nprefix and an underscore (`_`).\n\nFor example, for the `dbuser` user on the `user` cPanel account, pass in a value\nof `user_dbuser`. ","in":"query","name":"user","required":true,"schema":{"example":"dbuser","type":"string"}},{"description":"The database's name.","in":"query","name":"database","required":true,"schema":{"example":"mydb","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"revoke_access_to_database","type":"string"},"module":{"description":"The name of the module called.","example":"Mysql","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API.\nWarnings describe non-critical failures or\n other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove MySQL user privileges","tags":["Mysql","User Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mysql \\\n  revoke_access_to_database \\\n  user='dbuser' \\\n  database='mydb'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mysql/revoke_access_to_database?user=dbuser&database=mydb"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mysql_revoke_access_to_database.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mysql_revoke_access_to_database.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mysql/,\n    q/revoke_access_to_database/,\n    {\n        'user' => 'dbuser',\n        'database' => 'mydb',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mysql_revoke_access_to_database.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mysql_revoke_access_to_database.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mysql',\n    'revoke_access_to_database',\n    array (\n        'user' => 'dbuser',\n        'database' => 'mydb',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.44"}},"/Mysql/repair_database":{"get":{"description":"This function repairs all of the tables in a MySQL® database.\n\n**Important:**\n\nWhen you disable the [MySQL/MariaDB role](https://go.cpanel.net/serverroles)\n**and** remote MySQL is **not** already configured, the system **disables** this function.","operationId":"repair_database","parameters":[{"description":"The database's name.","in":"query","name":"name","required":true,"schema":{"example":"example_db","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"repair_database","type":"string"},"module":{"description":"The name of the module called.","example":"Mysql","type":"string"},"result":{"properties":{"data":{"description":"An array of objects containing a response message for each of a database's table in sequence.","items":{"properties":{"msg_text":{"description":"The message's contents.","example":"OK","type":"string"},"msg_type":{"description":"The type of message.\n\n* `status`\n* `error`\n* `info`\n* `note`\n* `warning`\n\n**Note:**\n\nFor more information, read [MySQL's REPAIR TABLE](http://dev.mysql.com/doc/refman/5.7/en/repair-table.html) documentation.","enum":["status","error","info","note","warning"],"example":"status","type":"string"},"table":{"description":"The table's name in the database.","example":"table1","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Repair MySQL database tables","tags":["Mysql","Database Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mysql \\\n  repair_database \\\n  name='example_db'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mysql/repair_database?name=example_db"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mysql_repair_database.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mysql_repair_database.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mysql/,\n    q/repair_database/,\n    {\n        'name' => 'example_db',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mysql_repair_database.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mysql_repair_database.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mysql',\n    'repair_database',\n    array (\n        'name' => 'example_db',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/Mysql/set_privileges_on_database":{"get":{"description":"This function sets a MySQL® database user's privileges.\n\n**Important:**\n\nWhen you disable the [*MySQL/MariaDB* role](https://go.cpanel.net/serverroles), **and** remote MySQL is **not** already configured, the system **disables** this function.","operationId":"set_privileges_on_database","parameters":[{"description":"The database user's name.\n\n**Important:**\n\nIf database prefixing is enabled, you **must** prefix this value with the account prefix and an underscore (`_`). For example, for the `dbuser` user on the `user` cPanel account, pass in a value of `user_dbuser`.","in":"query","name":"user","required":true,"schema":{"example":"cpuser_dbuser","type":"string"}},{"description":"The database's name.\n\n**Important:**\n\nIf database prefixing is enabled, you **must** prefix this value with the account prefix and an underscore (`_`). For example, for the `db` database on the `user` cPanel account, pass in a value of `user_db`.","in":"query","name":"database","required":true,"schema":{"example":"cpuser_dbname","type":"string"}},{"description":"* `ALL PRIVILEGES`\n* A comma-separated list of one or more of the following individual privileges:\n  * `ALTER`\n  * `ALTER ROUTINE`\n  * `CREATE`\n  * `CREATE ROUTINE`\n  * `CREATE TEMPORARY TABLES`\n  * `CREATE VIEW`\n  * `DELETE`\n  * `DROP`\n  * `EVENT`\n  * `EXECUTE`\n  * `INDEX`\n  * `INSERT`\n  * `LOCK TABLES`\n  * `REFERENCES`\n  * `SELECT`\n  * `SHOW VIEW`\n  * `TRIGGER`\n  * `UPDATE`\n\n**Note:**\n\n* This list replaces, rather than adds to, the existing privilege list.\n* In browser-based and command line calls, separate multiple values with `%2C` and replace spaces with `%20`.","in":"query","name":"privileges","required":false,"schema":{"example":"DELETE,UPDATE,CREATE,ALTER","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_privileges_on_database","type":"string"},"module":{"description":"The name of the module called.","example":"Mysql","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update MySQL user privileges","tags":["Mysql","User Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mysql \\\n  set_privileges_on_database \\\n  user='cpuser_dbuser' \\\n  database='cpuser_dbname'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mysql/set_privileges_on_database?user=cpuser_dbuser&database=cpuser_dbname"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mysql_set_privileges_on_database.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mysql_set_privileges_on_database.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mysql/,\n    q/set_privileges_on_database/,\n    {\n        'user' => 'cpuser_dbuser',\n        'database' => 'cpuser_dbname',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mysql_set_privileges_on_database.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mysql_set_privileges_on_database.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mysql',\n    'set_privileges_on_database',\n    array (\n        'user' => 'cpuser_dbuser',\n        'database' => 'cpuser_dbname',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.44"}},"/Notifications/get_notifications_count":{"get":{"description":"This function returns the number of server-wide notifications on an account.","operationId":"get_notifications_count","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_notifications_count","type":"string"},"module":{"description":"The name of the module called.","example":"Notifications","type":"string"},"result":{"properties":{"data":{"description":"The number of server-wide notifications.","example":3,"minimum":0,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return server notifications total","tags":["Notifications"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Notifications \\\n  get_notifications_count\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Notifications/get_notifications_count"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Notifications_get_notifications_count.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Notifications_get_notifications_count.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Notifications/,\n    q/get_notifications_count/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Notifications_get_notifications_count.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Notifications_get_notifications_count.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Notifications',\n    'get_notifications_count'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/PassengerApps/edit_application":{"get":{"description":"This function edits a Passenger application for an account.\n\n**Note**:\n\n  When you disable the [Web Server role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"edit_application","parameters":[{"description":"The application’s current name.","in":"query","name":"name","required":true,"schema":{"example":"Ruby Slippers","type":"string"}},{"description":"The application’s new name. If you do not use this parameter, the function does not change the application's name.","in":"query","name":"new_name","required":false,"schema":{"example":"Little Dog","type":"string"}},{"description":"The application’s new filepath. If you do not use this parameter, the function does not change the application’s filepath.","in":"query","name":"path","required":false,"schema":{"example":"/home/dorothy/littledog","format":"path","type":"string"}},{"description":"The application’s new domain. If you do not use this parameter, the function does not change the application’s domain.","in":"query","name":"domain","required":false,"schema":{"example":"toto.com","format":"domain","type":"string"}},{"description":"The new server environment in which to run the application. If you do not use this parameter, the function does not change the application’s server environment.\n\n  * `development` — Sets the application to run in a development environment.\n  * `production` — Sets the application to run in a production environment.","in":"query","name":"deployment_mode","required":false,"schema":{"enum":["production","development"],"example":"production","type":"string"}},{"description":"New set of environment variables for the application.\n\n**Important**:\n\n The function replaces all current environment variables with the variables that you pass in this parameter.\n\n**Note**:\n\n  For each `envvar_name` parameter you send you **must** include an `envvar_value` parameter.","explode":true,"in":"query","name":"envvar_name","required":false,"schema":{"example":["SCARECROW","TINMAN","LION"],"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Each environment variable’s value.\n\n**Note**:\n\n  For each `envvar_name` parameter you send you **must** include an `envvar_value` parameter.","in":"query","name":"envvar_value","required":false,"schema":{"example":["brain","heart","courage"],"items":{"type":"string"},"maxLength":1024,"minLength":1,"type":"array"},"style":"form"},{"description":"Whether to clear the application’s environment variables.","in":"query","name":"clear_envvars","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"Whether to enable the application and generate the web server configuration for it.\n\n  * `1` — Enable the application and generate the web server configuration.\n  * `0` — Don’t enable the application and generate the web server configuration.","in":"query","name":"enabled","required":false,"schema":{"default":1,"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"Little Dog":{"base_uri":"/littledog","deployment_mode":"production","domain":"toto.com","enabled":1,"envvars":{"LION":"courage","SCARECROW":"brain","TINMAN":"heart"},"name":"Little Dog","path":"/home/dorothy/littledog"}},"errors":null,"messages":null,"metadata":{},"status":1},"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"edit_application","type":"string"},"module":{"description":"The name of the module called.","example":"PassengerApps","type":"string"},"result":{"properties":{"data":{"additionalProperties":{"description":"An object describing the newly-edited application.\n\n**Note**: `application_name` is the `name` of the application.","maxProperties":1,"properties":{"base_uri":{"description":"The URI of the application.","format":"url-path","type":"string"},"deployment_mode":{"description":"The deployment mode of the application.","enum":["production","development"],"type":"string"},"domain":{"description":"The domain of the application.","format":"domain","type":"string"},"enabled":{"description":"Whether the application is enabled or not.\n\n  * `1` — Enabled.\n  * `0` — Disabled.","enum":[1,0],"type":"integer"},"envvars":{"description":"An object of the application’s environment variables and their values.","type":"object"},"name":{"description":"The name of the application.","type":"string"},"path":{"description":"The path of the application inside the user’s home directory.","format":"path","type":"string"}},"type":"object","x-additionalPropertiesName":"application_name"},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` — Success.\n- `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update Passenger application settings","tags":["PassengerApps","Application Manager"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  PassengerApps \\\n  edit_application \\\n  name='Ruby Slippers'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/PassengerApps/edit_application?name=Ruby%20Slippers"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file PassengerApps_edit_application.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/PassengerApps_edit_application.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/PassengerApps/,\n    q/edit_application/,\n    {\n        'name' => 'Ruby Slippers',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file PassengerApps_edit_application.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/PassengerApps_edit_application.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'PassengerApps',\n    'edit_application',\n    array (\n        'name' => 'Ruby Slippers',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 66"}},"/Parser/firstfile_relative_uri":{"get":{"description":"This function reports the first file's URI, relative to the cPanel base directory.","operationId":"firstfile_relative_uri","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"firstfile_relative_uri","type":"string"},"module":{"description":"The name of the module called.","example":"Parser","type":"string"},"result":{"properties":{"data":{"properties":{"uri":{"description":"The file's absolute file path.","example":"/usr/local/cpanel/base/favicon.ico","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return session relative URI","tags":["Parser","URL Parsing"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Parser \\\n  firstfile_relative_uri\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Parser/firstfile_relative_uri"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\t  \n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Parser_firstfile_relative_uri.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Parser_firstfile_relative_uri.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Parser/,\n    q/firstfile_relative_uri/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\t  \n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Parser_firstfile_relative_uri.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Parser_firstfile_relative_uri.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Parser',\n    'firstfile_relative_uri'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/PassengerApps/disable_application":{"get":{"description":"This function disables a Passenger application on an account.\n\n**Important:**\n\n  When you disable the [Web Server role](https://go.cpanel.net/serverroles#roles), the system **disables** this function.","operationId":"disable_application","parameters":[{"description":"The application to disable.","in":"query","name":"name","required":true,"schema":{"example":"slippers","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"disable_application","type":"string"},"module":{"description":"The name of the module called.","example":"PassengerApps","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Disable Passenger application","tags":["PassengerApps","Application Manager"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  PassengerApps \\\n  disable_application \\\n  name='slippers'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/PassengerApps/disable_application?name=slippers"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file PassengerApps_disable_application.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/PassengerApps_disable_application.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/PassengerApps/,\n    q/disable_application/,\n    {\n        'name' => 'slippers',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file PassengerApps_disable_application.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/PassengerApps_disable_application.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'PassengerApps',\n    'disable_application',\n    array (\n        'name' => 'slippers',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 66"}},"/Mysql/set_password":{"get":{"description":"This function sets a MySQL® database user's password.\n\n**Important:**\n\nWhen you disable the [MySQL role](https://go.cpanel.net/serverroles)\n and remote MySQL is **not** already configured,\n the system **disables** this function.","operationId":"Mysql-set_password","parameters":[{"description":"The MySQL database user.","in":"query","name":"user","required":true,"schema":{"example":"dbuser","type":"string"}},{"description":"The user's new password.","in":"query","name":"password","required":true,"schema":{"example":"12345luggage","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_password","type":"string"},"module":{"description":"The name of the module called.","example":"Mysql","type":"string"},"result":{"properties":{"data":{"properties":{"failures":{"description":"An array of the function's error messages.","items":{"properties":{"error":{"description":"The error message.","type":"string"},"host":{"description":"The hostname that reported the error.","format":"domain","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API.\nWarnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update MySQL user password","tags":["Mysql","User Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mysql \\\n  set_password \\\n  user='dbuser' \\\n  password='12345luggage'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mysql/set_password?user=dbuser&password=12345luggage"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mysql_set_password.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mysql_set_password.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mysql/,\n    q/set_password/,\n    {\n        'user' => 'dbuser',\n        'password' => '12345luggage',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mysql_set_password.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mysql_set_password.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mysql',\n    'set_password',\n    array (\n        'user' => 'dbuser',\n        'password' => '12345luggage',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.44"}},"/PassengerApps/enable_application":{"get":{"description":"This function enables a Passenger application and generates the Apache configuration on an account.\n\n**Important:**\n\nWhen you disable the [Web Server role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function. ","operationId":"enable_application","parameters":[{"description":"The Passenger application to enable on the account.","in":"query","name":"name","required":true,"schema":{"example":"slippers","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"enable_application","type":"string"},"module":{"description":"The name of the module called.","example":"PassengerApps","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable Passenger application","tags":["PassengerApps","Application Manager"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  PassengerApps \\\n  enable_application \\\n  name='slippers'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/PassengerApps/enable_application?name=slippers"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file PassengerApps_enable_application.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/PassengerApps_enable_application.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/PassengerApps/,\n    q/enable_application/,\n    {\n        'name' => 'slippers',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file PassengerApps_enable_application.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/PassengerApps_enable_application.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'PassengerApps',\n    'enable_application',\n    array (\n        'name' => 'slippers',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 66"}},"/PassengerApps/list_applications":{"get":{"description":"This function lists an account’s Passenger applications.\n\n**Important:**\n\n  When you disable the [Web Server role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"list_applications","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_applications","type":"string"},"module":{"description":"The name of the module called.","example":"PassengerApps","type":"string"},"result":{"properties":{"data":{"additionalProperties":{"description":"**Note**:\n\nThe top-level keys are the names of the applications.\n\nThe value is the object defined here.","properties":{"base_uri":{"description":"The URI of the application.","example":"/uri-of-app","format":"url-path","type":"string"},"deployment_mode":{"description":"The deployment mode of the application.\n\n  * `development` — Sets the application to run in a development environment.\n  * `production` — Sets the application to run in a production environment.","enum":["production","development"],"example":"production","type":"string"},"deps":{"properties":{"gem":{"description":"The shell command to ensure ruby dependencies. It is `0` if there are no ruby dependencies.","example":"0","type":"string"},"npm":{"description":"The shell command to ensure node dependencies. It is `0` if there are no node dependencies.","example":"0","type":"string"},"pip":{"description":"The shell command to ensure python dependencies. It is `0` if there are no python dependencies.","example":"0","type":"string"}},"type":"object"},"domain":{"description":"The domain of the application","example":"example.com","format":"domain","type":"string"},"enabled":{"description":"The application’s enabled status.\n\n* `1` — Enabled.\n* `0` — Disabled."},"envvars":{"description":"The environment variables set for the application.","nullable":true,"type":"object"},"name":{"description":"The name of the application","example":"My Application","type":"string"},"nodejs":{"description":"The path of the Nodejs executable.\nPassenger uses Nodejs to run the application.\n\n**Note**:\n\nThe function only returns this value if you configure this application to use\nNodejs.","example":"/opt/cpanel/ea-nodejs10/bin/node","format":"path","type":"string"},"path":{"description":"The path of the application","example":"/home/user/app-path","format":"path","type":"string"},"python":{"description":"The path of the Python executable.\nPassenger uses Python to run the application.\n\n**Note**:\n\nThe function only returns this value if you configure this application to use\nPython.","example":"/usr/bin/python","format":"path","type":"string"},"ruby":{"description":"The path of the Ruby executable.\nPassenger uses Ruby to run the application.\n\n**Note**:\n\nThe function only returns this value if you configure this application to use\nRuby.","example":"/opt/cpanel/ea-ruby27/root/usr/libexec/passenger-ruby27","format":"path","type":"string"}},"type":"object"},"description":"An object describing each application.","example":{"Name of Application 1":{"base_uri":"/app1-uri","deployment_mode":"production","deps":{"gem":"0","npm":"0","pip":"cd /home/user/app1-dir && pip install --user -r requirements.txt"},"domain":"example.com","enabled":1,"envvars":{},"name":"Name of Application 1","path":"/home/user/app1-dir"},"Name of Application 2":{"base_uri":"/app2-uri","deployment_mode":"development","deps":{"gem":"cd /home/user/app2-dir && BUNDLE_PATH=~/.gem /path/to/ruby/version/package/bundler install","npm":"0","pip":"0"},"domain":"example.com","enabled":1,"envvars":{},"name":"Name of Application 2","path":"/home/user/app2-dir"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` — Success.\n- `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return Passenger applications","tags":["PassengerApps","Application Manager"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  PassengerApps \\\n  list_applications\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/PassengerApps/list_applications"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file PassengerApps_list_applications.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/PassengerApps_list_applications.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/PassengerApps/,\n    q/list_applications/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file PassengerApps_list_applications.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/PassengerApps_list_applications.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'PassengerApps',\n    'list_applications'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 66"}},"/PassengerApps/ensure_deps":{"get":{"description":"This function installs the dependencies for a Passenger application.\n\n**Note**:\n\n  This function starts the installation process. This may take a long time to complete.\n\n**Important**:\n\n  When you disable the [Web Server role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"ensure_deps","parameters":[{"description":"The application’s type.\n\n* `gem` — Ensure ruby gems in the application’s `Gemfile` file.\n* `npm` — Ensure node packages in the application’s `package.json` file.\n* `pip` — Ensure python pips in the application’s `requirements.txt` file.","in":"query","name":"type","required":true,"schema":{"enum":["gem","npm","pip"],"example":"npm","type":"string"}},{"description":"The application’s filepath.","in":"query","name":"app_path","required":true,"schema":{"example":"/home/example/my-app/","format":"path","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"ensure_deps","type":"string"},"module":{"description":"The name of the module called.","example":"PassengerApps","type":"string"},"result":{"properties":{"data":{"properties":{"sse_url":{"description":"The SSE URI to track the progress of the process.","example":"/sse/UserTasks/00000000_5c6c8b18228a35/ensure_deps.log","format":"url-path","type":"string"},"task_id":{"description":"The task id of the SSE process.","example":"00000000/5c76ec5566332c","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` - Success.\n- `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Install Passenger application dependencies","tags":["PassengerApps","Application Manager"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  PassengerApps \\\n  ensure_deps \\\n  type='npm' \\\n  app_path='/home/example/my-app/'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/PassengerApps/ensure_deps?type=npm&app_path=%2fhome%2fexample%2fmy-app%2f"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file PassengerApps_ensure_deps.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/PassengerApps_ensure_deps.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/PassengerApps/,\n    q/ensure_deps/,\n    {\n        'type' => 'npm',\n        'app_path' => '/home/example/my-app/',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file PassengerApps_ensure_deps.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/PassengerApps_ensure_deps.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'PassengerApps',\n    'ensure_deps',\n    array (\n        'type' => 'npm',\n        'app_path' => '/home/example/my-app/',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 80"}},"/PassengerApps/register_application":{"get":{"description":"This function registers a Passenger application for an account.\n\n**Important**:\n\n  * This function **only** registers an application. It does **not** create the application. You **must** create an application **before** you register the application. For an example of how to do this, read our [How to Create Ruby Web Applications](https://go.cpanel.net/howtocreaterubyapps) documentation.\n  * When you disable the [Web Server role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"register_application","parameters":[{"description":"The application’s name.","in":"query","name":"name","required":true,"schema":{"example":"Name of Application","maxLength":50,"minLength":1,"type":"string"}},{"description":"The application’s filepath relative to the user’s home directory.","in":"query","name":"path","required":true,"schema":{"example":"/slippers","format":"path","type":"string"}},{"description":"The domain for which to register the application.","in":"query","name":"domain","required":true,"schema":{"example":"dorothy.com","format":"domain","type":"string"}},{"description":"The type of server environment in which to run the application.\n\n  * `development` — Sets the application to run in a development environment.\n  * `production` — Sets the application to run in a production environment.","in":"query","name":"deployment_mode","required":false,"schema":{"default":"production","enum":["production","development"],"example":"production","type":"string"}},{"description":"Environment variables that the application needs.\n\n**Note**:\n\n  For each `envvar_name` parameter you send, you **must** include an `envvar_value` parameter.\n\n  This parameter's value can only contain letters, numbers, underscores, and dashes, and cannot begin with a number. This parameter's value must also not exceed 256 characters.","explode":true,"in":"query","name":"envvar_name","required":false,"schema":{"example":["SHOES","TINMAN"],"items":{"type":"string"},"maxLength":256,"type":"array"},"style":"form"},{"description":"Each environment variable’s value.\n\n**Note**:\n\n  For each `envvar_name` parameter you send, you **must** include an `envvar_value` parameter.\n\n  An environment variable value must contain 1024 or fewer ASCII-printable characters.","explode":true,"in":"query","name":"envvar_value","required":false,"schema":{"example":["ruby","heart"],"items":{"type":"string"},"maxLength":1024,"type":"array"},"style":"form"},{"description":"The application’s base URI.","in":"query","name":"base_uri","required":false,"schema":{"default":"/","example":"/ruby","format":"url-path","type":"string"}},{"description":"Whether to enable the application and generate the web server configuration for it.\n\n  * `1` — Enable the application and generate the web server configuration.\n  * `0` — Don’t enable the application and generate the web server configuration.","in":"query","name":"enabled","required":false,"schema":{"default":1,"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"register_application","type":"string"},"module":{"description":"The name of the module called.","example":"PassengerApps","type":"string"},"result":{"properties":{"data":{"additionalProperties":{"description":"The application’s configuration information.\n\n  **Note**:\n\n  The top-level key is the name of the application.\n\n  The value is the object defined here.","properties":{"base_uri":{"description":"The URI of the application.","format":"url-path","type":"string"},"deployment_mode":{"description":"The deployment mode of the application.\n\n  * `development` — Sets the application to run in a development environment.\n  * `production` — Sets the application to run in a production environment.","enum":["production","development"],"type":"string"},"domain":{"description":"The domain of the application.","type":"string"},"enabled":{"description":"Whether the application is enabled or not.\n\n  * `1` — Enabled.\n  * `0` — Disabled.","enum":[1,0],"type":"integer"},"envvars":{"description":"An object of the application’s environment variables and their values.","type":"object"},"name":{"description":"The name of the application.","type":"string"},"path":{"description":"The path of the application inside the user’s home directory.","format":"path","type":"string"}}},"description":"An object describing the newly-registered application.","example":{"Name of Application":{"base_uri":"/ruby","deployment_mode":"production","domain":"dorothy.com","enabled":1,"envvars":{"SHOES":"ruby","TINMAN":"heart"},"name":"Name of Application","path":"/home/dorothy/slippers"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` — Success.\n- `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Register Passenger application","tags":["PassengerApps","Application Manager"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  PassengerApps \\\n  register_application \\\n  name='Name of Application' \\\n  path='/slippers' \\\n  domain='dorothy.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/PassengerApps/register_application?name=Name%20of%20Application&path=%2fslippers&domain=dorothy.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file PassengerApps_register_application.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/PassengerApps_register_application.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/PassengerApps/,\n    q/register_application/,\n    {\n        'name' => 'Name of Application',\n        'path' => '/slippers',\n        'domain' => 'dorothy.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file PassengerApps_register_application.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/PassengerApps_register_application.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'PassengerApps',\n    'register_application',\n    array (\n        'name' => 'Name of Application',\n        'path' => '/slippers',\n        'domain' => 'dorothy.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 66"}},"/PassengerApps/unregister_application":{"get":{"description":"This function unregisters a [Passenger application](https://go.cpanel.net/cpaneldocsApplicationManager) on an account.\n\n**Note:**\n\n  * This function **only** unregisters an application. It does **not** delete the application. You **must** manually delete the application from your system.\n  * When you disable the [Web Server role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"unregister_application","parameters":[{"description":"The application to unregister.","in":"query","name":"name","required":true,"schema":{"example":"slippers","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"unregister_application","type":"string"},"module":{"description":"The name of the module called.","example":"PassengerApps","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Unregister Passenger application","tags":["PassengerApps","Application Manager"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  PassengerApps \\\n  unregister_application \\\n  name='slippers'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/PassengerApps/unregister_application?name=slippers"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file PassengerApps_unregister_application.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/PassengerApps_unregister_application.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/PassengerApps/,\n    q/unregister_application/,\n    {\n        'name' => 'slippers',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file PassengerApps_unregister_application.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/PassengerApps_unregister_application.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'PassengerApps',\n    'unregister_application',\n    array (\n        'name' => 'slippers',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 66"}},"/Mysql/delete_host":{"get":{"description":"This function removes a remote MySQL® host's access to the account's databases.\n\n**Important:**\n\nWhen you disable the [MySQL role](https://go.cpanel.net/serverroles) and remote MySQL is not already configured, the system **disables** this function.","operationId":"delete_host","parameters":[{"description":"The remote MySQL server's hostname, IP Address, or IP address range.\n\n**Note:**\nYou may use the following IP address formats:\n\n192.168.1.6 — IP address.\n192.168.%.% — Range with the percent (%) symbol as a wildcard.\n192.168.0.0/16 — Range in CIDR format.","in":"query","name":"host","required":true,"schema":{"example":"remote.example.com","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"delete_host","type":"string"},"module":{"description":"The name of the module called.","example":"Mysql","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Disable remote MySQL host access","tags":["Mysql","Remote Databases"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mysql \\\n  delete_host \\\n  host='remote.example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mysql/delete_host?host=remote.example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mysql_delete_host.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mysql_delete_host.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mysql/,\n    q/delete_host/,\n    {\n        'host' => 'remote.example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mysql_delete_host.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mysql_delete_host.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mysql',\n    'delete_host',\n    array (\n        'host' => 'remote.example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.52"}},"/Personalization/get":{"post":{"description":"This function retrieves the data from an NVData file on disk. cPanel\nNVData is a per-account configuration storage mechanism that you can use to\nmaintain persistent cPanel & WHM settings across multiple sessions. This includes\ncustom settings for your own themes and plugins.\n\n**Note:**\n\nNVData keys and values are limited to 128 and 2048 bytes, respectively.","operationId":"Personalization::get","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"example":{"names":["coffee","milk"]},"properties":{"names":{"description":"List of NVData keys to query the server about.","items":{"type":"string"},"type":"array"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get","type":"string"},"module":{"description":"The name of the module called.","example":"Personalization","type":"string"},"result":{"properties":{"data":{"example":{"coffee":{"reason":"OK","success":1,"value":"hot"},"milk":{"reason":"OK","success":1,"value":"cold"}},"properties":{"personalization":{"additionalProperties":{"properties":{"reason":{"description":"The message that describes the failure if `success` returns `0`, or `OK` if `success` returns `1`.","example":"OK","type":"string"},"success":{"description":"Whether the function successfully retrieved the value from the server.\n  - `1` — Successful.\n  - `0` — Unsuccessful.","enum":[0,1],"example":1,"type":"integer"},"value":{"description":"The value stored for the associated NVData key, or a null value if the key does not exist in the store.","nullable":true,"type":"string"}},"type":"object"},"description":"The retrieved NVData information stored on the server.\n\n**Note:**\n\n* You set this return's name based on the keys that you provide in the `personalization` parameter with the UAPI `Personalization::set` function.\n* This return's name is the NVData key's name."}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` — Success\n- `0` — Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Retrieve NVData data from file","tags":["Personalization"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"echo '{\"names\":[\"coffee\",\"milk\"]}' | \\\nuapi --input=json --output=jsonpretty \\\n  --user=username \\\n  Personalization \\\n  get"},{"label":"HTTP Request (Wire Format)","lang":"HTTP","source":"POST /cpsess##########/execute/Personalization/get HTTP/1.1\nHost: example.com:2083\nCookie: ###################################\nContent-Type: application/json\nContent-Length: 27\n\n{\"names\":[\"coffee\",\"milk\"]}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 74"}},"/PasswdStrength/get_required_strength":{"get":{"description":"This function retrieves an application's minimum required password strength.","operationId":"get_required_strength","parameters":[{"description":"The application's name.","in":"query","name":"app","required":true,"schema":{"enum":["cpaddons","createacct","ftp","htaccess","mysql","passwd","pop","postgres","sshkey","webdisk","virtual"],"example":"webdisk","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_required_strength","type":"string"},"module":{"description":"The name of the module called.","example":"PasswdStrength","type":"string"},"result":{"properties":{"data":{"properties":{"strength":{"description":"The application's minimum password strength.","example":0,"maximum":100,"minimum":0,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return minimum required password strength","tags":["PasswdStrength","Password Strength"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  PasswdStrength \\\n  get_required_strength \\\n  app='webdisk'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/PasswdStrength/get_required_strength?app=webdisk"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file PasswdStrength_get_required_strength.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/PasswdStrength_get_required_strength.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/PasswdStrength/,\n    q/get_required_strength/,\n    {\n        'app' => 'webdisk',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file PasswdStrength_get_required_strength.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/PasswdStrength_get_required_strength.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'PasswdStrength',\n    'get_required_strength',\n    array (\n        'app' => 'webdisk',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Personalization/set":{"post":{"description":"This function saves its data to an NVData file on disk. cPanel\nNVData is a per-account configuration storage mechanism that you can use to\nmaintain persistent cPanel & WHM settings across multiple sessions. This includes\ncustom settings for your own themes and plugins.\n\n**Note:**\n\nNVData keys and values are limited to 128 and 2048 bytes, respectively.","operationId":"Personalization-set","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"example":{"personalization":{"coffee":"hot","milk":"cold"}},"properties":{"personalization":{"additionalProperties":{"type":"string"},"description":"The NVData keys and values to update.","type":"object"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set","type":"string"},"module":{"description":"The name of the module called.","example":"Personalization","type":"string"},"result":{"properties":{"data":{"example":{"coffee":{"reason":"OK","success":1,"value":"hot"},"milk":{"reason":"OK","success":1,"value":"cold"}},"properties":{"personalization":{"additionalProperties":{"properties":{"reason":{"description":"The message that describes the failure if `success` returns `0`, or `OK` if `success` returns `1`.","example":"OK","type":"string"},"success":{"description":"Whether the function successfully saved the value on the server.\n  - `1` — Successful.\n  - `0` — Unsuccessful.","enum":[0,1],"example":1,"type":"integer"},"value":{"description":"The value stored for the associated NVData key, or a null value if the key does not exist in the store.","nullable":true,"type":"string"}},"type":"object"},"description":"The saved NVData information stored on the server.\n\n**Note:**\n\nYou set this return's name based on the keys that you provide in the `personalization` parameter."}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` — Success\n- `0` — Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Save NVData data to file","tags":["Personalization"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"echo '{\"personalization\":{\"coffee\":\"hot\",\"milk\":\"cold\"}}' | \\\nuapi --input=json --output=jsonpretty \\\n  --user=username \\\n  Personalization \\\n  set"},{"label":"HTTP Request (Wire Format)","lang":"HTTP","source":"POST /cpsess##########/execute/Personalization/set HTTP/1.1\nHost: example.com:2083\nCookie: ###################################\nContent-Type: application/json\nContent-Length: 50\n\n{\"personalization\":{\"coffee\":\"hot\",\"milk\":\"cold\"}}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 74"}},"/Postgresql/create_database":{"get":{"description":"This function creates a PostgreSQL® database.\n\n**Important:**\n\nWhen you disable the [PostgreSQL role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"Postgresql::create_database","parameters":[{"description":"The database's name.\n\n**Note**:\n\n  If database prefixing is enabled, this parameter **must** include the database prefix for the account.","in":"query","name":"name","required":true,"schema":{"example":"database","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"create_database","type":"string"},"module":{"description":"The name of the module called.","example":"Postgresql","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create PostgreSQL database","tags":["Postgresql","PostgreSQL Database Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Postgresql \\\n  create_database \\\n  name='database'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Postgresql/create_database?name=database"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Postgresql_create_database.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/Postgresql_create_database.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Postgresql/,\n    q/create_database/,\n    {\n        'name' => 'database',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Postgresql_create_database.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/Postgresql_create_database.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Postgresql',\n    'create_database',\n    array (\n        'name' => 'database',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Postgresql/create_user":{"get":{"description":"This function creates a PostgreSQL® database user.\n\n**Important:**\n\nWhen you disable the [*PostgreSQL* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"create_user","parameters":[{"description":"The database user's name.\n\n**Note:**\n\nIf database prefixing is enabled, this parameter **must** include the database prefix for the account.","in":"query","name":"name","required":true,"schema":{"example":"dbuser","type":"string"}},{"description":"The new user's password.","in":"query","name":"password","required":true,"schema":{"example":"123456luggage","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"create_user","type":"string"},"module":{"description":"The name of the module called.","example":"Postgresql","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create PostgreSQL user","tags":["Postgresql","PostgreSQL User Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Postgresql \\\n  create_user \\\n  name='dbuser' \\\n  password='123456luggage'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Postgresql/create_user?name=dbuser&password=123456luggage"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Postgresql_create_user.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/Postgresql_create_user.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Postgresql/,\n    q/create_user/,\n    {\n        'name' => 'dbuser',\n        'password' => '123456luggage',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Postgresql_create_user.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/Postgresql_create_user.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Postgresql',\n    'create_user',\n    array (\n        'name' => 'dbuser',\n        'password' => '123456luggage',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Postgresql/delete_user":{"get":{"description":"This function deletes a PostgreSQL® user.\n\n**Important:**\n\n  When you disable the [PostgreSQL role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"Postgresql::delete_user","parameters":[{"description":"The PostgreSQL user's name.","in":"query","name":"name","required":true,"schema":{"example":"example","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"delete_user","type":"string"},"module":{"description":"The name of the module called.","example":"Postgresql","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"*`1` - Success.\n*`0` - Failed. Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete PostgreSQL user","tags":["Postgresql","PostgreSQL User Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Postgresql \\\n  delete_user \\\n  name='example'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Postgresql/delete_user?name=example"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Postgresql_delete_user.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/Postgresql_delete_user.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Postgresql/,\n    q/delete_user/,\n    {\n        'name' => 'example',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Postgresql_delete_user.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/Postgresql_delete_user.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Postgresql',\n    'delete_user',\n    array (\n        'name' => 'example',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 84"}},"/Postgresql/grant_all_privileges":{"get":{"description":"This function grants all privileges for a PostgreSQL® database to a database user.\n\n**Important:**\n\nWhen you disable the [*PostgreSQL* role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"grant_all_privileges","parameters":[{"description":"The database user's name.\n\n**Note**\n\nIf database prefixing is enabled, this value **must** include the database prefix for the account.","in":"query","name":"user","required":true,"schema":{"example":"example_dbuser","type":"string"}},{"description":"The database's name.\n\n**Note**\n\nIf database prefixing is enabled, this value **must** include the database prefix for the account.","in":"query","name":"database","required":true,"schema":{"example":"example_database","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"grant_all_privileges","type":"string"},"module":{"description":"The name of the module called.","example":"Postgresql","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable all user privileges on PostgreSQL database","tags":["Postgresql","PostgreSQL User Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Postgresql \\\n  grant_all_privileges \\\n  user='example_dbuser' \\\n  database='example_database'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Postgresql/grant_all_privileges?user=example_dbuser&database=example_database"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Postgresql_grant_all_privileges.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/Postgresql_grant_all_privileges.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Postgresql/,\n    q/grant_all_privileges/,\n    {\n        'user' => 'example_dbuser',\n        'database' => 'example_database',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Postgresql_grant_all_privileges.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/Postgresql_grant_all_privileges.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Postgresql',\n    'grant_all_privileges',\n    array (\n        'user' => 'example_dbuser',\n        'database' => 'example_database',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Postgresql/get_restrictions":{"get":{"description":"This function retrieves the PostgreSQL® user and database name length restrictions.\n\n**Important:**\n\nWhen you disable the [*PostgreSQL* role](https://go.cpanel.net/serverroles), the system **disables** this function.      ","operationId":"Postgresql::get_restrictions","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_restrictions","type":"string"},"module":{"description":"The name of the module called.","example":"Postgresql","type":"string"},"result":{"properties":{"data":{"properties":{"max_database_name_length":{"description":"The maximum length of a database name.","example":63,"minimum":1,"type":"integer"},"max_username_length":{"description":"The maximum length of a database username.","example":63,"minimum":1,"type":"integer"},"prefix":{"description":"If database prefixing is enabled, this return outputs the database prefix. A valid string up to eight characters and an underscore (`_`).","example":"example_","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return PostgreSQL name length restrictions","tags":["Postgresql","PostgreSQL Database Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Postgresql \\\n  get_restrictions\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Postgresql/get_restrictions"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Postgresql_get_restrictions.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/Postgresql_get_restrictions.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Postgresql/,\n    q/get_restrictions/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Postgresql_get_restrictions.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/Postgresql_get_restrictions.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Postgresql',\n    'get_restrictions'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Postgresql/delete_database":{"get":{"description":"This function deletes a PostgreSQL® database.\n\n**Important:**\n\n  When you disable the [Postgres role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"Postgresql::delete_database","parameters":[{"description":"The database's name.","in":"query","name":"name","required":true,"schema":{"example":"database","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"delete_database","type":"string"},"module":{"description":"The name of the module called.","example":"Postgresql","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete PostgreSQL database","tags":["Postgresql","PostgreSQL Database Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Postgresql \\\n  delete_database \\\n  name='database'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Postgresql/delete_database?name=database"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Postgresql_delete_database.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/Postgresql_delete_database.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Postgresql/,\n    q/delete_database/,\n    {\n        'name' => 'database',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Postgresql_delete_database.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/Postgresql_delete_database.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Postgresql',\n    'delete_database',\n    array (\n        'name' => 'database',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/Postgresql/list_databases":{"get":{"description":"This function lists an account's PostgreSQL® databases.\n\n**Important:**\n\n  When you disable the [*Postgres* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"Postgresql-list_databases","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_databases","type":"string"},"module":{"description":"The name of the module called.","example":"Postgresql","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"database":{"description":"The database name.","example":"user_db","type":"string"},"disk_usage":{"description":"The disk space that the database uses, in bytes.","example":673,"type":"integer"},"users":{"description":"An array of database usernames.\n\n**Note:**\n\n  If no users exist on a database, the function returns an empty array","items":{"example":"db_user","type":"string"},"minimum":0,"type":"array"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return PostgreSQL databases","tags":["Postgresql","PostgreSQL Database Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Postgresql \\\n  list_databases\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Postgresql/list_databases"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Postgresql_list_databases.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/Postgresql_list_databases.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Postgresql/,\n    q/list_databases/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Postgresql_list_databases.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/Postgresql_list_databases.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Postgresql',\n    'list_databases'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 84"}},"/Postgresql/list_users":{"get":{"description":"This function lists an account's PostgreSQL® database users.\n\n**Important:**\n\nWhen you disable the [*PostgreSQL* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"Postgresql::list_users","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_users","type":"string"},"module":{"description":"The name of the module called.","example":"Postgresql","type":"string"},"result":{"properties":{"data":{"description":"An array of strings which are PostgreSQL database usernames.","example":["example_user1","example_user2"],"items":{"example":"example_user1","type":"string"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return PostgreSQL users","tags":["Postgresql","PostgreSQL User Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Postgresql \\\n  list_users\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Postgresql/list_users"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Postgresql_list_users.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/Postgresql_list_users.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Postgresql/,\n    q/list_users/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Postgresql_list_users.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/Postgresql_list_users.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Postgresql',\n    'list_users'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 84"}},"/Postgresql/rename_database":{"get":{"description":"This function renames a PostgreSQL® database.\n\n**Important:**\n\nWhen you disable the [*PostgreSQL* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"rename_database","parameters":[{"description":"The database's current name.\n\n**Note:**\n\nIf database prefixing is enabled, this parameter **must** include the database prefix for the account.","in":"query","name":"oldname","required":true,"schema":{"example":"database","type":"string"}},{"description":"The database's new name.\n\n**Note:**\n\nIf database prefixing is enabled, this parameter **must** include the database prefix for the account.","in":"query","name":"newname","required":true,"schema":{"example":"database2","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"rename_database","type":"string"},"module":{"description":"The name of the module called.","example":"Postgresql","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update PostgreSQL database name","tags":["Postgresql","PostgreSQL Database Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Postgresql \\\n  rename_database \\\n  oldname='database' \\\n  newname='database2'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Postgresql/rename_database?oldname=database&newname=database2"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Postgresql_rename_database.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/Postgresql_rename_database.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Postgresql/,\n    q/rename_database/,\n    {\n        'oldname' => 'database',\n        'newname' => 'database2',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Postgresql_rename_database.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/Postgresql_rename_database.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Postgresql',\n    'rename_database',\n    array (\n        'oldname' => 'database',\n        'newname' => 'database2',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Postgresql/rename_user_no_password":{"get":{"description":"This function renames a PostgreSQL® database user.\n\n**Warning:**\n\n* If you rename a PostgreSQL user, you **must** set the password for the database user. This is required because of the md5 hash that PostgreSQL creates to store user passwords.\n* We **strongly** recommend that you use the `Postgresql::rename_user function` instead of this one.\n\n**Important:**\n\nWhen you disable the  [*PostgreSQL* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"rename_user_no_password","parameters":[{"description":"The database user's current name.\n\n**Note:**\n\nIf database prefixing is enabled, this parameter **must** include the database prefix for the account.","in":"query","name":"oldname","required":true,"schema":{"example":"dbuser","type":"string"}},{"description":"The database user's new name.\n\n**Note:**\n\nIf database prefixing is enabled, this parameter **must** include the database prefix for the account.","in":"query","name":"newname","required":true,"schema":{"example":"dbuser2","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"rename_user_no_password","type":"string"},"module":{"description":"The name of the module called.","example":"Postgresql","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update PostgreSQL username without password","tags":["Postgresql","PostgreSQL User Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Postgresql \\\n  rename_user_no_password \\\n  oldname='dbuser' \\\n  newname='dbuser2'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Postgresql/rename_user_no_password?oldname=dbuser&newname=dbuser2"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Postgresql_rename_user_no_password.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/Postgresql_rename_user_no_password.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Postgresql/,\n    q/rename_user_no_password/,\n    {\n        'oldname' => 'dbuser',\n        'newname' => 'dbuser2',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Postgresql_rename_user_no_password.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/Postgresql_rename_user_no_password.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Postgresql',\n    'rename_user_no_password',\n    array (\n        'oldname' => 'dbuser',\n        'newname' => 'dbuser2',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Postgresql/revoke_all_privileges":{"get":{"description":"This function revokes all privileges for a PostgreSQL® database from a database user.\n\n**Important:**\n\nWhen you disable the [*PostgreSQL* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"revoke_all_privileges","parameters":[{"description":"The database user's name.\n\n**Note**\n\nIf database prefixing is enabled, this value **must** include the database prefix for the account.","in":"query","name":"user","required":true,"schema":{"example":"example_dbuser","type":"string"}},{"description":"The database's name.\n\n**Note**\n\nIf database prefixing is enabled, this value **must** include the database prefix for the account.","in":"query","name":"database","required":true,"schema":{"example":"example_database","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"revoke_all_privileges","type":"string"},"module":{"description":"The name of the module called.","example":"Postgresql","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove PostgreSQL user privileges","tags":["Postgresql","PostgreSQL User Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Postgresql \\\n  revoke_all_privileges \\\n  user='example_dbuser' \\\n  database='example_database'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Postgresql/revoke_all_privileges?user=example_dbuser&database=example_database"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Postgresql_revoke_all_privileges.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/Postgresql_revoke_all_privileges.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Postgresql/,\n    q/revoke_all_privileges/,\n    {\n        'user' => 'example_dbuser',\n        'database' => 'example_database',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Postgresql_revoke_all_privileges.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/Postgresql_revoke_all_privileges.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Postgresql',\n    'revoke_all_privileges',\n    array (\n        'user' => 'example_dbuser',\n        'database' => 'example_database',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Postgresql/set_password":{"get":{"description":"This function changes a PostgreSQL® database user's password.\n\n**Important:**\n\n  When you disable the [Postgres role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"set_password","parameters":[{"description":"The database user's name.\n\n**Note:**\n\nIf database prefixing is enabled, this parameter **must** include the database prefix for the account.","in":"query","name":"user","required":true,"schema":{"example":"dbuser","type":"string"}},{"description":"The user's new password.","in":"query","name":"password","required":true,"schema":{"example":"12345luggage","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_password","type":"string"},"module":{"description":"The name of the module called.","example":"Postgresql","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update PostgreSQL user password","tags":["Postgresql","PostgreSQL User Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Postgresql \\\n  set_password \\\n  user='dbuser' \\\n  password='12345luggage'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Postgresql/set_password?user=dbuser&password=12345luggage"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Postgresql_set_password.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/Postgresql_set_password.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Postgresql/,\n    q/set_password/,\n    {\n        'user' => 'dbuser',\n        'password' => '12345luggage',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Postgresql_set_password.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/Postgresql_set_password.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Postgresql',\n    'set_password',\n    array (\n        'user' => 'dbuser',\n        'password' => '12345luggage',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Postgresql/rename_user":{"get":{"description":"This function renames a PostgreSQL® database user.\n\n**Important:**\n\nWhen you disable the [*PostgreSQL* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"Postgresql::rename_user","parameters":[{"description":"The database user's current name.\n\n**Note:**\n\nIf database prefixing is enabled, this parameter **must** include the database prefix for the account.","in":"query","name":"oldname","required":true,"schema":{"example":"dbuser","type":"string"}},{"description":"The database user's new name.\n\n**Note:**\n\nIf database prefixing is enabled, this parameter **must** include the database prefix for the account.","in":"query","name":"newname","required":true,"schema":{"example":"dbuser2","type":"string"}},{"description":"The database user's new password.","in":"query","name":"password","required":true,"schema":{"example":"123456luggage","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"rename_user","type":"string"},"module":{"description":"The name of the module called.","example":"Postgresql","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update PostgreSQL username","tags":["Postgresql","PostgreSQL User Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Postgresql \\\n  rename_user \\\n  oldname='dbuser' \\\n  newname='dbuser2' \\\n  password='123456luggage'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Postgresql/rename_user?oldname=dbuser&newname=dbuser2&password=123456luggage"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Postgresql_rename_user.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/Postgresql_rename_user.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Postgresql/,\n    q/rename_user/,\n    {\n        'oldname' => 'dbuser',\n        'newname' => 'dbuser2',\n        'password' => '123456luggage',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Postgresql_rename_user.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/Postgresql_rename_user.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Postgresql',\n    'rename_user',\n    array (\n        'oldname' => 'dbuser',\n        'newname' => 'dbuser2',\n        'password' => '123456luggage',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Pushbullet/send_test_message":{"get":{"description":"This function sends a Pushbullet™ test message to determine that the token is valid and that the account holder can receive the message.","operationId":"send_test_message","parameters":[{"description":"The Pushbullet access token.\n\n**Note:**\n\n* Your Pushbullet token is available on\n[Pushbullet's My Account](https://www.pushbullet.com/account) page under\nthe *Access Token* heading.\n* This is confidential information that your server sends via a secure channel.","in":"query","name":"access_token","required":true,"schema":{"example":"a1b2c3d4e5f6g7h8i9j0","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"send_test_message","type":"string"},"module":{"description":"The name of the module called.","example":"Pushbullet","type":"string"},"result":{"properties":{"data":{"properties":{"message_id":{"description":"The test message's ID.","example":"554d2cbd-efe61da3cacb","type":"string"},"payload":{"description":"The payload from the Pushbullet server. For more information, read\n[Pushbullet's API documentation](https://docs.pushbullet.com/).\n\n**Warning:**\n\nThis return may contain values that are Boolean primitives. JSON\nproperly represents these, but XML represents them as `0` or `1`.","example":{"active":true,"body":"This message confirms that “hostname.example.com“ (192.168.0.20)\ncan send a message to you via Pushbullet.\n\nThis message was sent on Monday, May 18, 2015 at 7:12:20 PM UTC.","created":1431976341.38872,"direction":"self","dismissed":false,"iden":"ujw5ScArtjUsjAeRXXMLGS","modified":1431976341.39182,"receiver_email":"user@example.com","receiver_email_normalized":"user@example.com","receiver_iden":"ujw5ScArtjU","sender_email":"user@example.com","sender_email_normalized":"user@example.com","sender_iden":"ujw5ScArtjU","sender_name":"Firstname Lastname","title":"Test message (ID: 555a3994-173a4a271062d)","type":"note"},"type":"object"}}},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Validate Pushbullet token","tags":["Pushbullet"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Pushbullet \\\n  send_test_message \\\n  access_token='a1b2c3d4e5f6g7h8i9j0'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Pushbullet/send_test_message?access_token=a1b2c3d4e5f6g7h8i9j0"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Pushbullet_send_test_message.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/Pushbullet_send_test_message.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Pushbullet/,\n    q/send_test_message/,\n    {\n        'access_token' => 'a1b2c3d4e5f6g7h8i9j0',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Pushbullet_send_test_message.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/Pushbullet_send_test_message.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Pushbullet',\n    'send_test_message',\n    array (\n        'access_token' => 'a1b2c3d4e5f6g7h8i9j0',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.52"}},"/Quota/get_local_quota_info":{"get":{"description":"This function retrieves the cPanel account's quota for the server where you run the function. For example, a [distributed cPanel account](https://go.cpanel.net/glossaryD) could approach its quota. The servers will balance that cPanel user's quota between the parent and the child node.\n\n**Note:**\n\n  This function runs on **only** the local server. To retrieve the cPanel account's total quota, use the UAPI `Quota::get_quota` function instead.","operationId":"get_local_quota_info","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_local_quota_info","type":"string"},"module":{"description":"The name of the module called.","example":"Quota","type":"string"},"result":{"properties":{"data":{"properties":{"byte_limit":{"description":"The limit for disk space the cPanel account may use on this server, in bytes.\n* A positive integer.\n* `0` - Unlimited or disabled server quotas.\n\n**Note:**\n\n This value does **not** update immediately.","example":262144000,"minimum":0,"type":"integer"},"bytes_used":{"description":"The amount of disk space the cPanel account uses on this server, in bytes.\n* A positive integer.\n* `0` - No usage or disabled server quotas.","example":4149284,"minimum":0,"type":"integer"},"inode_limit":{"description":"The limit for inodes that the cPanel account may use on this server.\n* A positive integer.\n* `0` - Unlimited or disabled server quotas.","example":0,"minimum":0,"type":"integer"},"inodes_used":{"description":"The number of inodes that the cPanel account uses on this server.\n* A positive integer.\n* `0` - No usage or disabled server quotas.","example":1035,"minimum":0,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return local disk quota information","tags":["Quota","Disk Quotas"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Quota \\\n  get_local_quota_info\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Quota/get_local_quota_info"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Quota_get_local_quota_info.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/Quota_get_local_quota_info.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Quota/,\n    q/get_local_quota_info/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Quota_get_local_quota_info.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/Quota_get_local_quota_info.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Quota',\n    'get_local_quota_info'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 88"}},"/Quota/get_quota_info":{"get":{"description":"This function retrieves the cPanel account's quota.","operationId":"get_quota_info","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_quota_info","type":"string"},"module":{"description":"The name of the module called.","example":"Quota","type":"string"},"result":{"properties":{"data":{"description":"An object containing the cPanel account's quota.","properties":{"inode_limit":{"description":"The account's inode quota limit.\n\n* `0` — Unlimited or disabled server quotas.","example":0,"oneOf":[{"description":"Unlimited or disabled server quotas.","enum":[0],"type":"integer"},{"description":"A positive integer.","minimum":1,"type":"integer"}]},"inodes_remain":{"description":"The account's available inode quota.\n\n* `0` — Unlimited or disabled server quotas.","example":0,"oneOf":[{"description":"Unlimited or disabled server quotas.","enum":[0],"type":"integer"},{"description":"A positive integer.","minimum":1,"type":"integer"}]},"inodes_used":{"description":"The account's number of used inodes.\n\n* `0` — No usage or disabled server quotas.","example":1035,"oneOf":[{"description":"No usage or disabled server quotas.","enum":[0],"type":"integer"},{"description":"A positive integer.","minimum":1,"type":"integer"}]},"megabyte_limit":{"description":"The account's disk space limit, in megabytes (MB).\n\n* `0.00` — Unlimited or disabled server quotas.","example":0,"oneOf":[{"description":"Unlimited or disabled server quotas.","enum":[0],"type":"number"},{"description":"A decimal number.","minimum":1,"type":"number"}]},"megabytes_remain":{"description":"The account's available disk space in, megabytes (MB).\n\n* `0.00` — Unlimited or disabled server quotas.","example":0,"oneOf":[{"description":"Unlimited or disabled server quotas.","enum":[0],"type":"number"},{"description":"A decimal number.","minimum":1,"type":"number"}]},"megabytes_used":{"description":"The account's used disk space, in megabytes (MB).\n\n* `0.00` — No usage or disabled server quotas.","example":5.46,"oneOf":[{"description":"Unlimited or disabled server quotas.","enum":[0],"type":"number"},{"description":"A decimal number.","minimum":1,"type":"number"}]},"under_inode_limit":{"description":"Whether the account is under its inode limit.\n\n* `1` — Under limit.\n* `0` — Over limit.","enum":[1,0],"example":0,"type":"integer"},"under_megabyte_limit":{"description":"Whether the account is under its disk space limit, in megabytes (MB).\n\n* `1` — Under limit.\n* `0` — Over limit.","enum":[1,0],"example":1,"type":"integer"},"under_quota_overall":{"description":"Whether the account is under both its inode and disk megabyte (MB) limit.\n\n* `1` — Under limit.\n* `0` — Over limit.","enum":[1,0],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return disk quota information","tags":["Quota","Disk Quotas"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Quota \\\n  get_quota_info\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Quota/get_quota_info"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Quota_get_quota_info.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/Quota_get_quota_info.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Quota/,\n    q/get_quota_info/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Quota_get_quota_info.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/Quota_get_quota_info.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Quota',\n    'get_quota_info'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 56"}},"/Resellers/list_accounts":{"get":{"description":"This function lists all of a reseller's cPanel accounts.","operationId":"list_accounts","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_accounts","type":"string"},"module":{"description":"The name of the module called.","example":"Resellers","type":"string"},"result":{"properties":{"data":{"description":"An array of objects containing the reseller's cPanel accounts.","items":{"properties":{"domain":{"description":"The cPanel account's domain.","example":"example.com","format":"domain","type":"string"},"select":{"description":"Whether the cPanel account's user is currently logged in.\n\n* `1` — Logged in.\n* An empty string — **Not** logged in.","enum":["1",""],"example":"1","type":"string"},"user":{"description":"The cPanel account's username.","example":"username","format":"username","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return reseller's cPanel accounts","tags":["Resellers","Account Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Resellers \\\n  list_accounts\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Resellers/list_accounts"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Resellers_list_accounts.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/Resellers_list_accounts.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Resellers/,\n    q/list_accounts/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Resellers_list_accounts.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/Resellers_list_accounts.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Resellers',\n    'list_accounts'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11"}},"/Restore/directory_listing":{"get":{"description":"This function lists all of the backup files and directories in the user's home directory.\n\n**Important:**\n\nWhen you disable the [File Storage role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"directory_listing","parameters":[{"description":"A path to a subdirectory within the user's home directory, or any level below it.\n\n**Note:**\n\nThe value of this parameter **must** begin and end with a forward slash (`/`) for security purposes.","in":"query","name":"path","required":true,"schema":{"example":"/public_html/","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"directory_listing","type":"string"},"module":{"description":"The name of the module called.","example":"Restore","type":"string"},"result":{"properties":{"data":{"description":"An object that contains information about a specific item stored in the backup.","items":{"properties":{"conflict":{"description":"Whether a difference exists between the `type` and `onDiskType` returns.\n* `1` - Conflict exists.\n* `0` - **No** conflict exists.","enum":[0,1],"example":0,"type":"integer"},"exists":{"description":"Whether the file exists in the user's directory or **only** in the backup.\n* `1` - File exists in the user's directory.\n* `0` - File exists **only** in the backup.","enum":[0,1],"example":1,"type":"integer"},"name":{"description":"The name of the file or directory.","example":"public_html","type":"string"},"onDiskType":{"description":"The item type stored on the disk.\n* `dir` - A directory.\n* `file` - A file.\n* `symlink` - A symlink.\n* `unknown` - An unknown file type.","enum":["dir","file","symlink","unknown"],"example":"file","type":"string"},"type":{"description":"The item type stored in the backup.\n* `dir` - A directory.\n* `file` - A file.\n* `symlink` - A symlink.\n* `unknown` - An unknown file type.","enum":["dir","file","symlink","unknown"],"example":"file","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}}}}},"description":"HTTP Request was successful."}},"summary":"Return backups in home directory","tags":["File Restoration"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Restore \\\n  directory_listing \\\n  path='/public_html/'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Restore/directory_listing?path=%2fpublic_html%2f"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Restore_directory_listing.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/Restore_directory_listing.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Restore/,\n    q/directory_listing/,\n    {\n        'path' => '/public_html/',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Restore_directory_listing.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/Restore_directory_listing.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Restore',\n    'directory_listing',\n    array (\n        'path' => '/public_html/',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 68"}},"/ResourceUsage/get_usages":{"get":{"description":"This function retrieves resource usage and custom statistics for a cPanel user account.","operationId":"get_usages","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_usages","type":"string"},"module":{"description":"The name of the module called.","example":"ResourceUsage","type":"string"},"result":{"properties":{"data":{"description":"An array of objects containing resource usage information from the account's query.","items":{"properties":{"description":{"description":"The resource's UI display name.","example":"MySQL® Databases","type":"string"},"error":{"description":"An error message, if applicable.","example":null,"nullable":true,"type":"string"},"formatter":{"description":"The resource's defined output format.\n\n* `format_bytes`\n* `format_bytes_per_second`\n* `percent`\n* `null` — No defined output format.\n\n**Note:**\n\nThird-party modules will return their defined formatter value.","example":"format_bytes","oneOf":[{"description":"The resource's defined output format.","enum":["format_bytes","format_bytes_per_second","percent"],"nullable":true,"type":"string"},{"description":"A third-party module's defined formatter value.","type":"string"}]},"id":{"description":"The resource's reference name.\n* `disk_usage`\n* `filesusage` - This function **only** returns this value if the *Display File Usage information in the cPanel stats bar* setting is enabled in the *Display* section of WHM's [*Tweak Settings*](https://go.cpanel.net/whmdocsTweakSettings#display) interface (*WHM >> Home >> Server Configuration >> Tweak Settings*).\n* `cachedmysqldiskusage`\n* `cachedpostgresdiskusage` - This function **only** returns this value if [PostgreSQL® databases](https://go.cpanel.net/cpaneldocsPostgreSQLDatabases) are enabled.\n* `bandwidth`\n* `addon_domains`\n* `subdomains`\n* `aliases`\n* `email_accounts`\n* `mailing_lists` - This function **only** returns this value if the Mailman service is enabled in WHM's [*Service Manager*](https://go.cpanel.net/whmdocsServiceManager) interface (*WHM >> Home >> Service Configuration >> Service Manager*).\n* `autoresponders`\n* `forwarders`\n* `email_filters`\n* `ftp_accounts` - This function **only** returns this value if FTP accounts exist on the server.\n* `mysql_databases` - This function **only** returns this value if MySQL® databases are enabled.\n* `postgresql_databases`\n\n**Note:**\n\nCertain `id` values may **not** appear, based on the [server's current profile](https://go.cpanel.net/howtouseserverprofiles#profiles).","example":"mysql_databases","type":"string"},"maximum":{"description":"The resources's maximum usage value.\n\n**Note:**\n\n This function returns an null value for an (unlimited) quota.","example":15,"minimum":0,"nullable":true,"type":"integer"},"url":{"description":"The resource's defined URL link to its corresponding interface, in applicable.","example":"sql/index.html","format":"url-path","type":"string"},"usage":{"description":"The resource's current usage value.","example":0,"minimum":0,"type":"integer"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` - Success.\n- `0` - Failed. Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return resource usage and custom statistics","tags":["ResourceUsage","Resource Usage and Statistics"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  ResourceUsage \\\n  get_usages\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/ResourceUsage/get_usages"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file ResourceUsage_get_usages.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/ResourceUsage_get_usages.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/ResourceUsage/,\n    q/get_usages/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file ResourceUsage_get_usages.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/ResourceUsage_get_usages.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'ResourceUsage',\n    'get_usages'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 70"}},"/Restore/get_users":{"get":{"description":"This function lists a reseller's users that have existing backup metadata.\n\n**Note:**\n\nWhen you disable the [File Storage role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"get_users","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_users","type":"string"},"module":{"description":"The name of the module called.","example":"Restore","type":"string"},"result":{"properties":{"data":{"description":"An array of reseller account names.","items":{"example":"username","format":"username","type":"string"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel accounts with backup metadata","tags":["File Restoration"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Restore \\\n  get_users\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Restore/get_users"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Restore_get_users.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/Restore_get_users.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Restore/,\n    q/get_users/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Restore_get_users.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/Restore_get_users.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Restore',\n    'get_users'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 72"}},"/Restore/query_file_info":{"get":{"description":"This function lists all of an item's backup locations. An item can be a file, a directory, or a symlink.\n\n**Important:**\n\nWhen you disable the [File Storage role](https://go.cpanel.net/serverroles#roles), the system **disables** this function.","operationId":"query_file_info","parameters":[{"description":"A file, directory, or symlink in the user's directory tree.\n\n**Note:**\n\nThe value of this parameter **must** begin with a forward slash (`/`).","in":"query","name":"path","required":true,"schema":{"example":"/public_html/index.php","format":"path","type":"string"}},{"description":"Whether to show the `exist` return, which indicates whether the item exists in the\nlocal disk or only in the backup.\n\n* `1` — Show the `exist` return's value.\n* `0` — Do **not** show the `exists` return's value.","in":"query","name":"exists","required":false,"schema":{"default":0,"enum":[1,0],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"query_file_info","type":"string"},"module":{"description":"The name of the module called.","example":"Restore","type":"string"},"result":{"properties":{"data":{"description":"An array of objects containing the item's details.","items":{"properties":{"backupDate":{"description":"The date when the system created the backup.","example":"2020-07-01","format":"ISO-8601 Date","type":"string"},"backupID":{"anyOf":[{"description":"A daily backup file from a specified backup date.","format":"ISO-8601 Date","type":"string"},{"description":"An incremental daily backup.","enum":["incremental"],"type":"string"},{"description":"A weekly or monthly incremental backup.","enum":["weekly/incremental","monthly/incremental"],"type":"string"},{"description":"A weekly or monthly backup from a specified backup date.","type":"string"}],"description":"The backup's identification.\n\n* A date, in `YYYY-MM-DD` format.\n* `incremental` — An incremental daily backup.\n* The backup frequency (`weekly` or `monthly`) , a slash character (`/`), and the value `incremental`.\n* The backup frequency (`weekly` or `monthly`), a slash character (`/`), and the backup date, in `YYYY-MM-DD` format.","example":"weekly/2017-07-01","type":"string"},"backupType":{"description":"The backup type.\n\n* `compressed` —  A compressed tar file.\n* `incremental` — A full tree of files and directories.\n* `uncompressed` — An uncompressed tar file.","enum":["compressed","incremental","uncompressed"],"example":"compressed","type":"string"},"exists":{"description":"Whether the item (a file, a directory, or a symlink) exists in the local disk or only in the backup.\n\n* `1` — The item exists in the local disk.\n* `0` — The item exists only in the backup.\n\n**Note:**\n\nThis return appears **only** if you set the `exists` parameter to `1`.","enum":[1,0],"example":1,"type":"integer"},"fileSize":{"description":"The size, in bytes, of the file in the backup.\n\n**Note:**\n\nThe function returns this value **only** if the item is a file.","example":199,"minimum":0,"type":"integer"},"mtime":{"description":"The file's last modification time.","example":1520043240,"format":"unix_timestamp","type":"integer"},"path":{"description":"The identical file path value that the system passed in the function.","example":"/public_html/index.php","format":"path","type":"string"},"type":{"description":"The item type stored in the backup.\n\n* `dir` — A directory.\n* `file` — A file.\n* `symlink` — A symlink.\n* `unknown` — An unknown file type.","enum":["dir","file","symlink","unknown"],"example":"file","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return backup storage locations","tags":["File Restoration"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Restore \\\n  query_file_info \\\n  path='/public_html/index.php'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Restore/query_file_info?path=%2fpublic_html%2findex.php"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Restore_query_file_info.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/Restore_query_file_info.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Restore/,\n    q/query_file_info/,\n    {\n        'path' => '/public_html/index.php',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Restore_query_file_info.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/Restore_query_file_info.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Restore',\n    'query_file_info',\n    array (\n        'path' => '/public_html/index.php',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 68"}},"/SSH/get_port":{"get":{"description":"This function retrieves the server's SSH port.","operationId":"SSH-get_port","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_port","type":"string"},"module":{"description":"The name of the module called.","example":"SSH","type":"string"},"result":{"properties":{"data":{"properties":{"port":{"description":"The server's SSH port.","example":22,"maximum":65535,"minimum":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return SSH port","tags":["SSH"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSH \\\n  get_port\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSH/get_port"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSH_get_port.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSH_get_port.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSH/,\n    q/get_port/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSH_get_port.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSH_get_port.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSH',\n    'get_port'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Restore/restore_file":{"get":{"description":"This function restores a file or directory from a backup to the file or directory's original location.\n\n**Important:**\n\nWhen you disable the [File Storage role](https://go.cpanel.net/serverroles#roles), the system **disables** this function.","operationId":"restore_file","parameters":[{"description":"The backup's identification.\n\n* `YYYY-MM-DD` — Restore a daily backup from the specified backup date.\n* `incremental` — Restore a daily incremental backup.\n* `weekly/YYYY-MM-DD` — Restore a weekly backup from the specified backup date.\n* `monthly/YYYY-MM-DD` — Restore a monthly backup from the specified backup date.\n* `weekly/incremental` — Restore a weekly incremental backup.\n* `monthly/incremental` — Restore a monthly incremental backup.","in":"query","name":"backupID","required":true,"schema":{"anyOf":[{"description":"A daily backup file from a specified backup date.","format":"ISO-8601 Date","type":"string"},{"description":"An incremental daily backup.","enum":["incremental"],"type":"string"},{"description":"A weekly or monthly incremental backup.","enum":["weekly/incremental","monthly/incremental"],"type":"string"},{"description":"A weekly or monthly backup from a specified backup date.","type":"string"}],"example":"weekly/2017-07-03"}},{"description":"The absolute file or directory's path, within a backup, that you wish to restore.\n\n**Important:**\n\n* The value of this parameter **must** begin with a forward slash (/).\n* You **must** parse filenames properly to prevent a cross-site scripting (XSS) attack.","in":"query","name":"path","required":true,"schema":{"example":"/public_html/index.php","format":"path","type":"string"}},{"description":"Whether to overwrite the file or directory on the disc with its backup replacement.\n\n* `1` — Overwrite the file or directory.\n* `0` — Do **not** overwrite the file or directory.","in":"query","name":"overwrite","required":true,"schema":{"enum":[1,0],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"restore_file","type":"string"},"module":{"description":"The name of the module called.","example":"Restore","type":"string"},"result":{"properties":{"data":{"description":"An object containing the status of the operation.","properties":{"success":{"description":"Whether the `overwrite` parameter succeeded.\n\n* `1` — Success.\n* `0` — Failure.","enum":[1,0],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Restore file or directory","tags":["File Restoration"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Restore \\\n  restore_file \\\n  backupID='weekly/2017-07-03' \\\n  path='/public_html/index.php' \\\n  overwrite='1'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Restore/restore_file?backupID=weekly%2f2017-07-03&path=%2fpublic_html%2findex.php&overwrite=1"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Restore_restore_file.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/Restore_restore_file.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Restore/,\n    q/restore_file/,\n    {\n        'backupID' => 'weekly/2017-07-03',\n        'path' => '/public_html/index.php',\n        'overwrite' => '1',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Restore_restore_file.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/Restore_restore_file.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Restore',\n    'restore_file',\n    array (\n        'backupID' => 'weekly/2017-07-03',\n        'path' => '/public_html/index.php',\n        'overwrite' => '1',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 68"}},"/SSL/add_autossl_excluded_domains":{"get":{"description":"This function disables AutoSSL for the domains that you specify.\n\n**Important:**\n\nWhen you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server [roles](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"add_autossl_excluded_domains","parameters":[{"description":"A comma-separated list of domains for which to disable AutoSSL.\n\n**Note:**\n\nFor browser-based calls, use a URI encoded comma (`%2C`).","in":"query","name":"domains","required":true,"schema":{"example":"example.com,example2.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"add_autossl_excluded_domains","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Disable AutoSSL for domains","tags":["SSL","Auto-generated SSL Certificates"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  add_autossl_excluded_domains \\\n  domains='example.com,example2.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/add_autossl_excluded_domains?domains=example.com%2cexample2.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_add_autossl_excluded_domains.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_add_autossl_excluded_domains.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/add_autossl_excluded_domains/,\n    {\n        'domains' => 'example.com,example2.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_add_autossl_excluded_domains.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_add_autossl_excluded_domains.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'add_autossl_excluded_domains',\n    array (\n        'domains' => 'example.com,example2.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 66"}},"/SSL/can_ssl_redirect":{"get":{"description":"This function determines whether the system can automatically redirect domains on a cPanel account to use SSL.","operationId":"can_ssl_redirect","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"can_ssl_redirect","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"description":"Whether the system can automatically redirect the domains to use SSL.\n* `1` - Can redirect.\n* `0` - **Cannot** redirect.","enum":[0,1],"example":1,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return whether domains can redirect to secure URL","tags":["SSL","cPanel Account SSL Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  can_ssl_redirect\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/can_ssl_redirect"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_can_ssl_redirect.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_can_ssl_redirect.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/can_ssl_redirect/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_can_ssl_redirect.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_can_ssl_redirect.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'can_ssl_redirect'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 80"}},"/SSL/delete_csr":{"get":{"description":"This function deletes a certificate signing request (CSR).\n\n**Note:**\n\n* When you call this function, you **must** include the `id` or the `friendly_name`\nparameter.\n* To delete a private key, use the UAPI `SSL::delete_key` function instead.\n\n**Important:**\n\nWhen you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail,\nand Web Server [roles](https://go.cpanel.net/howtouseserverprofiles#roles),\nthe system **disables** this function.","operationId":"delete_csr","parameters":[{"description":"The CSR's ID.","in":"query","name":"id","required":false,"schema":{"example":"example_com_e095f_0ab2f_ebcbe4a571276f48562241411556647f","type":"string"}},{"description":"The CSR's friendly name.","in":"query","name":"friendly_name","required":false,"schema":{"example":"TestCSR","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"delete_csr","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"commonName":{"description":"The CSR's Common Name.","example":"example.com","format":"domain","type":"string"},"created":{"description":"The CSR's creation date.","example":1538308800,"format":"unix_timestamp","type":"integer"},"domains":{"description":"A list of the domains that the CSR covers.","items":{"example":"example.com","type":"string"},"type":"array"},"ecdsa_curve_name":{"description":"The ECDSA curve that the CSR's key uses.\n\n* `prime256v1`\n* `secp384r1`\n* `null` — The CSR's key is **not** an ECDSA key.","enum":["prime256v1","secp384r1"],"example":null,"nullable":true,"type":"string"},"ecdsa_public":{"description":"The CSR's key's ECDSA compressed public point, in hexadecimal format.\n\n* `null` — The CSR's key is **not** an ECDSA key.","example":null,"nullable":true,"type":"string"},"friendly_name":{"description":"The CSR's friendly name.","example":"TestCSR","type":"string"},"id":{"description":"The CSR's ID.","example":"example_com_e095f_0ab2f_ebcbe4a571276f48562241411556647f","type":"string"},"key_algorithm":{"description":"The CSR's key's algorithm.\n\n* `rsaEncryption` — RSA.\n* `id-ecPublicKey` — ECDSA.","enum":["rsaEncryption","id-ecPublicKey"],"example":"rsaEncryption","type":"string"},"modulus":{"description":"The CSR's key's modulus, in hexadecimal format.\n\n* `null` — The CSR's key is **not** an RSA key.","example":"a74f7636fa6ac93ee6836a83a995b55deb5019ea36d7ba3dafb00e38d693acd\nb0c81b2ff777d6b433a420fae523f127f352a68bcc8b8f2d6ee7b70395bafab\nd8237ada8164fdddf8376b30375c35d4d4cbcce7d33d08069c17b409176a368\n9f1ebc97c0b08fe6ae44c19a92ac6d68448e7f1d13f3b360affd4222a51b4f3\n5342de99b5a1fb5548e438f2d824664562a448002eed7fce24dedc7dc3e1ed1\n79973d1dae959b33716eeb410d172708954e00632cbf60a0e26419860c8c0bc\n285d6bfe4b479de0dd189772a5dae676bd2a92acccc1369821be8cffddd8a7e\n6ecc061f8a32a9ae0661e4e946ed8e3827b277138d3a76116567cbd129cbd86\n9ef9dddf","nullable":true,"type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete certificate signing request","tags":["SSL","SSL Certificate Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  delete_csr\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/delete_csr"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_delete_csr.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_delete_csr.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/delete_csr/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_delete_csr.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_delete_csr.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'delete_csr'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/SSL/delete_key":{"get":{"description":"This function deletes a private key.\n\n**Note:**\n\n* When you call this function, you **must** include the `id` or the `friendly_name`\nparameter.\n* To delete a certificate signing request (CSR), use the UAPI `SSL::delete_csr`\nfunction instead.\n\n**Important:**\n\nWhen you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail,\nand Web Server [roles](https://go.cpanel.net/howtouseserverprofiles#roles),\nthe system **disables** this function.","operationId":"delete_key","parameters":[{"description":"The private key's ID.","in":"query","name":"id","required":false,"schema":{"example":"example_com_e095f_0ab2f_ebcbe4a571276f48562241411556647f","type":"string"}},{"description":"The private key's friendly name.","in":"query","name":"friendly_name","required":false,"schema":{"example":"TestKey","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"delete_key","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"created":{"description":"The private key's creation date.","example":1538308800,"format":"unix_timestamp","type":"integer"},"ecdsa_curve_name":{"description":"The ECDSA curve that the key uses.\n\n* `prime256v1`\n* `secp384r1`\n* `null` — The key is **not** an ECDSA key.","enum":["prime256v1","secp384r1"],"example":null,"nullable":true,"type":"string"},"ecdsa_public":{"description":"The key's ECDSA compressed public point, in hexadecimal format.\n\n* `null` — The key is **not** an ECDSA key.","example":null,"nullable":true,"type":"string"},"friendly_name":{"description":"The private key's friendly name.","example":"TestKey","type":"string"},"key_algorithm":{"description":"The key's algorithm.\n\n* `rsaEncryption` — RSA.\n* `id-ecPublicKey` — ECDSA.","enum":["rsaEncryption","id-ecPublicKey"],"example":"rsaEncryption","type":"string"},"modulus":{"description":"The key's modulus, in hexadecimal format.\n\n* `null` — The key is **not** an RSA key.","example":"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db","nullable":true,"type":"string"},"modulus_length":{"description":"The length, in bits, of the key's modulus.\n\n* `null` — The key is **not** an RSA key.","example":2048,"nullable":true,"type":"integer"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete private key","tags":["SSL","SSL Certificate Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  delete_key\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/delete_key"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_delete_key.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_delete_key.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/delete_key/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_delete_key.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_delete_key.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'delete_key'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/SSL/delete_cert":{"get":{"description":"This function deletes an SSL certificate.\n\n**Note:**\n\n* When you call this function, you **must** include the `id` or the `friendly_name`\nparameter.\n* This function **only** deletes certificates from SSL storage. To end SSL\ncoverage for a domain, use the UAPI `SSL::delete_ssl` function instead.\n\n**Important:**\n\nWhen you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail,\nand Web Server [roles](https://go.cpanel.net/howtouseserverprofiles#roles),\nthe system **disables** this function.","operationId":"delete_cert","parameters":[{"description":"The certificate's ID.","in":"query","name":"id","required":false,"schema":{"example":"example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3","type":"string"}},{"description":"The certificate's friendly name.","in":"query","name":"friendly_name","required":false,"schema":{"example":"TestCert","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"delete_cert","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"created":{"description":"The date the certificate was created.","example":1538308800,"format":"unix_timestamp","type":"integer"},"domains":{"description":"A list of the domains that the certificate covers.","items":{"example":"example.com","format":"domain","type":"string"},"type":"array"},"ecdsa_curve_name":{"description":"The ECDSA curve that the certificate's key uses.\n\n* `prime256v1`\n* `secp384r1`\n* `null` — The certificate's key is **not** an ECDSA key.","enum":["prime256v1","secp384r1"],"example":null,"nullable":true,"type":"string"},"ecdsa_public":{"description":"The certificate's key's ECDSA compressed public point, in hexadecimal format.\n\n* `null` — The certificate's key is **not** an ECDSA key.","example":null,"nullable":true,"type":"string"},"friendly_name":{"description":"The certificate's friendly name.","example":"TestCert","type":"string"},"id":{"description":"The certificate's ID.","example":"example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3","type":"string"},"is_self_signed":{"description":"Whether the certificate is self-signed.\n\n* `1` — Self-signed.\n* `0` — Not self-signed.","enum":[1,0],"example":1,"type":"integer"},"issuer.commonName":{"description":"The certificate's Common Name.","example":"example.com","type":"string"},"issuer.organizationName":{"description":"The certificate's Organization Name.","example":"Organization","type":"string"},"issuer_text":{"description":"The certificate's issuer information.","example":"countryName\nUS\nstateOrProvinceName\nTX\nlocalityName\nHouston\norganizationName\nOrganization\ncommonName\nexample.com","type":"string"},"key_algorithm":{"description":"The certificate's key's algorithm.\n\n* `rsaEncryption` — RSA.\n* `id-ecPublicKey` — ECDSA.","enum":["rsaEncryption","id-ecPublicKey"],"example":"rsaEncryption","type":"string"},"modulus":{"description":"The certificate's key's modulus, in hexadecimal format.\n\n* `null` — The certificate's key is **not** an RSA key.","example":"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db","nullable":true,"type":"string"},"modulus_length":{"description":"The length, in bits, of the certificate's key's modulus.\n\n* `null` — The certificate's key is **not** an RSA key.","example":2048,"nullable":true,"type":"integer"},"not_after":{"description":"The date the certificate expired.","example":1569844800,"format":"unix_timestamp","type":"integer"},"not_before":{"description":"The date the certificate started.","example":1538308800,"format":"unix_timestamp","type":"integer"},"serial":{"description":"The certificate's serial number.","example":"45462cd0d6537b20cf2f3eb8aec07140","type":"string"},"signature_algorithm":{"description":"The certificate's OID signature hash algorithm.","example":"sha256WithRSAEncryption","type":"string"},"subject.commonName":{"description":"The certificate's Common Name.","example":"example.com","type":"string"},"subject_text":{"description":"The certificate's subject text information.","example":"commonName\nwww.example.com","type":"string"},"validation_type":{"description":"The certificate's validation type.\n\n* `ev` — Extended Validation.\n* `ov` — Organization Validation.\n* `dv` — Domain Validation.\n* `null` — The system could not parse and determine the\ncertificate's validation type.","enum":["ev","ov","dv"],"example":"dv","nullable":true,"type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete SSL certificate","tags":["SSL","SSL Certificate Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  delete_cert\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/delete_cert"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_delete_cert.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_delete_cert.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/delete_cert/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_delete_cert.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_delete_cert.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'delete_cert'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/SSL/delete_ssl":{"get":{"description":"This function removes SSL from a domain.\n\n**Note:**\n\nThis function removes domains from the current certificate to end SSL coverage for those\ndomains. To delete certificates from SSL storage, use the UAPI function `SSL::delete_cert`\ninstead.\n\n**Important:**\n\nWhen you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, **and** Web Server\n[roles](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"delete_ssl","parameters":[{"description":"The domain name.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"delete_ssl","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"An array containing a message about the domain's SSL removal.","example":["The SSL host was successfully removed."],"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove SSL for domain","tags":["SSL","cPanel Account SSL Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  delete_ssl \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/delete_ssl?domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_delete_ssl.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_delete_ssl.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/delete_ssl/,\n    {\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_delete_ssl.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_delete_ssl.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'delete_ssl',\n    array (\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/SSL/enable_mail_sni":{"get":{"description":"This function enables SNI mail services on the specified domains.\n\n**Warning:**\n\nMail SNI is **always** enabled.\n* Mail SNI is **not** compatible with Webmail and will **not** function for any Webmail connection. Webmail connections use the cPanel service SSL certificate.\n* Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled.\n* Functions that disable Mail SNI fail and make no changes.\n\n**Important:**\n\n  When you disable the *Calendars and Contacts*, *Mail Receive*, *Web Disk*, *Webmail*, **and** *Web Server* [roles](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"enable_mail_sni","parameters":[{"description":"A pipe-delimited list of the account's domains.","in":"query","name":"domains","required":true,"schema":{"example":"example.com|example1.com|example2.com","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"enable_mail_sni","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"example":{"failed_domains":{"example2.com":"Sorry, example.com is not one of the domains on your account."},"updated_domains":{"example.com":1,"example1.com":1}},"properties":{"failed_domains":{"additionalProperties":{"description":"The reason the domain failed to enable mail SNI.\n\n**Note:**\n\n The domain name is the return name.","example":"Sorry, example.com is not one of the domains on your account.","type":"string"},"description":"An object that contains the domains that did not enable mail SNI.","type":"object"},"updated_domains":{"additionalProperties":{"description":"Whether the domain's SNI is enabled.\n\n* `1` - Enabled.\n* `0` - Not enabled.\n\n**Note:**\n\nThe domain name is the return name.","enum":[0,1],"example":1,"type":"integer"},"description":"An object that contains the domains with disabled mail SNI.","type":"object"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":["cPanel & WHM always enables mail SNI from now on."],"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable SNI mail services for domain","tags":["SSL","SNI Email Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  enable_mail_sni \\\n  domains='example.com|example1.com|example2.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/enable_mail_sni?domains=example.com%7cexample1.com%7cexample2.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_enable_mail_sni.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_enable_mail_sni.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/enable_mail_sni/,\n    {\n        'domains' => 'example.com|example1.com|example2.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_enable_mail_sni.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_enable_mail_sni.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'enable_mail_sni',\n    array (\n        'domains' => 'example.com|example1.com|example2.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.48"}},"/SSL/disable_mail_sni":{"get":{"description":"This function disables SNI mail services on the specified domains.\n\n**Note:**\n\n  Mail SNI is **always** enabled.\n\n  * After you change the SNI status, you **must** run UAPI's `rebuild_mail_sni_config` function.\n  * Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled.\n  * Functions that disable Mail SNI fail and make no changes.","operationId":"disable_mail_sni","parameters":[{"description":"A pipe-delimited list of the account's domains.","in":"query","name":"domains","required":true,"schema":{"example":"example.com|example1.com|example2.com","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"disable_mail_sni","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"example":{"failed_domains":{"example2.com":"Sorry, example2.com is not one of the domains on your account."},"updated_domains":{"example.com":1,"example1.com":1}},"properties":{"failed_domains":{"additionalProperties":{"description":"The reason the domain failed to disable SNI.\n\n**Note:**\n\n The domain name is the return name.","type":"string"},"description":"An object containing the domains that failed to disable\n mail SNI.","type":"object"},"updated_domains":{"additionalProperties":{"description":"Whether the domain's SNI is disabled.\n\n* `1` - Disabled.\n* `0` - Not disabled.\n\n**Note:**\n\nThe domain name is the return name.","enum":[0,1],"type":"integer"},"description":"AN object containing the domains with disabled mail SNI.","type":"object"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings\n describe non-critical failures or other problematic conditions\n noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Disable SNI mail services for domain","tags":["SSL","SNI Email Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  disable_mail_sni \\\n  domains='example.com|example1.com|example2.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/disable_mail_sni?domains=example.com%7cexample1.com%7cexample2.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_disable_mail_sni.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_disable_mail_sni.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/disable_mail_sni/,\n    {\n        'domains' => 'example.com|example1.com|example2.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_disable_mail_sni.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_disable_mail_sni.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'disable_mail_sni',\n    array (\n        'domains' => 'example.com|example1.com|example2.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.48"}},"/SSL/check_shared_cert":{"get":{"deprecated":true,"description":"This function checks whether a shared SSL certificate is associated with the account.","operationId":"check_shared_cert","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"check_shared_cert","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"description":"Whether a shared SSL certificate is associated with the account.\n* `1` - Associated.\n* `0` - Not associated.","enum":[0,1],"example":0,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":0,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return whether shared SSL certificate exists","tags":["SSL","cPanel Account SSL Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  check_shared_cert\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/check_shared_cert"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_check_shared_cert.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_check_shared_cert.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/check_shared_cert/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_check_shared_cert.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_check_shared_cert.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'check_shared_cert'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/SSL/fetch_best_for_domain":{"get":{"description":"This function retrieves the best-available certificate for the domain. The function also\nretrieves the certificate's associated private key and CA bundle, if available.\n\n**Important:**\n\nWhen you disable the [Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"fetch_best_for_domain","parameters":[{"description":"The domain name.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"fetch_best_for_domain","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"properties":{"cab":{"description":"The CA bundle's contents (if applicable).","example":"-----BEGIN CERTIFICATE-----\nMIID/DCCAuSgZwBBAvIFANEXIaYwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL\nZXhhbXBsZS5jb20wHhcNMjAwNDA2MTY0NDU2WhcNMjEwNDA2MTY0NDU2WjAWMRQw\nEgYDVQQDDAtleGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC\nggEBALuCGWz/aFOr5TPBehISu3LkcGvnNFg9eY8rVXbNFfpBzyzdWrx5IiMtBcDx\nAZXMOU7GSZyFhSB6cjNfCaESXC/gBTa0sZ/b4b4etNUlNHUFAatb9WckQ6AtWbVA\npxu8aw/5AjAKgMbkaNrUY3vzLzin11CyGOFkbAKwVqT13Z3Yyz/xuz7x2+yMwPBh\n9mEP0tXjvCz7NzETFSTysn9Sf+VjUle0upnpl8Q7GK52CDpvwdqE/O6MrTx/XrXm\nYUfeSkZd+nqFm4oxmrf01hOL2IlEit1RupILwVm2/8CK2sAdazTqh4LapA962b9V\nSKm31YbsGT3kQg5EERbjIgiN6M8CAwEAAaOCAU8wggFLMB0GA1UdDgQWBBRhFUQb\nh7YE6tgcpiHke60td96d4zAJBgNVHRMEAjAAMEIGA1UdIwQ7MDmAFGEVRBuHtgTq\n2BymIeR7rS133p3joRqkGDAWMRQwEgYDVQQDDAtleGFtcGxlLmNvbYIFANEXIaYw\nHQYDVR0lBBYwFAYIKwYBBQUHAwEGCCsGAQUFBwMCMIG7BgNVHREEgbMwgbCCC2V4\nYW1wbGUuY29tghBtYWlsLmV4YW1wbGUuY29tgg93d3cuZXhhbXBsZS5jb22CEmNw\nYW5lbC5leGFtcGxlLmNvbYITd2VibWFpbC5leGFtcGxlLmNvbYITd2ViZGlzay5l\neGFtcGxlLmNvbYIWY3Bjb250YWN0cy5leGFtcGxlLmNvbYIXY3BjYWxlbmRhcnMu\nZXhhbXBsZS5jb22CD3dobS5leGFtcGxlLmNvbTANBgkqhkiG9w0BAQsFAAOCAQEA\nT0TaI0ypM3eqtRSddgyoy5+nXi8a9a8xFKrwEAljBua3rNR6fOfedMOg9NFwCmQD\nw96/eZJjq+xMh57yLEGu05OBbyFVsdu2AXVhwHeBaURrGn5p7IjNM+dB+ld+oCnP\nex6iisbsfxwUqa7y2vqTU5XaUiXfccqEz8ofvuTcqNs8bgGn0Tm90XbgGnPVd7zl\nGm4t7Gf2pvMNd2R1prJ07z42bp/z8E2DcFhb/QZnblFOhJ8jPspxYK4G5XmwwYZD\n79NDK47OyG3hTiinxroKMjqIgnLT7ZabDMGHJkcg5xOL/VdYi7ZGHAnBEwA8eadO\ndh3jFPxGGIBJTTmKIScSrm==\n-----END CERTIFICATE-----","format":"pem-certificate","type":"string"},"crt":{"description":"The certificate's contents.","example":"-----BEGIN CERTIFICATE-----\nMIID/DCCAuSgZwBBAvIFANEXIaYwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL\nZXhhbXBsZS5jb20wHhcNMjAwNDA2MTY0NDU2WhcNMjEwNDA2MTY0NDU2WjAWMRQw\nEgYDVQQDDAtleGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC\nggEBALuCGWz/aFOr5TPBehISu3LkcGvnNFg9eY8rVXbNFfpBzyzdWrx5IiMtBcDx\nAZXMOU7GSZyFhSB6cjNfCaESXC/gBTa0sZ/b4b4etNUlNHUFAatb9WckQ6AtWbVA\npxu8aw/5AjAKgMbkaNrUY3vzLzin11CyGOFkbAKwVqT13Z3Yyz/xuz7x2+yMwPBh\n9mEP0tXjvCz7NzETFSTysn9Sf+VjUle0upnpl8Q7GK52CDpvwdqE/O6MrTx/XrXm\nYUfeSkZd+nqFm4oxmrf01hOL2IlEit1RupILwVm2/8CK2sAdazTqh4LapA962b9V\nSKm31YbsGT3kQg5EERbjIgiN6M8CAwEAAaOCAU8wggFLMB0GA1UdDgQWBBRhFUQb\nh7YE6tgcpiHke60td96d4zAJBgNVHRMEAjAAMEIGA1UdIwQ7MDmAFGEVRBuHtgTq\n2BymIeR7rS133p3joRqkGDAWMRQwEgYDVQQDDAtleGFtcGxlLmNvbYIFANEXIaYw\nHQYDVR0lBBYwFAYIKwYBBQUHAwEGCCsGAQUFBwMCMIG7BgNVHREEgbMwgbCCC2V4\nYW1wbGUuY29tghBtYWlsLmV4YW1wbGUuY29tgg93d3cuZXhhbXBsZS5jb22CEmNw\nYW5lbC5leGFtcGxlLmNvbYITd2VibWFpbC5leGFtcGxlLmNvbYITd2ViZGlzay5l\neGFtcGxlLmNvbYIWY3Bjb250YWN0cy5leGFtcGxlLmNvbYIXY3BjYWxlbmRhcnMu\nZXhhbXBsZS5jb22CD3dobS5leGFtcGxlLmNvbTANBgkqhkiG9w0BAQsFAAOCAQEA\nT0TaI0ypM3eqtRSddgyoy5+nXi8a7a6xFKrwEAljBua3rNR6fOfedMOg9NFwCmQD\nw96/eZJjq+xMh57yLEGu05OBbyFVsdu2AXVhwHeBaURrGn5p7IjNMjdB+ld+oCmU\nex6iisbsfxwUqa7y2vqTU5XaUiXfccqEz8ofvuTcqNs8bgGn0Tm90XbgGnPVd7zl\nGm4t7Gf2pvMNd2R1prJ07z42bp/z8E2DcFhb/RPnblFOhJ8jPspxYK4G5XmwwYZD\n79NDK47OyG3hTiinxroKMjqIgnLT4ZabDMGHJkcg5xOL/VdYi7ZGHAnBEwA8eadO\ndh3jFPxGGIBJTTmKIScSbg==\n-----END CERTIFICATE-----","format":"pem-certificate","type":"string"},"crt_origin":{"description":"The username that generated the certificate.","example":"username","format":"username","type":"string"},"domain":{"description":"The domain that generated the private key.","example":"example.com","format":"domain","type":"string"},"ip":{"description":"The IP address.","example":"192.168.0.1","format":"ipv4","type":"string"},"key":{"description":"The private key.","example":"-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBBCKAAQNAu4IZbP0oU6vlM8F6EhK9cuRrs+c1WD24jytPds0V+kH+LN1a\nvHkiIy0FwPABlcw5TrZJnIWFIHpyM18JoRJcM+AFNrSxn9vhvh601SU0dQUBq1v1\nZyRDoC1ZtUCnG7xrD/kCMAqAxuRo2tRje/MvOKfXULIY4WRsArBWpPXdndjLP/G7\nPvHb7IzA8GH2YQ/S1eO8LPs3MRMVJPKyf1J/5WNSV7S6memXxDsYrnYIOm/B2oT8\n7oytPH9eteZhR95KRl36eoWbijGat/TWE4vYiUSK3VG6kgvBWbb/wIrawB1rNOqH\ngtqkD3rZv1VIqbfVhuwZPeRCDkQRFuMiCI3ozwIDAQABAoIBAFADflIS0zQRQCdL\nwol/0NmAPbDt4lpdMUg0161wapZ2CrA8bQHMNxMHnVLuBR0lHrdMyhCusVZgqebe\nAT/ok8oiMFdd2AY9UCFO/R+PVskwr7ut7BRtVyY88/Dye9zMFGumeJaDhNxaj5wB\n0coMxfPJO4pF1XQo5CZplS+jc0RtiNnRmWP/zwwtH+QwT43GXKS3U3QgX1a/7Yzw\nliUFuggsjysNPovM5NzcgzYfVlMg3F9fDnMeve2s/MO6/wCIp1+SHN89DwluDmw0\nII0sJDtBRB1nPqseLV1XwYImdSosKuaUIK225vQy/cXK9S/zcq6+d6P5efCw8nRg\nbCfwd7ECgYEA8Agkx+P7zBAWItnkrNzah6QaWd3VP5bSw6WeHwcWIS1h3ASKSr3u\nT8rp5qDTk92eV/g5Uqr5lr8txnp448wnipeK0LDF4r+uhOsHOY4B4eFiTsRecXKD\nzlcC/ees4UOzbdptqosyAG5ub8UMwEH0zPOCszpnIhZkm004EHxc8zUCgYEAx/t0\nF1DYHm834CYyHfq3XiuB3yNECKMQZ1lgcq8IXaO3EJKnaSF3INogS1lZ6hQR2AW+\ntr+U6LdBRzsxH0ZeHu/lYCZ6ssgV3H6HTLlFVRysufVdlLaeaKAMuEADrUhVgvVA\n8rNM+8WSxrfya+2a/PwyJD9YdHCITcXVdwHHCHMCgYBLhYRtECJNVlJgrMXyTZrE\nSrGvzMgntcCiph1WDdi8n5bGrvcEBTZSDLoDQl7Pi08ixorio8Db2VMBu88FfVqD\nlKKsfrIEYeL7FyeyyCd3dn6D4e0FLM6jwWTDln0iczalPbB7lEgrMpO0vv8ADsCD\nK6rX1ZxZoWoOQwF8zmRAcQKBgQC85weoJpOfXAt5zlq1+ulPKOXKs3NGfVG3bjOp\n4SuT2FvKad19b0EqZSDzR/ylIkQgvHyD/8BXexNMh9tE4aFys8UF6BMq4dnUqCiC\nDtgxJ575IY8+NKq5xcV+HenbO2KbC7RIDZqAkQauc3+o947ZvhhXKQcTJmF6pY+Y\nlLM/hQKBgQCplo1rGsimNitBb2iw2B+jDJoMBLYjWeZWcr8VMwVlN9DXPG19uXKq\nCsbrteMX3VedbeRYk/NITsasRefZq7JDSe9JbsPxj3I+/nzV0EbMXX9cxJL3hkCc\n5QAmE/BMR7yh0odK57o+mcQZtecIEO1BK/qW6Au0otQHPraygGCwkQ==\n-----END RSA PRIVATE KEY-----","format":"pem-private-key","type":"string"},"key_origin":{"description":"The username that generated the private key.","example":"username","format":"username","type":"string"},"searched_users":{"description":"The cPanel accounts that the system searched for domain information.","items":{"example":"username","format":"username","type":"string"},"type":"array"},"status":{"description":"Whether the certificate is active.\n* `1` - Active.\n* `0` - Inactive.","enum":[0,1],"example":1,"type":"integer"},"statusmsg":{"description":"The certificate's status.","example":"ok","type":"string"},"user":{"description":"The username that stores the private key.","example":"username","format":"username","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Request best SSL certificate","tags":["SSL","cPanel Account SSL Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  fetch_best_for_domain \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/fetch_best_for_domain?domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_fetch_best_for_domain.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_fetch_best_for_domain.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/fetch_best_for_domain/,\n    {\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_fetch_best_for_domain.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_fetch_best_for_domain.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'fetch_best_for_domain',\n    array (\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/SSL/fetch_cert_info":{"get":{"description":"This function retrieves all of a certificate's available information.\n\n**Important:**\n\n* You **must** call either the `friendly_name` or `id` parameter.\n* When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server [roles](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"fetch_cert_info","parameters":[{"description":"The certificate's ID.","in":"query","name":"id","required":true,"schema":{"example":"example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3","type":"string"}},{"description":"The certificate's human readable name.","in":"query","name":"friendly_name","required":true,"schema":{"example":"TestCert","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"fetch_cert_info","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"properties":{"cabundle":{"description":"The CA bundle's contents (if applicable).","example":"-----BEGIN CERTIFICATE-----\nMIIB+DCCArDgBwIBAgIEWXcZhjANBgkzpkiG6w0BAQsFADATMREwDwYDVRRZZAhu\nZXcxLnRsZDAeFw1yMDAyMDcxMzE7MTdaFw0yMTAyMDYxMzE4MTdaMBMxETAPBgEJ\nBAMMCG5ldzEudGxkMIJBInANBgkqhkiG9w0BAQEFAAOKAR3AMIIBCgKCAQEA5n3Z\nUoGCgH48vcbZfrWtnrak4yOZk/UN45gc8bZGmqbzd3qKmGXkm11aW1ID2YKGKYjL\nmKt42HbXitlH6VhQcWviuYg+JIyTXDMLV0GiGpDT0uvde3YV21Ww2i5nzoFxWyVD\n67oize5gvq9gaw5nVj6UyZ0baIB01QeJ5x52xZyuSgiS0ssWlA3rvHx8wG0+1trR\naBwU0cn1cXP3ZMKzKus/yAUH4lMBFf8jgDzEWIwfMI5HmzUjg2kOPJQlBtZ1u0bJ\nGaKffWIMLs9Ux4p+f7FNeT/xJCHCTX7HpYDOyWwq109yHnD178NkywKoUvtx7f93\ntTI821mltPbC1PQUgQIDAQABo4IBIjCCAR4wHQYDVR0OBBYEFLThoqhCEONRK3X1\nFBgZ4gp+ESmJMAkGA1UdEwQCMAAwPgYDVR0jBDcwNYAUtOGiqEIQ41ErdfUUGBni\nCn4RKYmhF6QVMBMxETAPBgNVBAMMCG5ldzEudGxkggRZdxmGMB0GA1UdJQQWMBQG\nCCsGAQUFBwMBBggrBgEFBQcDAjCBkgYDVR0RBIGKMIGHgghuZXcxLnRsZIINbWFp\nbC5uZXcxLnRsZIIMd3d3Lm5ldzEudGxkgg9jcGFuZWwubmV3MS50bGSCEHdlYm1h\naWwubmV3MS50bGSCEHdlYmRpc2submV3MS50bGSCE2NwY29udGFjdHMubmV3MS50\nbGSCFGNwY2FsZW5kYXJzLm5ldzEudGxkMA0GCSqGSIb3DQEBCwUAA4IBAQCT4AQM\nwbwj3JEoQIJeP7RQyVe2/CPheqkSSajca1a3cUytwfRQ/m8DGM3L3WUZCaDEXYpJ\n+nt7k6KetL6Fs03e1W7IDADt68ahiBLIqvxEGZ5uNUYqOiEWgfp3yKEDOjkLLvzU\nGZb8FmNyeDoQ47b0mf0SRktG6W1rTMAg2kSDVoA7YNZStYvRzEliCX8cZqZ2as2d\nou95S+aGFAPJ+WMyYRgFm+ONAnpSbd9BursEcQSfLjKLusJzXrGVG9zZ/CAK2tHy\nXIlFrj88r0q9AZKyFkh6O1XvaZBiI/UEOWS2H3zcnh5ywudze7jTj5eFz5hr0ubX\ndji/LDNHmG+dKCK7\n-----END CERTIFICATE-----","format":"pem-certificate","nullable":true,"type":"string"},"certificate":{"description":"The certificate's contents.","example":"-----BEGIN CERTIFICATE-----\nMIIDyDCCArDgBwIBAgIEWXcZhjANBgkzpkiG6w0BAQsFADATMREwDwYDVQQDDAhu\nZXcxLnRsZDAeFw1yMDAyMDcxMzE5MTdaFw0yMTAyMDYxMzE4MTdaMBMxETAPBgMB\nBAMMCG5ldzEudGxkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA5n3Z\nUoGCgH48vcbZfrWtnrak4yOZk/UN45gc8bZGmqbzd3qKmGXkm11aW1ID2YKGKYjL\nmKt42HbXitlH6VhQcWviuYg+JIyTXDMLV0GiGpDT0uvde3YV21Ww2i5nzoFxWyVD\n67oize5gvq9gaw5nVj6UyZ0baIB01QeJ5x52xZyuSgiS0ssWlA3rvHx8wG0+1trR\naBwU0cn1cXP3ZMKzKus/yAUH4lMBFf8jgDzEWIwfMI5HmzUjg2kOPJQlBtZ1u0bJ\nGaKffWIMLs9Ux4p+f7FNeT/xJCHCTX7HpYDOyWwq109yHnD178NkywKoUvtx7f93\ntTI821mltPbC1PQUgQIDAQABo4IBIjCCAR4wHQYDVR0OBBYEFLThoqhCEONRK3X1\nFBgZ4gp+ESmJMAkGA1UdEwQCMAAwPgYDVR0jBDcwNYAUtOGiqEIQ41ErdfUUGBni\nCn4RKYmhF6QVMBMxETAPBgNVBAMMCG5ldzEudGxkggRZdxmGMB0GA1UdJQQWMBQG\nCCsGAQUFBwMBBggrBgEFBQcDAjCBkgYDVR0RBIGKMIGHgghuZXcxLnRsZIINbWFp\nbC5uZXcxLnRsZIIMd3d3Lm5ldzEudGxkgg9jcGFuZWwubmV3MS50bGSCEHdlYm1h\naWwubmV3MS50bGSCEHdlYmRpc2submV3MS50bGSCE2NwY29udGFjdHMubmV3MS50\nbGSCFGNwY2FsZW5kYXJzLm5ldzEudGxkMA0GCSqGSIb3DQEBCwUAA4IBAQCT4AQM\nwbwj3JEoQIJeP7RQyVe2/CPheqkSSajca1a3cUytwfRQ/m8DGM3L3WUZCaDEXYpJ\n+nt7k6KetL6Fs03e1W7IDADt68ahiBLIqvxEGZ5uNUYqOiEWgfp3yKEDOjkLLvzU\nGZb8FmNyeDoQ47b0mf0SRktG6W1rTMAg2kSDVoA7YNZStYvRzEliCX8cZqZ2as2d\nou95S+aGFAPJ+WMyYRgFm+ONAnpSbd9BursEcQSfLjKLusJzXrGVG9zZ/CAK2tHy\nXIlFrj88r0q9AZKyFkh6O1XvaZBiI/UEOWS2H3zcnh5ywudze7jTj5eFz5hr0ubX\ndji/LDNHmG+dKCK7\n-----END CERTIFICATE-----","format":"pem-certificate","type":"string"},"is_self_signed":{"description":"Whether the certificate is self-signed.\n* `1` - Self-signed.\n* `0` - **Not** self-signed.","enum":[0,1],"example":1,"type":"integer"},"key":{"description":"The private key.","example":"-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEA5n3ZUoGCgH48vcbZfrYqnrak7yOZk/UN41gr8bZGmqbzd3qK\nmGXkm11aW1ID2YKGKYjLmKt59HbXitlH6VhQcWviuYr+JIyTXDMLV0GiGpDT0uvd\ne3YV21Ww2i5nzoFxWyVD67oize5gvq9gaw5nVj6UyZ0baIB01QeJ5x52xZyuSgiS\n0ssWlA3rvHx8wG0+1trRaBwU0cn1cXP3ZMKzKus/yAUH4lMBFf8jgDzEWIwfMI5H\nmzUjg2kOPJQlBtZ1u0bJGaKffWIMLs9Ux4p+f7FNeT/xJCHCTX7HpYDOyWwq109y\nHnD178NkywKoUvtx7f93tTI821mltPbC1PQUgQIDAQABAoIBAEteX4/hFYFaxhXw\nTfJnCgzaAHTdkTyWZyJC/UP0rIWpjfdFtMg8mVJMZl1yJhwb2C8AskKL34o44iZf\nAmrFHBjahFrSuC9PYGhHsK+poI47SWixA815QZBlJt1RS1R1c1Gwj9MnHHZmOnBf\n/JFFNnk3IYQDwZCcYJfATVGr3n6jLEGNwaPWFV6SHf0C4tCibSdNkkS1L/u+roHK\n2dlmo84suwiqIYlxRCh0rZcvcx5ieF5Rj9g9t2ReYWCuEOMWuPcCfWoe4VngrmMX\nV4I8NS1wtMR8qONJf4B9vcBA36296x1PZp3QEWU6hCd3TKpInKKxe6tOJA1iZ/H0\nKn0sYSECgYEA/W2zPsHKZDHnLN80MdiRFIPnmBvdNl2kPl244S9YFCHULowxx4YA\nMhz46dkm7VAFJdCTDZvKNZloPRG6N+Ouw2TP/gwnqZzVN2jt7+rpSYWp8s8kAASv\npmjnpGLlAZg8BBD/gafxfjEdyB7QEUF379o+0WTxCJrcE8n8UtTcXj0CgYEA6NSR\nf1bXcfzCzLtkudEfyA9+u5mdENqoqasLfJsLzezeGFAYamQsnEEACWSbJvogHHZk\ng/gKVuSzspLDWpJT96agmUFGKoBozJrOj2TpXfSI9uDaGo0/YJsPhnuPHab0jiO5\nCjpCOAKMXaV9lbALRh4ALGiODDDud2rqzph815UCgYEA2ULKf+qzD+KYRSe1H2aC\nOgw653Q72Pe+bpj6flKQN/IobR9TLbH7SPr9ibzYWmpXf2uoJeqBGCJD8tbXxkIy\n+N/cT/crqYUCZVZXZW8GQDmO0NI0Eq/xxb/5ljwSB6PzD6li4kyQA5cn6QBBcAmo\nQL/hSrI20SGxumVXI8vIgCECgYAUJai9cx9LfsrAeoq5xY3Rev3FcAJ2XeVwYRuq\nWaRI2nFRe0TRl/+AOeOt7GW8lrJGpDwIa2NBp6KhFjAPW1AmwuVsvYg7z0bCRbcQ\nE3RaK/naGxTkbUqJqoFKatC0iSjqT88IQohOXnIU/GgEluoy1A/Bx/5asbVA4iCV\nZf6PjQKBgA0A3Q5lrWwuQlCXDiwsRLKSYEwgt5TFKfbiipB01m89PGd1ylz+Uzyn\niE01Cuar6yN9pJiTJ09Tmq3S2xxavY97KFHyu6R8/jHx4mZi9OMJfxffC+84q6d+\nXVABiqBs1l0ebWCsotdXoYDDQaVrCccxPfCjUCtPmgnarz11uhZo\n-----END RSA PRIVATE KEY-----","format":"pem-private-key","type":"string"},"subject.commonName_ip":{"description":"The IP address.","example":"192.168.0.1","format":"ipv4","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return SSL certificate information","tags":["SSL","cPanel Account SSL Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  fetch_cert_info \\\n  id='example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3' \\\n  friendly_name='TestCert'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/fetch_cert_info?id=example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3&friendly_name=TestCert"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_fetch_cert_info.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_fetch_cert_info.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/fetch_cert_info/,\n    {\n        'id' => 'example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3',\n        'friendly_name' => 'TestCert',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_fetch_cert_info.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_fetch_cert_info.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'fetch_cert_info',\n    array (\n        'id' => 'example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3',\n        'friendly_name' => 'TestCert',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/SSL/fetch_certificates_for_fqdns":{"get":{"description":"This function retrieves the certificate information for all fully qualified domain names (FQDNs) that the account owns.","operationId":"fetch_certificates_for_fqdns","parameters":[{"description":"A domain or comma-delimited list of domains for which to retrieve information.","examples":{"multiple":{"summary":"Multiple domains.","value":"domains=example1.com,example2.com"},"single":{"summary":"A single domain.","value":"example.com"}},"explode":false,"in":"query","name":"domains","required":true,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"fetch_certificates_for_fqdns","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"cab":{"description":"The CA bundle's contents.","example":"-----BEGIN CERTIFICATE-----\nMIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD\nVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv\nb3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV\nUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU\ncnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyv\nRLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4M\nypqfpX/1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/5\n1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz\ndcZfHeFhVYAA1IFLezEPI2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl\nIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4/5ODFlitppK+ULdjG+BqXH/9Apy\nbW1EDp3zdHSo1TRJ6V6e6bR64eVaH4QwnNOfpSXY\n-----END CERTIFICATE-----","format":"pem-certificate","type":"string"},"created":{"description":"When the certificate was created.","example":1496950287,"format":"unix_timestamp","type":"integer"},"crt":{"description":"The certificate's contents in Base64 PEM format.","example":"-----BEGIN CERTIFICATE-----\nMIIDcTCCAlmgAwIBAgIFAU+BNVgwDQYJKoZIhvcNAQEFBQAwUTESMBAGA1UEAwwJ\nc2lza28udGxkMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGY1BhbmVsMQswCQYDVQQI\nDAJUWDEQMA4GA1UEBwwHSG91c3RvbjAeFw0xNDEwMDYyMjI2MTlaFw0xNTEwMDYy\nMjI2MTlaMFExEjAQBgNVBAMMCXNpc2tvLnRsZDELMAkGA1UEBhMCVVMxDzANBgNV\nBAoMBmNQYW5lbDELMAkGA1UECAwCVFgxEDAOBgNVBAcMB0hvdXN0b24wggEiMA0G\nCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9zx6zGiHdmWA0dKtoXmJiWXpZ9E3P\nXx3YHsjFEWW7e5pH0vZ+jVMzDmm5nsJ7RXrAkZO1IvpIpVLvoQfiJOWVvkD+o9fW\nvoK1tWJS72FSgPju+58mA2ieBuc87A790Pzuv1P3NR3zFLAjUR99zkHR1fpri/da\nM3PBWO8ET48FWkyU1kOeZaUlF67/+wrEiNgg+t1qhKOCAB61PdNVkLaSGHimksuC\n+Czk8Kq9nuS0E0TCnDtjjEyJ455FUcaCfczlTb8xkB/F9ORe74yTzD+vlk0tFMG6\nPLj/ajIwWqwO0qmQ8wX3NRxkWgGz5kVO1wrVJarKQ5EYQ3/mgvit0v6dAgMBAAGj\nUDBOMB0GA1UdDgQWBBRw+wKBo34+bgexjAa3EMDsgSCd7zAfBgNVHSMEGDAWgBRw\n+wKBo34+bgexjAa3EMDsgSCd7zAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUA\nA4IBAQCHRXIs53opzKM2rM8Qe8lcw524WK6hqy2EWrZHp78N7rU7/6DQ/I3hv3Wh\ncDDIO04I2/Xhe88MLBaLoM367Ya+vy7CaLr14aLi/SfQszMA0ALBvMao+Fis0iVw\nFYq/NLgSXw+fgnpFskt8v8iQZ+4Kaal8U8e9sVgu8m0RgO7rzym1eRiIKpsKd1rh\n/SD7LbSN7M7TRL3QqF7ltw9sQhAAsQcRaBBF21pdWrqhiGZ+Eioo3hhgwNavH2ag\nqz78ddHwrFpHFwrEeUk1OfpPb76MYIce7xIy/4oQNdg6fOq4l/FrajBv+WkzDVPa\nKm6r7YmwfLN/YMZBHXSR58oOGP9W\n-----END CERTIFICATE-----","format":"pem-certificate","type":"string"},"domain_is_configured":{"description":"Whether the certificate is installed on the account.\n* `1` — Installed.\n* `0` — Not installed.","enum":[0,1],"example":1,"type":"integer"},"domains":{"description":"The domains that the CSR covers.","example":["example.servername.com","example.com","mail.example.com","www.example.com","www.example.servername.com"],"items":{"type":"string"},"type":"array"},"ecdsa_curve_name":{"description":"The ECDSA curve that the certificate's key uses.\n\n* `prime256v1`\n* `secp384r1`\n* `null` — The certificate's key is **not** an ECDSA key.","enum":["prime256v1","secp384r1"],"example":null,"nullable":true,"type":"string"},"ecdsa_public":{"description":"The certificate's key's ECDSA compressed public point, in hexadecimal format.\n\n* `null` — The certificate's key is **not** an ECDSA key.","example":null,"nullable":true,"type":"string"},"friendly_name":{"description":"The certificate's friendly name.","example":"Cert for example.servername.com","type":"string"},"id":{"description":"The certificate's identification.","example":"example_servername_com_ce52d_6e643_2813308004_119580f9b01960cjones72bc519206bc","type":"string"},"is_self_signed":{"description":"Whether the certificate is self-signed.\n- `1` — Self-signed.\n- `0` — Not self-signed.","enum":[0,1],"example":1,"type":"integer"},"issuer.commonName":{"description":"The name that issued the certificate.","example":"example.servername.com","type":"string"},"issuer.organizationName":{"description":"The certificate's organization.","example":"Organization","type":"string"},"issuer_text":{"description":"The certificate's issuer information.","example":"stateOrProvinceName\\nTX\\nlocalityName\\nHouston\\ncountryName\\nUS\\ncommonName\\nexample.com\\norganizationName\\ncPanel","type":"string"},"key":{"description":"The private key in Base64 PEM format.","example":"-----BEGIN RSA PRIVATE KEY-----\nMIIJJwIBAAKCAgEA4yilqsoCdEpiNOyLcPJ4FLT7vgwaLdOBeJLTMUeV2uZM4v65/tiZe7H0soDp1C55SCr3uEIEa7Lq7RUZ+F5p67BgRR19rmerKGxfN7N5Vu97pfTwW1f+lVsxUF/56lVeoAmm4okU98xJHiGGlI8ZHGJbUMYfLPy0OrA+gNwMHqMVOv1BSgpbEWCILMvnvtp0rwPutjnPVX2Dj40ia40L4Wqvp+0Yg7mZyhIOl+q6VZVIdXZslR4ZywfRBYt3ieFBDYMyNw9wN3Xy44fCpHc77+ho84W3BqrGaWSSDyf6UkZGD5mfohGf2JSp+c8J6H7hsxo7pta3K1diVXFOSfnaA+k56zW445XruwYs/SN/zvGetGi6uqhMAcVRQcYCmLCixcC6RkcUx3exxgR4q3gthDnFvWC4+NuTh8/K0BcxcuCEhRug/MfVfO3+f7RJFSJPFb9m9Lf4HHBSVkDP5WtG4XiBKCe++9Wuvxbd4QxS7YrnSopNKxkuHKswH8ONpADMYDqfLODMhNrslHNHu95Nv7AlQr8weLqMGWMp7GFqzXcl39RnVkF4Bxd3bAAsMN8/JvanMKCPjTTDrfzVFZcmHXPYOljYDdY1xfIstYVtbyFkUHZP2RPPBaPUAt90lzrKGVF8a2vdIKRiey5SZ5qu9c/mGri3oz7Lkk7qkNPAqDMCAwEAAQKCAgA3f9raG3j2CKZt381Bzzvfc0h+al6LC736Q4Ut6RuH2/S1ER9IUItPWW87nZuDp8ciBr13W0nRNmmHezxZHlgqqXEb8dSfI90Bh1jMNyFSSDihl3KSHrGotBscVBavViREXZdUicGBuXuxtkYno96yvKUq2v0K9MLkA+OBgEHFynqJaw7klBsj573dlAQO8TjI+eD8zKsHbB8Ul5rtRAy/Cl3YXWk75cDZSggevc7A0jRd3o0w8aXDoSlEfYq7OTm3n3JJWZBFPKAXTzgTDr6qItJhjS4IxXsq7RNyeIYES/8aGKKT6lJvjALrcdYt47IpHCOu447lG/h+f6xtDophLGZoAirO7lJFRVfLJh76sLF12bpXJKbbmMN+aut0nM+MLEw8A5K9OV24jJ/3+afj//5789asIyvNaQFPOX23SdLX0QbA5QWvJt2tWvvpS3ubcIJaBEMTK8asEBC68eUW0BBKJaSiYNzecUFYCBjQlxKsIrYuWZoW6fMyRel+cnqMdiH7r2p6RmgF5c9myDwq3E47jE+VrOy8uhw7EMQvT8+YSKaIbgtFZcUSU02BDRB7gWNa842m6nGs5tj5xFNQ6Wt410vilTwL+6zCQqJaKmcdE3woiIgSdrw5MssAHHjqo7QJthZfbpUAUTc6jGPNO13U1ediIRAGdQW5ALqTwQKCAQEA884bmFFZLTewHIv1PJFfNxVZfk3C7LhWE2JcI/5P/YrN4ZA8G08OYhgxqa5XnsHHQPwMM85i1HeOoPwqgTMIyLDX/Sf88+eW3ef4V2M1Y4op0ahWFEwbwXKGxOhncElObN7dfZUwVlxCReaiw2XQAGRqtQC0f+9dZysqPJr+Rz6poTiOtm7DcpW/WiGfBPvVhzBENyqouL9V3vCWYPJSLtCexECoGoPSpHKgUkwbh3+ra8SfG6FOIBj4PpMB82R7oPDjIyXF1VDfb0EwYQlKxyZoP9+NPT2MhZv/hF/Mbm/5LolVHx92hO9q6yxS6nvaFmEPr9fY1EOTWzzPOA+VyQKCAQEA7oVioaTqxENt+wHITZq100iYUpm4X1N1eENTp97QyQbQOVR/t8iGLUdvOZdIxBSTS3JFQ8TNcGDPPc+o319QGdZABNnKwFGY3Ss+5QgVeX6n0WKdxCRelUOUB174aBeXcJCKplh6xBUrLfSZxvZQQb7fv0Mb+2eKUBKTymvES1kpYdn1T0vCCHA3bVpaHuqliCoDSX3RmQICZlfSgCGBbAkmU8RuxDd9yR9l7O9MXUmLsqlsw6hvbUt+7Y13YlDtyX8gbCwEEYsoALOotY1xNfXnyZKTAXhrg+xsQLrURYZUoZiCJyK/mHCWRTPVkt89wq4IexbJ9hqlRjzpmlr8GwKCAQBxRSCs855q06SOnrehHCkQfmrFs3sMX9gdyWTllBG1yfc9BLXoOiKEkJkCLG2o5H6eQnuo1go0jBdH0+ArhnpeQ0sV4q4y4zXEgzFt6Dm1tUsYjQzxASskBQF4GkF0eZpmGmTtI5MBjHt93llgTr0EcaLh1SIHDj5m4DcPUTMyBnro3E3xlCRZ6Biu10/6EMZzuIj42Gjq7HoIyd4TzIFCHsqkgyWWrAgBPwAdPB7OJRKPTxpcy+RwJSmwaLxPSC/n5gKhIbt4D8q+9Zp0esyzGbT1d/c2rJHMwV1FMvzXkk5CwKs7enKl8FXMTRt4tXHtU8rl93JVq8+aY/YiJZuBAoIBAERG2lz7IFjeFHVtpTDRwIqilTfP2P8wnMe4PhInrgxdbu16SrUJKZ98e1I5BBNc8G0AYONtSoGItMo0z1phpkQ/GERLM8aplOB6qJ5XGg6VOuStHgwvfQOtPIp/nQvu9OK7/XRwj3Phu2KESiCyEXdAdDwDsdbdZLJXHwcqoh4Pf9EK2zW/seNIfBVJb9K5yHiZzicTZRQvhxBUw2T6MloCpH4GFM8GM3OHEV4pgeqSSvLxnLjFVmAq5EKL5Ei4cdjkExvj3aZH90N8KicOPgH8SkVhN8OL/Prein5c/LaKJV+8kEUzpTS1xc45cEGCteMsfjD97QINzpG0jgopUVECggEADIaKsx8NUQT3hm0wHRanEFJnQH5HzxaQjWbsjm2uz0KROPNIK1X5L8kypsb+EzlJtvWUqxPaOaTv4DZVpFaVzk8/2PPGsYR3mUjqMqNFYMrNwYZAXvJ/huzDPqq6+w2Pn9jcAifHNw3S8UR650v8gl7BU4fVBvhamG8JelvwLqeGWoikST9NBXVqG5IKBpUkUiFOMUNmRih9ooKvhy7GosoK8MWbmhWo1v8TTSXSagACUhAoIzb6mMN/VFC5WDbFx5AEB/G9tq/zmTqQkuo39dvgl30wyZGRNwc1aFf1Kxeven10/JN9ipp0mTa7NYSdn0RAe9ZRp5cCkgmktqmB0g==\n-----END RSA PRIVATE KEY-----","format":"pem-private-key","type":"string"},"key_algorithm":{"description":"The certificate's key's algorithm.\n\n* `rsaEncryption` — RSA.\n* `id-ecPublicKey` — ECDSA.","enum":["rsaEncryption","id-ecPublicKey"],"example":"rsaEncryption","type":"string"},"modulus":{"description":"The length, in bits, of the certificate's key's modulus.\n\n* `null` — The certificate's key is **not** an RSA key.","example":"ce52db786fd2776f69057ed8ee0d8ab267a2f328a66a3afd8\n76017a99d061ec5d24d646f80ec258c696cb742e2bcd2fef920177144d9126a4\n779c1a21ca5589ff06e673556116903493100dfba385a62d11aeec57f47e5b20\nad8d1142fbe93f003fb62403cdcc0012ccd407009ac21639623bc52a5d6d3814\nff9c45a7c246799f0229b4854af2aeddfa755ab13814132424f5b1680f2c357e\n1476af7422bd5863102cfc5982b3ddad7fecdeae5c1cb73789008be9ce2f24fe\n27c9202b3bca6524ba29a30972f14cbf06f0a1b7998c2361ed90221f40829faf\n644adc7b8da6f948d8745ffbe8e5b6f0c8e7ea9ef2bc26413f90666ef1200407\neab7c3b71c6e643","nullable":true,"type":"string"},"modulus_length":{"description":"The length, in bits, of the certificate's key's modulus.\n\n* `null` — The certificate's key is **not** an RSA key.","example":2048,"minimum":1,"nullable":true,"type":"integer"},"not_after":{"description":"When the certificate expired.","example":1528486286,"format":"unix_timestamp","type":"integer"},"not_before":{"description":"When the certificate started.","example":1496950286,"format":"unix_timestamp","type":"integer"},"serial":{"description":"The certificate's serial number.","example":"01e57e4d92","type":"string"},"signature_algorithm":{"description":"The OID of the hash algorithm used to sign the certificate request.","example":"sha256WithRSAEncryption","type":"string"},"subject.commonName":{"description":"The certificate's common name.","example":"example.servername.com","format":"domain","type":"string"},"subject_text":{"description":"The certificate's subject text information.","example":"stateOrProvinceName\\nTX\\nlocalityName\\nHouston\\ncountryName\\nUS\\ncommonName\\nexample.com\\norganizationName\\ncPanel","type":"string"},"validation_type":{"description":"The certificate's validation type.\n* `ev` — Extended Validation.\n* `ov` — Organization Validated.\n* `dv` — Domain Validated.\n* `null` —  The system could not parse and determine the certificate's validation type.","example":"dv","type":"string"},"verify_error":{"description":"A message that explains the reason for a verification error.","example":"DEPTH_ZERO_SELF_SIGNED_CERT","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- `1` — Success.\n- `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return SSL certificate information for all FQDN","tags":["SSL","cPanel Account SSL Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  fetch_certificates_for_fqdns \\\n  domains='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/fetch_certificates_for_fqdns?domains=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_fetch_certificates_for_fqdns.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_fetch_certificates_for_fqdns.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/fetch_certificates_for_fqdns/,\n    {\n        'domains' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_fetch_certificates_for_fqdns.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_fetch_certificates_for_fqdns.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'fetch_certificates_for_fqdns',\n    array (\n        'domains' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 66"}},"/SSL/find_certificates_for_key":{"get":{"description":"This function retrieves SSL certificates for a private key.\n\n**Note:**\n\nWhen you call this function, you **must** include either the `id`\n**or** the `friendly_name` parameter.","operationId":"find_certificates_for_key","parameters":[{"description":"The key's ID.","in":"query","name":"id","required":false,"schema":{"example":"example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3","type":"string"}},{"description":"The key's friendly name.","in":"query","name":"friendly_name","required":false,"schema":{"example":"TestKey","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"find_certificates_for_key","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"created":{"description":"The date the certificate was created.","example":1538308800,"format":"unix_timestamp","type":"integer"},"domains":{"description":"A list of the domains that the certificate covers.","items":{"example":"example.com","format":"domain","type":"string"},"type":"array"},"ecdsa_curve_name":{"description":"The ECDSA curve that the certificate's key uses.\n\n* `prime256v1`\n* `secp384r1`\n* `null` — The certificate's key is **not** an ECDSA key.","enum":["prime256v1","secp384r1"],"example":null,"nullable":true,"type":"string"},"ecdsa_public":{"description":"The certificate's key's ECDSA compressed public point, in hexadecimal format.\n\n* `null` — The certificate's key is **not** an ECDSA key.","example":null,"nullable":true,"type":"string"},"friendly_name":{"description":"The certificate's friendly name.","example":"TestCert","type":"string"},"id":{"description":"The certificate's ID.","example":"example_com_a74f7_9dddf_1446659822_eae1ff43c4ec1991e195877c55755eff","type":"string"},"is_self_signed":{"description":"Whether the certificate is self-signed.\n\n* `1` — Self-signed.\n* `0` — Not self-signed.","enum":[1,0],"example":1,"type":"integer"},"issuer.commonName":{"description":"The name that issued the certificate.","example":"example.com","type":"string"},"issuer.organizationName":{"description":"The certificate's organization name.","example":"The Example Organization","type":"string"},"issuer_text":{"description":"The certificate's issuer information.","example":"countryName\nUS\ncommonName\u001bxample.com\nlocalityName\nHouston\norganizationName\ncPanel\nstateOrProvinceName\ntx","type":"string"},"key_algorithm":{"description":"The certificate's key's algorithm.\n\n* `rsaEncryption` — RSA.\n* `id-ecPublicKey` — ECDSA.","enum":["rsaEncryption","id-ecPublicKey"],"example":"rsaEncryption","type":"string"},"modulus":{"description":"The certificate's key's modulus, in hexadecimal format.\n\n* `null` — The certificate's key is **not** an RSA key.","example":"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db","nullable":true,"type":"string"},"modulus_length":{"description":"The length, in bits, of the certificate's key's modulus.\n\n* `null` — The certificate's key is **not** an RSA key.","example":2048,"nullable":true,"type":"integer"},"not_after":{"description":"The date the certificate expired.","example":1569844800,"format":"unix_timestamp","type":"integer"},"not_before":{"description":"The date the certificate started.","example":1538308800,"format":"unix_timestamp","type":"integer"},"signature_algorithm":{"description":"The certificate's signature OID hash algorithm.","example":"sha256WithRSAEncryption","type":"string"},"subject.commonName":{"description":"The certificate's Common Name.","example":"example.com","type":"string"},"subject_text":{"description":"The certificate's subject text information.","example":"countryName\nUS\ncommonName\u001bxample.com\nlocalityName\nHouston\norganizationName\ncPanel\nstateOrProvinceName\ntx","type":"string"},"validation_type":{"description":"The certificate's validation type.\n\n* `ev` — Extended Validation.\n* `ov` — Organization Validation.\n* `dv` — Domain Validation.\n* `null` — The system could not parse and determine the\ncertificate's validation type.","enum":["ev","ov","dv"],"example":"dv","nullable":true,"type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return SSL certificate for private key","tags":["SSL","cPanel Account SSL Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  find_certificates_for_key\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/find_certificates_for_key"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_find_certificates_for_key.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_find_certificates_for_key.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/find_certificates_for_key/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_find_certificates_for_key.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_find_certificates_for_key.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'find_certificates_for_key'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/SSL/generate_cert":{"get":{"description":"This function generates a self-signed SSL certificate.\n\n**Important:**\n\nWhen you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail,\nand Web Server [roles](https://go.cpanel.net/howtouseserverprofiles#roles),\nthe system **disables** this function.","operationId":"generate_cert","parameters":[{"description":"A comma-separated list of domains for which to generate the certificate.","examples":{"multiple":{"summary":"Generate certificates for multiple domains.","value":"domains=example1.com,example2.com,example3.com"},"single":{"summary":"Generate a certificate for a domain.","value":"example.com"}},"in":"query","name":"domains","required":true,"schema":{"format":"domain","type":"string"}},{"description":"The two-letter country code.","in":"query","name":"countryName","required":true,"schema":{"example":"US","format":"ISO-3166-1 (alpha-2)","type":"string"}},{"description":"The two-letter state or locality abbreviation.","in":"query","name":"stateOrProvinceName","required":true,"schema":{"example":"TX","type":"string"}},{"description":"The certificate's city or locality name.","in":"query","name":"localityName","required":true,"schema":{"example":"Houston","type":"string"}},{"description":"The certificate's Organization Name.","in":"query","name":"organizationName","required":true,"schema":{"example":"Organization","type":"string"}},{"description":"The certificate's organizational unit or department name.","in":"query","name":"organizationalUnitName","required":false,"schema":{"default":"","example":"Department","type":"string"}},{"description":"An email address to associate with the certificate.","in":"query","name":"emailAddress","required":false,"schema":{"default":"","example":"username@example.com","format":"email","type":"string"}},{"description":"The key's ID.","in":"query","name":"key_id","required":true,"schema":{"example":"example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3","type":"string"}},{"description":"A friendly name for the new certificate.\n\nThis parameter defaults to the domain's name for which you generated the\ncertificate.","in":"query","name":"friendly_name","required":false,"schema":{"example":"TestCert","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"generate_cert","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"properties":{"created":{"description":"The certificate's creation date.","example":1538308800,"format":"unix_timestamp","type":"integer"},"domains":{"description":"A list of domains that the certificate covers.","items":{"example":"example.com","format":"domain","type":"string"},"type":"array"},"ecdsa_curve_name":{"description":"The ECDSA curve that the certificate's key uses.\n\n* `prime256v1`\n* `secp384r1`\n* `null` — The certificate's key is **not** an ECDSA key.","enum":["prime256v1","secp384r1"],"example":null,"nullable":true,"type":"string"},"ecdsa_public":{"description":"The certificate's key's ECDSA compressed public point, in hexadecimal format.\n\n* null — The certificate's key is **not** an ECDSA key.","example":null,"nullable":true,"type":"string"},"friendly_name":{"description":"The certificate's friendly name.","example":"TestCert","type":"string"},"id":{"description":"The certificate's ID.","example":"example_com_a74f7_9dddf_1446659822_eae1ff43c4ec1991e195877c55755eff","type":"string"},"is_self_signed":{"description":"Whether the certificate is self-signed.\n\n* `1` — Self-signed.\n* `0` — Not self-signed.","enum":[1,0],"example":1,"type":"integer"},"issuer.commonName":{"description":"The certificate's Common Name.","example":"example.com","type":"string"},"issuer.organizationName":{"description":"The certificate's Organization Name.","example":"Organization","type":"string"},"key_algorithm":{"description":"The certificate's key's algorithm.\n\n* `rsaEncryption` — RSA.\n* `id-ecPublicKey` — ECDSA.","enum":["rsaEncryption","id-ecPublicKey"],"example":"rsaEncryption","type":"string"},"modulus":{"description":"The certificate's key's modulus, in hexadecimal format.\n\n* `null` — The certificate's key is **not** an RSA key.","example":"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db","nullable":true,"type":"string"},"modulus_length":{"description":"The length, in bits, of the certificate's key's modulus.\n\n* `null` — The certificate's key is **not** an RSA key.","example":2048,"nullable":true,"type":"integer"},"not_after":{"description":"The date that the certificate expires.","example":1569844800,"format":"unix_timestamp","type":"integer"},"not_before":{"description":"The certificate's start date.","example":1538308800,"format":"unix_timestamp","type":"integer"},"serial":{"description":"The certificate's serial number.","example":"01e57e4d92","type":"string"},"signature_algorithm":{"description":"The certificate's OID hash algorithm signature.","example":"sha256WithRSAEncryption","type":"string"},"subject.commonName":{"description":"The domain that issued the certificate.","example":"example.com","format":"domain","type":"string"},"text":{"description":"The certificate's text.","example":"-----BEGIN CERTIFICATE-----\nMIIGBzCCA++gAwIBAgIFAeV+TZIwDQYJKoZIhvcNAQELBQAwUjELMAkGA1UECAwC\nVFgxEDAOBgNVBAcMB0hvdXN0b24xCzAJBgNVBAYTAlVTMRMwEQYDVQQDDAptcmZy\nb2cuY29tMQ8wDQYDVQQKDAZjUGFuZWwwHhcNMjAwNjA4MTUyNjA0WhcNMjEwNjA4\nMTUyNjA0WjBSMQswCQYDVQQIDAJUWDEQMA4GA1UEBwwHSG91c3RvbjELMAkGA1UE\nBhMCVVMxEzARBgNVBAMMCm1yZnJvZy5jb20xDzANBgNVBAoMBmNQYW5lbDCCAiIw\nDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAK/PpzRsms2ZZmA1EG2rNYZaAq2z\nbhUGN6YMpugDwPL9xuqDwf0WUdoBjSBbty7rb5zMCZ+Ty3xHFAo15TLQXqtM0zIo\nh/FRET9rtl6EuXFFFN+eAiV4GgZJVmVMmcgXNGgSjKZHhie5THkGJbwXXRxZryHN\nQIeLlT7DttSwoAh9rEbk6hHKyyoQQ4rSkNXREUZTN3Gk7u7et8iYWl1FBkmJkFDJ\nH4Ys678md7AiXndb4YkOQd2CEgoWXMaMLWJcFkdAmrIYhRmJvyp3BzF9hEkg+qPp\nVEyIL/xVxScdxiFKGWbiHr10UiFt/0+g0gToyUXCmsfo01p0oqrk4qRSZMnUtfdX\nW06vvD64x4Z4M4Jh5WqzVEXEdppzJx09Z7MBK6GLN82pV46x8jp87cBL1LZrpWDinerx+6Vr7YC62itfp6aJ2q6vkxCh4u8T6EjPEcpZAEh5SiQZaOLhAlqgt/lwPpuCW\nQ7LEi/Vg4aG3yb/z8e2BvRK5nnCHd7OOZqg7HJ9UnrzFxeQ8KyvcxP+oYD3h0EvZ\n1zVTbJDLbYuohqbLts3Skuk1hT9HoeWqrmzn2XkoU8LkvzCcRT0oG40BfFr4z7Zz\nsKfG9Z4e06kb1YAPrSqd9w/iI1Ej8cRhBBlowYFq9RjNlkjJCwKlxzynNAJjoQ5W\nU5NJzKjUz6ChHAAtAgMBAAGjgeMwgeAwHQYDVR0OBBYEFFczMNVfcxDsyk27GfjD\nC0Z1Yv+mMAkGA1UdEwQCMAAwfgYDVR0jBHcwdYAUVzMw1V9zEOzKTbsZ+MMLRnVi\n/6ahVqRUMFIxCzAJBgNVBAgMAlRYMRAwDgYDVQQHDAdIb3VzdG9uMQswCQYDVQQG\nEwJVUzETMBEGA1UEAwwKbXJmcm9nLmNvbTEPMA0GA1UECgwGY1BhbmVsggUB5X5N\nkjAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwFQYDVR0RBA4wDIIKbXJm\ncm9nLmNvbTANBgkqhkiG9w0BAQsFAAOCAgEArbNqSdABFWy8NbpDGDAoi2rpw/aM\nWu18iEAHmPg9YekIngNpxZg4b8SB4jrNSSqB0pK8asckxmAcho/pnAx4rOFibftd\nDmGzYxGN9h60JkVToWSn3UQ/0dbqfhfTbGiQvJHTNqB3pQVvWenMFRz9XEcpMDUj\n7UKR8v2xe5Y25yvNPVezYF2/x85awlOoSa00UlKgqh0OU+iuzQZ9T3wtk5uvlc7Z\nIEzBseIn3Kp/WG3P64Rxn95YT6QssKJ+pZ412yKM7vKdcuglNLTv5cx4ffKFN1jm\nanCmPXgYsUdAazmZVSjVuVN7d2+NL+SDVczZCdJ2Vhk5DPqv8ZnHUF7MT+K6vtQd\nJ16+pszCF55t9w5uPqur67/R00dCWLpxvHRRF8J+2Xverhmex5kR6a1nUlbP1oOP\nVq+EmcAL0PP6qdDr8fkjgvNyX7hT+cuiPBbxpY6XfDSlat5+5T2lJ1Ny6GWhBnaR\n35g3EF8ysu3AYQnDwtZrOrEa08lDN3mbrkT3ImSa5oZKgOrlpCZ0dzi8p4wSrboq\n9eZyqikEvuudz+VeQf1WR/6/FsyRq2PEtjgX1atWZiPfatN5f1YVxcElTvuMzyOP\nZXjpUs8MO+CHF1FwtKm52NNItIlnUY7KPpFU8L+oa8O2BMr91wi8NpTR2gd0F+jH\n21NkfEM7YlXzgMw=\n-----END CERTIFICATE-----\n","format":"pem-certificate","type":"string"},"validation_type":{"description":"The certificate's validation type, if one exists.","example":null,"nullable":true,"type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","items":{"example":"Certificate generated","type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create self-signed SSL certificate","tags":["SSL","SSL Certificate Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  generate_cert \\\n  domains='example.com' \\\n  countryName='US' \\\n  stateOrProvinceName='TX' \\\n  localityName='Houston' \\\n  organizationName='Organization' \\\n  key_id='example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/generate_cert?domains=example.com&countryName=US&stateOrProvinceName=TX&localityName=Houston&organizationName=Organization&key_id=example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_generate_cert.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_generate_cert.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/generate_cert/,\n    {\n        'domains' => 'example.com',\n        'countryName' => 'US',\n        'stateOrProvinceName' => 'TX',\n        'localityName' => 'Houston',\n        'organizationName' => 'Organization',\n        'key_id' => 'example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_generate_cert.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_generate_cert.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'generate_cert',\n    array (\n        'domains' => 'example.com',\n        'countryName' => 'US',\n        'stateOrProvinceName' => 'TX',\n        'localityName' => 'Houston',\n        'organizationName' => 'Organization',\n        'key_id' => 'example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/SSL/fetch_key_and_cabundle_for_certificate":{"post":{"description":"This function extracts the private key and CA bundle information from a certificate.\n\n**Note:**\n\nDue to the limited field length of `HTTP GET` method calls, you **must** use the `HTTP POST` method. For this reason, you **cannot** use a cPanel or Webmail session URL to call this function.","operationId":"fetch_key_and_cabundle_for_certificate","parameters":[{"description":"An SSL certificate.","in":"query","name":"certificate","required":true,"schema":{"example":"-----BEGIN CERTIFICATE-----MIIDcTCCAlmgAwIBAgIFAU+BNVgwDQYJKoZIhvcNAQEFBQAwUTESMBAGA1UEAwwJc2lza28udGxkMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGY1BhbmVsMQswCQYDVQQIDAJUWDEQMA4GA1UEBwwHSG91c3RvbjAeFw0xNDEwMDYyMjI2MTlaFw0xNTEwMDYyMjI2MTlaMFExEjAQBgNVBAMMCXNpc2tvLnRsZDELMAkGA1UEBhMCVVMxDzANBgNVBAoMBmNQYW5lbDELMAkGA1UECAwCVFgxEDAOBgNVBAcMB0hvdXN0b24wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9zx6zGiHdmWA0dKtoXmJiWXpZ9E3PXx3YHsjFEWW7e5pH0vZ+jVMzDmm5nsJ7RXrAkZO1IvpIpVLvoQfiJOWVvkD+o9fWvoK1tWJS72FSgPju+58mA2ieBuc87A790Pzuv1P3NR3zFLAjUR99zkHR1fpri/daM3PBWO8ET48FWkyU1kOeZaUlF67/+wrEiNgg+t1qhKOCAB61PdNVkLaSGHimksuC+Czk8Kq9nuS0E0TCnDtjjEyJ455FUcaCfczlTb8xkB/F9ORe74yTzD+vlk0tFMG6PLj/ajIwWqwO0qmQ8wX3NRxkWgGz5kVO1wrVJarKQ5EYQ3/mgvit0v6dAgMBAAGjUDBOMB0GA1UdDgQWBBRw+wKBo34+bgexjAa3EMDsgSCd7zAfBgNVHSMEGDAWgBRw+wKBo34+bgexjAa3EMDsgSCd7zAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUAA4IBAQCHRXIs53opzKM2rM8Qe8lcw524WK6hqy2EWrZHp78N7rU7/6DQ/I3hv3WhcDDIO04I2/Xhe88MLBaLoM367Ya+vy7CaLr14aLi/SfQszMA0ALBvMao+Fis0iVwFYq/NLgSXw+fgnpFskt8v8iQZ+4Kaal8U8e9sVgu8m0RgO7rzym1eRiIKpsKd1rh/SD7LbSN7M7TRL3QqF7ltw9sQhAAsQcRaBBF21pdWrqhiGZ+Eioo3hhgwNavH2agqz78ddHwrFpHFwrEeUk1OfpPb76MYIce7xIy/4oQNdg6fOq4l/FrajBv+WkzDVPaKm6r7YmwfLN/YMZBHXSR58oOGP9W-----END CERTIFICATE-----","format":"pem-certificate","type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"certificate":{"description":"The certificate file.","format":"pem-certificate","type":"string"}},"type":"object"}}},"description":"The certificate's contents."},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"fetch_key_and_cabundle_for_certificate","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"properties":{"cab":{"description":"The CA bundle's contents (if applicable).","example":"-----BEGIN CERTIFICATE-----MIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYDVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJvb3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJVUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJUcnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyvRLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4MypqfpX/1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/51KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKzdcZfHeFhVYAA1IFLezEPI2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWlIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4/5ODFlitppK+ULdjG+BqXH/9ApybW1EDp3zdHSo1TRJ6V6e6bR64eVaH4QwnNOfpSXY-----END CERTIFICATE-----","format":"pem-certificate","type":"string"},"crt":{"description":"The certificate's contents.","example":"-----BEGIN CERTIFICATE-----MIIDcTCCAlmgAwIBAgIFAU+BNVgwDQYJKoZIhvcNAQEFBQAwUTESMBAGA1UEAwwJc2lza28udGxkMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGY1BhbmVsMQswCQYDVQQIDAJUWDEQMA4GA1UEBwwHSG91c3RvbjAeFw0xNDEwMDYyMjI2MTlaFw0xNTEwMDYyMjI2MTlaMFExEjAQBgNVBAMMCXNpc2tvLnRsZDELMAkGA1UEBhMCVVMxDzANBgNVBAoMBmNQYW5lbDELMAkGA1UECAwCVFgxEDAOBgNVBAcMB0hvdXN0b24wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9zx6zGiHdmWA0dKtoXmJiWXpZ9E3PXx3YHsjFEWW7e5pH0vZ+jVMzDmm5nsJ7RXrAkZO1IvpIpVLvoQfiJOWVvkD+o9fWvoK1tWJS72FSgPju+58mA2ieBuc87A790Pzuv1P3NR3zFLAjUR99zkHR1fpri/daM3PBWO8ET48FWkyU1kOeZaUlF67/+wrEiNgg+t1qhKOCAB61PdNVkLaSGHimksuC+Czk8Kq9nuS0E0TCnDtjjEyJ455FUcaCfczlTb8xkB/F9ORe74yTzD+vlk0tFMG6PLj/ajIwWqwO0qmQ8wX3NRxkWgGz5kVO1wrVJarKQ5EYQ3/mgvit0v6dAgMBAAGjUDBOMB0GA1UdDgQWBBRw+wKBo34+bgexjAa3EMDsgSCd7zAfBgNVHSMEGDAWgBRw+wKBo34+bgexjAa3EMDsgSCd7zAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUAA4IBAQCHRXIs53opzKM2rM8Qe8lcw524WK6hqy2EWrZHp78N7rU7/6DQ/I3hv3WhcDDIO04I2/Xhe88MLBaLoM367Ya+vy7CaLr14aLi/SfQszMA0ALBvMao+Fis0iVwFYq/NLgSXw+fgnpFskt8v8iQZ+4Kaal8U8e9sVgu8m0RgO7rzym1eRiIKpsKd1rh/SD7LbSN7M7TRL3QqF7ltw9sQhAAsQcRaBBF21pdWrqhiGZ+Eioo3hhgwNavH2agqz78ddHwrFpHFwrEeUk1OfpPb76MYIce7xIy/4oQNdg6fOq4l/FrajBv+WkzDVPaKm6r7YmwfLN/YMZBHXSR58oOGP9W-----END CERTIFICATE-----","format":"pem-certificate","type":"string"},"crt_origin":{"description":"The username that generated the certificate.","example":"username","format":"username","type":"string"},"domain":{"description":"The domain that generated the private key.","example":"example.com","format":"domain","type":"string"},"ip":{"description":"The IP address.","example":"192.168.0.1","format":"ipv4","type":"string"},"key":{"description":"The private key.","example":"-----BEGIN RSA PRIVATE KEY-----MIIJJwIBAAKCAgEA4yilqsoCdEpiNOyLcPJ4FLT7vgwaLdOBeJLTMUeV2uZM4v65/tiZe7H0soDp1C55SCr3uEIEa7Lq7RUZ+F5p67BgRR19rmerKGxfN7N5Vu97pfTwW1f+lVsxUF/56lVeoAmm4okU98xJHiGGlI8ZHGJbUMYfLPy0OrA+gNwMHqMVOv1BSgpbEWCILMvnvtp0rwPutjnPVX2Dj40ia40L4Wqvp+0Yg7mZyhIOl+q6VZVIdXZslR4ZywfRBYt3ieFBDYMyNw9wN3Xy44fCpHc77+ho84W3BqrGaWSSDyf6UkZGD5mfohGf2JSp+c8J6H7hsxo7pta3K1diVXFOSfnaA+k56zW445XruwYs/SN/zvGetGi6uqhMAcVRQcYCmLCixcC6RkcUx3exxgR4q3gthDnFvWC4+NuTh8/K0BcxcuCEhRug/MfVfO3+f7RJFSJPFb9m9Lf4HHBSVkDP5WtG4XiBKCe++9Wuvxbd4QxS7YrnSoKxkuHKswH8ONpADMYDqfLODMhNrslHNHu95Nv7AlQr8weLqMGWMp7GFqzXcl39RnVkF4Bxd3bAAsMN8/JvanMKCPjTTDrfzVFZcmHXPYOljYDdY1xfIstYVtbyFkUHZP2RPPBaPUAt90lzrKGVF8a2vdIKRiey5SZ5qu9c/mGri3oz7Lkk7qkNPAqDMCAwEAAQKCAgA3f9raG3j2CKZt381Bzzvfc0h+al6LC736Q4Ut6RuH2/S1ER9IUItPWW87nZuDp8ciBr13W0nRNmmHezxZHlgqqXEb8dSfI90Bh1jMNyFSSDihl3KSHrGotBscVBavViREXZdUicGBuXuxtkYno96yvKUq2v0K9MLkA+OBgEHFynqJaw7klBsj573dlAQO8TjI+eD8zKsHbB8Ul5rtRAy/Cl3YXWk75cDZSggevc7A0jRd3o0w8aXDoSlEfYq7OTm3n3JJWZBFPKAXTzgTDr6qItJhjS4IxXsq7RNyeIYES/8aGKKT6lJvjALrcdYt47IpHCOu447lG/h+f6xtDophLGZoAirO7lJFRVfLJh76sLF12bpXJKbbmMN+aut0nM+MLEw8A5K9OV24jJ/3+afj//5789asIyvNaQFPOX23SdLX0QbA5QWvJt2tWvvpS3ubcIJaBEMTK8asEBC68eUW0BBKJaSiYNzecUFYCBjQlxKsIrYuWZoW6fMyRel+cnqMdiH7r2p6RmgF5c9myDwq3E47jE+VrOy8uhw7EMQvT8+YSKaIbgtFZcUSU02BDRB7gWNa842m6nGs5tj5xFNQ6Wt410vilTwL+6zCQqJaKmcdE3woiIgSdrw5MssAHHjqo7QJthZfbpUAUTc6jGPNO13U1ediIRAGdQW5ALqTwQKCAQEA884bmFFZLTewHIv1PJFfNxVZfk3C7LhWE2JcI/5P/YrN4ZA8G08OYhgxqa5XnsHHQPwMM85i1HeOoPwqgTMIyLDX/Sf88+eW3ef4V2M1Y4op0ahWFEwbwXKGxOhncElObN7dfZUwVlxCReaiw2XQAGRqtQC0f+9dZysqPJr+Rz6poTiOtm7DcpW/WiGfBPvVhzBENyqouL9V3vCWYPJSLtCexECoGoPSpHKgUkwbh3+ra8SfG6FOIBj4PpMB82R7oPDjIyXF1VDfb0EwYQlKxyZoP9+NPT2MhZv/hF/Mbm/5LolVHx92hO9q6yxS6nvaFmEPr9fY1EOTWzzPOA+VyQKCAQEA7oVioaTqxENt+wHITZq100iYUpm4X1N1eENTp97QyQbQOVR/t8iGLUdvOZdIxBSTS3JFQ8TNcGDPPc+o319QGdZABNnKwFGY3Ss+5QgVeX6n0WKdxCRelUOUB174aBeXcJCKplh6xBUrLfSZxvZQQb7fv0Mb+2eKUBKTymvES1kpYdn1T0vCCHA3bVpaHuqliCoDSX3RmQICZlfSgCGBbAkmU8RuxDd9yR9l7O9MXUmLsqlsw6hvbUt+7Y13YlDtyX8gbCwEEYsoALOotY1xNfXnyZKTAXhrg+xsQLrURYZUoZiCJyK/mHCWRTPVkt89wq4IexbJ9hqlRjzpmlr8GwKCAQBxRSCs855q06SOnrehHCkQfmrFs3sMX9gdyWTllBG1yfc9BLXoOiKEkJkCLG2o5H6eQnuo1go0jBdH0+ArhnpeQ0sV4q4y4zXEgzFt6Dm1tUsYjQzxASskBQF4GkF0eZpmGmTtI5MBjHt93llgTr0EcaLh1SIHDj5m4DcPUTMyBnro3E3xlCRZ6Biu10/6EMZzuIj42Gjq7HoIyd4TzIFCHsqkgyWWrAgBPwAdPB7OJRKPTxpcy+RwJSmwaLxPSC/n5gKhIbt4D8q+9Zp0esyzGbT1d/c2rJHMwV1FMvzXkk5CwKs7enKl8FXMTRt4tXHtU8rl93JVq8+aY/YiJZuBAoIBAERG2lz7IFjeFHVtpTDRwIqilTfP2P8wnMe4PhInrgxdbu16SrUJKZ98e1I5BBNc8G0AYONtSoGItMo0z1phpkQ/GERLM8aplOB6qJ5XGg6VOuStHgwvfQOtPIp/nQvu9OK7/XRwj3Phu2KESiCyEXdAdDwDsdbdZLJXHwcqoh4Pf9EK2zW/seNIfBVJb9K5yHiZzicTZRQvhxBUw2T6MloCpH4GFM8GM3OHEV4pgeqSSvLxnLjFVmAq5EKL5Ei4cdjkExvj3aZH90N8KicOPgH8SkVhN8OL/Prein5c/LaKJV+8kEUzpTS1xc45cEGCteMsfjD97QINzpG0jgopUVECggEADIaKsx8NUQT3hm0wHRanEFJnQH5HzxaQjWbsjm2uz0KROPNIK1X5L8kypsb+EzlJtvWUqxPaOaTv4DZVpFaVzk8/2PPGsYR3mUjqMqNFYMrNwYZAXvJ/huzDPqq6+w2Pn9jcAifHNw3S8UR650v8gl7BU4fVBvhamG8JelvwLqeGWoikST9NBXVqG5IKBpUkUiFOMUNmRih9ooKvhy7GosoK8MWbmhWo1v8TTSXSagACUhAoIzb6mMN/VFC5WDbFx5AEB/G9tq/zmTqQkuo39dvgl30wyZGRNwc1aFf1Kxeven10/JN9ipp0mTa7NYSdn0RAe9ZRp5cCkgmktqmB0g==-----END RSA PRIVATE KEY-----","format":"pem-private-key","type":"string"},"key_origin":{"description":"The username that generated the private key.","example":"username","format":"username","type":"string"},"searched_users":{"description":"The users that the system searched for certificate information.","items":{"example":"username","format":"username","type":"string"},"type":"array"},"status":{"description":"Whether the certificate is active.\n* `1` - Active.\n* `0` - Inactive.","enum":[0,1],"example":1,"type":"integer"},"statusmsg":{"description":"The certificate's status.","example":"ok","type":"string"},"user":{"description":"The username that stores the private key.","example":"username","format":"username","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return private key and CA bundle","tags":["SSL","cPanel Account SSL Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --input=json --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  fetch_key_and_cabundle_for_certificate\n"},{"label":"HTTP Request (Wire Format)","lang":"HTTP","source":"POST /cpsess##########/execute/SSL/fetch_key_and_cabundle_for_certificate HTTP/1.1\nHost: example.com:2083\nCookie: ###################################\nContent-Type: application/json\nContent-Length: 0\n\n"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/SSL/find_csrs_for_key":{"get":{"description":"This function retrieves certificate signing requests (CSR) for\na private key.\n\n**Note:**\n\nWhen you call this function, you **must** include either the `id`\nor the `friendly_name` parameter.","operationId":"find_csrs_for_key","parameters":[{"description":"The key's ID.","in":"query","name":"id","required":false,"schema":{"example":"example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3","type":"string"}},{"description":"The key's friendly name.","in":"query","name":"friendly_name","required":false,"schema":{"example":"TestKey","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"find_csrs_for_key","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"commonName":{"description":"The CSR's common name.","example":"example.com","format":"domain","type":"string"},"created":{"description":"The date the CSR was created.","example":1538265600,"format":"unix_timestamp","type":"integer"},"domains":{"description":"A list of the domains that the CSR covers.","items":{"example":"example.com","format":"domain","type":"string"},"type":"array"},"ecdsa_curve_name":{"description":"The ECDSA curve that the CSR's key uses.\n\n* `prime256v1`\n* `secp384r1`\n* `null` — The CSR's key is **not** an ECDSA key.","enum":["prime256v1","secp384r1"],"example":null,"nullable":true,"type":"string"},"ecdsa_public":{"description":"The CSR's key's ECDSA compressed public point, in hexadecimal format.\n\n* `null` — The CSR's key is **not** an ECDSA key.","example":null,"nullable":true,"type":"string"},"friendly_name":{"description":"The CSR's friendly name.","example":"TestCSR","type":"string"},"id":{"description":"The CSR's ID.","example":"example_com_a74f7_9dddf_2c5d1615e85db817d6b640f65335fb62","type":"string"},"key_algorithm":{"description":"The CSR's key's algorithm.\n\n* `rsaEncryption` — RSA.\n* `id-ecPublicKey` — ECDSA.","enum":["rsaEncryption","id-ecPublicKey"],"example":"rsaEncryption","type":"string"},"modulus":{"description":"The CSR's key's modulus, in hexadecimal format.\n\n* `null` — The CSR's key is **not** an RSA key.","example":"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db","nullable":true,"type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return private key's certificate signing requests","tags":["SSL","cPanel Account SSL Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  find_csrs_for_key\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/find_csrs_for_key"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_find_csrs_for_key.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_find_csrs_for_key.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/find_csrs_for_key/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_find_csrs_for_key.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_find_csrs_for_key.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'find_csrs_for_key'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/SSL/generate_key":{"get":{"description":"This function generates a private key.\n\n**Important:**\n\n* You **cannot** call both the `keytype` and `keysize` parameters in a single call.\n* When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, **and**\nWeb Server [roles](https://go.cpanel.net/howtouseserverprofiles#roles),\nthe system **disables** this function.","operationId":"SSL-generate_key","parameters":[{"description":"The key's type.\n\n* `system` — The system's default value.\n* `rsa-2048` — 2,408-bit RSA.\n* `rsa-4096` — 4,096-bit RSA.\n* `ecdsa-prime256v1` — ECDSA prime256v1 (\"P-256\").\n* `ecdsa-secp384r1` — ECDSA secp384r1 (\"P-384\").\n\nThis parameter defaults to the user's\n[default SSL/TLS key type](https://go.cpanel.net/cpaneldocsSSLTLS#default-ssl-tls-key-type).\n\n**Note:**\n\nIf you do **not** use this parameter, the system defaults to the `keysize` parameter's default value.","in":"query","name":"keytype","required":false,"schema":{"enum":["system","rsa-2048","rsa-4096","ecdsa-prime256v1","ecdsa-secp384r1"],"example":"rsa-2048","type":"string"}},{"deprecated":true,"description":"The key's modulus size.\n\n**Note:**\n\nUse the `keytype` parameter.","in":"query","name":"keysize","required":false,"schema":{"default":2048,"example":2048,"type":"integer"}},{"description":"A friendly name for the new key.\n\nThis parameter defaults to the key's type, creation date, and creation time.","in":"query","name":"friendly_name","required":false,"schema":{"example":"TestKey","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"generate_key","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"properties":{"created":{"description":"The key's creation date.","example":1601467200,"format":"unix_timestamp","type":"integer"},"ecdsa_curve_name":{"description":"The ECDSA curve that the key uses.\n\n* `prime256v1`\n* `secp384r1`\n* `null` — The key is **not** an ECDSA key.","enum":["prime256v1","secp384r1"],"example":null,"nullable":true,"type":"string"},"ecdsa_public":{"description":"The key's ECDSA compressed public point, in hexadecimal format.\n\n* `null` — The key is **not** an ECDSA key.","example":null,"nullable":true,"type":"string"},"friendly_name":{"description":"The key's friendly name.","example":"TestKey","type":"string"},"id":{"description":"The key's ID.","example":"example_com_a74f7_9dddf_1446659822_eae1ff43c4ec1991e195877c55755eff","type":"string"},"key_algorithm":{"description":"The key's algorithm.\n\n* `rsaEncryption` — RSA.\n* `id-ecPublicKey` — ECDSA.","enum":["rsaEncryption","id-ecPublicKey"],"example":"rsaEncryption","type":"string"},"modulus":{"description":"The key's modulus, in hexadecimal format.\n\n* `null` — The key is **not** an RSA key.","example":"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db","nullable":true,"type":"string"},"modulus_length":{"description":"The length, in bits, of the key's modulus.\n\n* `null` — The key is **not** an RSA key.","example":2048,"nullable":true,"type":"integer"},"text":{"description":"The key's contents.","example":"-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAyeiHvMuJuVk8ZEY6wMzUS1g0eWaHaIWmIRe+Qrn6SwiRrm1p\npsJCiGPPPQGOSg4FzrMXqE0zsi/Tk3hUO/EEsi7CcZe8cUanjlUeXhiwrb86FCMF\nOb9siRHQvlss7VCg8ZGXXTWZgf5yD3A1xPwdayYwF2Tc7GkNcZGUAI58geuYaq+U\nGiLczRGZep1IQ0b1cZnqDvGMx6AS6hiDqLISjnmXYY2OhG6Uyp+SuinjYzLPJ6eO\nN/7i9qqbcGmt0ssddmhR897+bTEom5SlSuyi03KZ9Rn4ZmNJgOsup9MclSBGxBys\nb6MuuM3N0/tF5QuwmDc8H6h2rNBP9vGV7RTTXQIDAQABAoIBAFS/WVoRRLmbjxG3\nuKl8UA9f8oaSVnu0vUpeoOl5Dmm4Kw2/tvzbxPlii3Xb1VGYGS/tVBy8atp74J6h\nfxm5zHLN1afAPMR/F41ShPCSBHapMUOKf4MBqhjOdYOw2Way1RsQNSxWdxxtJIr+\nWlNYTzDOUpk/KMvCPHZS2IBzTidpcFpDQ3pyDXjOoKJJH0EQWPtvxJNGrFqmU29D\n9WBqQemHnDrzg3s7JzQ5cGpbbCE+QX8IckNkslAkyhm771CtqWdeo+c45e6YfGcx\nKuAy1zGSVzQBuitzYoMUOL5olXLEj8fHzXd/cZP4yCyyabcGz2vi6luxF+28l1OL\nG1axyLECgYEA+bD5B+Y/Dp5hZ/uVR1bbvyraQpwbDesS1zgnJ53KOIl926dnWzIt\nUvM46+c9IF+UJrtzwIB6IvjAQioNFrK36bHgNGzNf9WQ54NN172qveaFLdW34z/i\nGR2ix/efm9OC41QREQ/5IKV07TibCwVazVBWascMPkH7FnguTvTCiosCgYEAzwJ+\nGPlIWjK+sqkK5JMUyuH43qAvgVfkZV906JpNRQH0Mob3bC0nXN95EoTwWXk68ULT\no1GHv9XLbj8e+Ok7kpJQZT5vEZnDN+cy3jdTLCvcjU5Q3ToImOTp9isSAFWRTbtk\nyabLNoIIsTR/ZwwPFTZcRiK2d8k7ZhcRKdfGnrcCgYAPZ06FoTukoDqsGoYkB4S4\n72DVmSHGIwlfg5ROylouULUV9ubWZmsLYfvR+cr4k0zlcsz6RDLEs4nQyx1RmCbm\nYNXPBiNLTpaI4b3MoGPHIVB3+mZEu60sFXr0UR9kkpDRi18eKVkaHXrwI3zVGjh2\n0Az0u2DS+mkOAs4AivLxbwKBgQC0XPqbLc+Bb0dCCREJmLD8GCkrZ6wcaQUB4krN\nQ2vhnVM0Fu5K3Yi3XapynUuA2aSmgtA9MxMw7MkjlHGa9DPIgBz2KZDCaBN0iMeE\nX/XivZCbucmxBxhohsLmjh5QFj3U2Vp2bBIQuvlx1EjQ8uvNUqDRJvuOoNFVIPH+\nYBeZPwKBgA//kXfNtNMHOpch699i3rgTzbRFDmGwsr1otzvJsXw7Pr2bM4WIzUJy\nG2SUSUlQRSZK4+BBKT9S0d7TynJD6X/6R7IBotZbfXs1myYxEsKj89/BQmr47x2h\nHjYVCClNoJlsbd5C2yu1R3PikweWGoVaxE3c+AN5knqjwJ0g21Cf\n-----END RSA PRIVATE KEY-----","format":"pem-private-key","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the errors field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create private key","tags":["SSL","SSL Certificate Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  generate_key\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/generate_key"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_generate_key.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_generate_key.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/generate_key/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_generate_key.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_generate_key.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'generate_key'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/SSL/generate_csr":{"get":{"description":"This function generates a certificate signing request (CSR).\n\n**Note:**\n\nThis function **requires** a valid key in the account's `ssl` directory.\nYou can generate a key with UAPI's `SSL::generate_key` function.\n\n**Important:**\n\nWhen you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail,\nand WebServer [roles](https://go.cpanel.net/howtouseserverprofiles#roles),\nthe system **disables** this function.","operationId":"generate_csr","parameters":[{"description":"A comma-separated list of the domains for which to generate the certificate.","examples":{"multiple":{"summary":"Generate a certificate for multiple domains.","value":"domains=example-1.com,example-1.com,example-2.com"},"single":{"summary":"Generate a certificate for a single domain.","value":"example.com"}},"in":"query","name":"domains","required":true,"schema":{"type":"string"}},{"description":"The two-letter country code.","in":"query","name":"countryName","required":true,"schema":{"example":"US","format":"ISO-3166-1 (alpha-2)","type":"string"}},{"description":"The certificate's state or locality name.","in":"query","name":"stateOrProvinceName","required":true,"schema":{"example":"Texas","type":"string"}},{"description":"The certificate's city or locality name.","in":"query","name":"localityName","required":true,"schema":{"example":"Houston","type":"string"}},{"description":"The certificate's organization.","in":"query","name":"organizationName","required":true,"schema":{"example":"Organization","type":"string"}},{"description":"The certificate's organizational unit or department name.","in":"query","name":"organizationalUnitName","required":false,"schema":{"default":"","example":"Department","type":"string"}},{"description":"An email address to associate with the certificate.","in":"query","name":"emailAddress","required":false,"schema":{"default":"","example":"username@example.com","format":"email","type":"string"}},{"description":"The key's ID.","in":"query","name":"key_id","required":true,"schema":{"example":"example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3","type":"string"}},{"description":"A friendly name for the new certificate.\n\nThis parameter defaults to the domain name for which you generated the\ncertificate.","in":"query","name":"friendly_name","required":false,"schema":{"example":"TestCert","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"generate_csr","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"properties":{"commonName":{"description":"The name that issued the CSR.","example":"example.com","type":"string"},"created":{"description":"The date the CSR was created.","example":1569884400,"format":"unix_timestamp","type":"integer"},"domains":{"description":"The domains that the CSR covers.","items":{"example":"example.com","format":"domain","type":"string"},"type":"array"},"ecdsa_curve_name":{"description":"The ECDSA curve that the CSR's key uses.\n\n* `prime256v1`\n* `secp384r1`\n* `null` — The CSR's key is **not** an ECDSA key.","enum":["prime256v1","secp384r1"],"example":null,"nullable":true,"type":"string"},"ecdsa_public":{"description":"The CSR's key's ECDSA compressed public point, in hexadecimal format.\n\n* `null` — The CSR's key is **not** an ECDSA key.","example":null,"nullable":true,"type":"string"},"friendly_name":{"description":"The CSR's friendly name.","example":"TestCSR","type":"string"},"id":{"description":"The CSR's ID.","example":"example_com_a74f7_9dddf_1446659822_eae1ff43c4ec1991e195877c55755eff","type":"string"},"key_algorithm":{"description":"The CSR's key's algorithm.\n\n* `rsaEncryption` — RSA.\n* `id-ecPublicKey` — ECDSA.","enum":["rsaEncryption","id-ecPublicKey"],"example":"rsaEncryption","type":"string"},"modulus":{"description":"The CSR's key's modulus, in hexadecimal format.\n\n* `null` — The CSR's key is **not** an RSA key.","example":"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db","nullable":true,"type":"string"},"text":{"description":"The CSR's text.","example":"-----BEGIN CERTIFICATE REQUEST-----\nMIIC3TCCAcUCAQAwgZcxFDASBgNVBAMMC2V4YW1wbGUuY29tMRYwFAYDVQQLDA1E\nb2N1bWVudGF0aW9uMQswCQYDVQQGEwJVUzEiMCAGCSqGSIb3DQEJARYTbGF1cmVu\nY2VAY3BhbmVsLm5ldDEUMBIGA1UECgwLY1BhbmVsIEluYy4xDjAMBgNVBAgMBVRl\neGFzMRAwDgYDVQQHDAdIb3VzdG9uMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAp092NvpqyT7mg2qDqZW1XetQGeo217o9r7AOONaTrNsMgbL/d31rQzpC\nD65SPxJ/NSpovMi48tbue3A5W6+r2CN62oFk/d34N2swN1w11NTLzOfTPQgGnBe0\nCRdqNonx68l8Cwj+auRMGakqxtaESOfx0T87Ngr/1CIqUbTzU0LembWh+1VI5Djy\n2CRmRWKkSAAu7X/OJN7cfcPh7ReZc9Ha6VmzNxbutBDRcnCJVOAGMsv2Cg4mQZhg\nyMC8KF1r/ktHneDdGJdypdrmdr0qkqzMwTaYIb6M/93Yp+bswGH4oyqa4GYeTpRu\n2OOCeydxONOnYRZWfL0SnL2Gnvnd3wIDAQABoAAwDQYJKoZIhvcNAQEFBQADggEB\nAFlolzJbcviWcdZUv+PJ7G8cAqFAxa8a3W2a0Y1U0BaMrpDfuOHpQgOtO62rr+i+\nhkrIReuk7Isyl6GoZkX17KhQ1Vo9aW8a8Ur7+0RGDbxRlK9jJWnvSFn6cMMqRSfA\nDXpptxhqBFZJIZMc3pPX9Jqycuu8bxeIvUKeSMe3Jxcl1ZXEXX47FeRZxvd+WXF9\n4Xu4KZXHdzb5tB6jPhzIaN0/3d92N/KhvCcnw3YC2fEGDkpOlZaoa7O72+aq5K3b\nM1htFv9deAHqIHefV41iOrxUCIKIhdPIjvAm774lDHLzPpJVrshO/NpA74LEkny5\nFMwKKx+6Jgx1HSWucn5kWek=\n-----END CERTIFICATE REQUEST-----","format":"pem-certificate-request","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":["Certificate Signing Request generated!"],"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create certificate signing request","tags":["SSL","SSL Certificate Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  generate_csr \\\n  domains='example.com' \\\n  countryName='US' \\\n  stateOrProvinceName='Texas' \\\n  localityName='Houston' \\\n  organizationName='Organization' \\\n  key_id='example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/generate_csr?domains=example.com&countryName=US&stateOrProvinceName=Texas&localityName=Houston&organizationName=Organization&key_id=example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_generate_csr.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_generate_csr.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/generate_csr/,\n    {\n        'domains' => 'example.com',\n        'countryName' => 'US',\n        'stateOrProvinceName' => 'Texas',\n        'localityName' => 'Houston',\n        'organizationName' => 'Organization',\n        'key_id' => 'example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_generate_csr.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_generate_csr.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'generate_csr',\n    array (\n        'domains' => 'example.com',\n        'countryName' => 'US',\n        'stateOrProvinceName' => 'Texas',\n        'localityName' => 'Houston',\n        'organizationName' => 'Organization',\n        'key_id' => 'example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/SSL/get_autossl_excluded_domains":{"get":{"description":"This function lists the domains with AutoSSL disabled.","operationId":"get_autossl_excluded_domains","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_autossl_excluded_domains","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"description":"An array of objects that include domain's AutoSSL information.","items":{"properties":{"excluded_domain":{"description":"A domain that has AutoSSL disabled.","example":"example.com","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return AutoSSL disabled domains","tags":["SSL","Auto-generated SSL Certificates"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  get_autossl_excluded_domains\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/get_autossl_excluded_domains"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_get_autossl_excluded_domains.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_get_autossl_excluded_domains.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/get_autossl_excluded_domains/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_get_autossl_excluded_domains.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_get_autossl_excluded_domains.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'get_autossl_excluded_domains'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 66"}},"/DNSSEC/add_zone_key":{"get":{"description":"This function generates a DNSSEC zone key for a domain.\n\n**Note:**\n\n* After you enable DNSSEC on the domain, you **must** add the DS records to your registrar.\n* You **cannot** modify the DNSSEC security key. To make any changes, you **must** disable (and delete) and re-create the DNSSEC security key.\n\n**Important:**\n\nWhen you disable the [DNS role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"add_zone_key","parameters":[{"description":"The domain on which to enable DNSSEC.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"The algorithm that the system uses to generate the security key.\n\n* `5` — RSA/SHA-1\n* `6` — DSA-NSEC3-SHA1\n* `7` — RSASHA1-NSEC3-SHA1\n* `8` — RSA/SHA-256\n* `10` — RSA/SHA-512\n* `13` — ECDSA Curve P-256 with SHA-256\n* `14` — ECDSA Curve P-384 with SHA-384\n\n**Note:**\n\nWe recommend that you use 'ECDSA Curve P-256 with SHA-256' if your registrar supports it.","in":"query","name":"algo_num","required":true,"schema":{"enum":[5,6,7,8,10,13,14],"example":8,"type":"integer"}},{"description":"The type of key to add.\n\n* `ksk`\n* `zsk`","in":"query","name":"key_type","required":true,"schema":{"enum":["ksk","zsk"],"example":"ksk","type":"string"}},{"description":"The key's size, in bits.\n\n**Note:**\n\nFor the following `algo_num` and `key_type` parameters, the `key_size` defaults to the following values:\n* `5` — ksk `2048` zsk `1024`\n* `6` — ksk `2048` zsk `1024`\n* `7` — ksk `2048` zsk `1024`\n* `8` — ksk `2048` zsk `1024`\n* `10` — ksk `2048` zsk `1024`\n* `13` — ksk `256` zsk `256`\n* `14` — ksk `384` zsk `384` ","in":"query","name":"key_size","required":false,"schema":{"example":2048,"maximum":2048,"minimum":256,"type":"integer"}},{"description":"Whether to activate the newly-created key.\n\n* `1` — Activate the key.\n* `0` — Do **not** activate the key.","in":"query","name":"active","required":false,"schema":{"default":1,"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"add_zone_key","type":"string"},"module":{"description":"The name of the module called.","example":"DNSSEC","type":"string"},"result":{"properties":{"data":{"properties":{"domain":{"description":"The domain for which the system added a security key.","example":"example.com","format":"domain","type":"string"},"error":{"description":"An error message that describes why the system could not add the security key.\n\n**Note:**\n\nThe function **only** displays this return when the `success` return is a `0` value.","example":"Error: Invalid key_id or domain specified: No such key present for domain.","type":"string"},"new_key_id":{"description":"The security key's ID.","example":"1","type":"string"},"success":{"description":"Whether the system added the security key.\n\n* `1` — The system added the security key.\n* `0` — The system failed to add the security key.","enum":[1,0],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create DNSSEC security key","tags":["DNSSEC","DNS Security"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DNSSEC \\\n  add_zone_key \\\n  domain='example.com' \\\n  algo_num='8' \\\n  key_type='ksk'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DNSSEC/add_zone_key?domain=example.com&algo_num=8&key_type=ksk"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DNSSEC_add_zone_key.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DNSSEC_add_zone_key.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DNSSEC/,\n    q/add_zone_key/,\n    {\n        'domain' => 'example.com',\n        'algo_num' => '8',\n        'key_type' => 'ksk',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DNSSEC_add_zone_key.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DNSSEC_add_zone_key.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DNSSEC',\n    'add_zone_key',\n    array (\n        'domain' => 'example.com',\n        'algo_num' => '8',\n        'key_type' => 'ksk',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 84"}},"/SSL/get_autossl_problems":{"get":{"description":"This function retrieves a list of domains that possess AutoSSL problems.\n\n**Important:**\n\nWhen you disable the [Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"get_autossl_problems","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_autossl_problems","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"domain":{"description":"The certificate's hostname.","example":"example.com","format":"domain","type":"string"},"problem":{"description":"text description of the problem.","example":"example.com contains 400 domains, which exceeds the maximum number (200) of domains allowed for the \"Sectigo\" AutoSSL provider. This system will include those 200 domains on the certificate that appear to be the website's most important. To allow AutoSSL to secure each domain, divide the 400 domains among separate websites. (The websites can all serve the same content from the same document root.)","type":"string"},"time":{"description":"When the problem occurred.","example":"2018-06-07T05:30:09Z","format":"ISO-8601 Date Time","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return domains with AutoSSL problems","tags":["SSL","Auto-generated SSL Certificates"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  get_autossl_problems\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/get_autossl_problems"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_get_autossl_problems.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_get_autossl_problems.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/get_autossl_problems/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_get_autossl_problems.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_get_autossl_problems.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'get_autossl_problems'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 68"}},"/SSL/get_cabundle":{"get":{"description":"This function retrieves a certificate's Certificate Authority (CA) bundle and hostname.\n\n**Important:**\n\nWhen you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server [roles](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"get_cabundle","parameters":[{"description":"The certificate's text.","in":"query","name":"cert","required":true,"schema":{"example":"-----BEGIN CERTIFICATE-----\\r\\nMIIDcTCCAlmgAwIBAgIFAU+BNVgwDQYJKoZIhvcNAQEFBQAwUTESMBAGA1UEAwwJ\\r\\nc2lza28udGxkMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGY1BhbmVsMQswCQYDVQQI\\r\\nDAJUWDEQMA4GA1UEBwwHSG91c3RvbjAeFw0xNDEwMDYyMjI2MTlaFw0xNTEwMDYy\\r\\nMjI2MTlaMFExEjAQBgNVBAMMCXNpc2tvLnRsZDELMAkGA1UEBhMCVVMxDzANBgNV\\r\\nBAoMBmNQYW5lbDELMAkGA1UECAwCVFgxEDAOBgNVBAcMB0hvdXN0b24wggEiMA0G\\r\\nCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9zx6zGiHdmWA0dKtoXmJiWXpZ9E3P\\r\\nXx3YHsjFEWW7e5pH0vZ+jVMzDmm5nsJ7RXrAkZO1IvpIpVLvoQfiJOWVvkD+o9fW\\r\\nvoK1tWJS72FSgPju+58mA2ieBuc87A790Pzuv1P3NR3zFLAjUR99zkHR1fpri/da\\r\\nM3PBWO8ET48FWkyU1kOeZaUlF67/+wrEiNgg+t1qhKOCAB61PdNVkLaSGHimksuC\\r\\n+Czk8Kq9nuS0E0TCnDtjjEyJ455FUcaCfczlTb8xkB/F9ORe74yTzD+vlk0tFMG6\\r\\nPLj/ajIwWqwO0qmQ8wX3NRxkWgGz5kVO1wrVJarKQ5EYQ3/mgvit0v6dAgMBAAGj\\r\\nUDBOMB0GA1UdDgQWBBRw+wKBo34+bgexjAa3EMDsgSCd7zAfBgNVHSMEGDAWgBRw\\r\\n+wKBo34+bgexjAa3EMDsgSCd7zAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUA\\r\\nA4IBAQCHRXIs53opzKM2rM8Qe8lcw524WK6hqy2EWrZHp78N7rU7/6DQ/I3hv3Wh\\r\\ncDDIO04I2/Xhe88MLBaLoM367Ya+vy7CaLr14aLi/SfQszMA0ALBvMao+Fis0iVw\\r\\nFYq/NLgSXw+fgnpFskt8v8iQZ+4Kaal8U8e9sVgu8m0RgO7rzym1eRiIKpsKd1rh\\r\\n/SD7LbSN7M7TRL3QqF7ltw9sQhAAsQcRaBBF21pdWrqhiGZ+Eioo3hhgwNavH2ag\\r\\nqz78ddHwrFpHFwrEeUk1OfpPb76MYIce7xIy/4oQNdg6fOq4l/FrajBv+WkzDVPa\\r\\nKm6r7YmwfLN/YMZBHXSR58oOGP9W\\r\\n-----END CERTIFICATE-----","format":"pem-certificate","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_cabundle","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"properties":{"bundle":{"description":"The CA bundle's tag.","example":"VeriSign Trial Secure Server CA - G2","type":"string"},"cab":{"description":"The CA bundle's contents.","example":"-----BEGIN CERTIFICATE----- MIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD VQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv b3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV UzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU cnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyv RLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4M ypqfpX/1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/5 1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz dcZfHeFhVYAA1IFLezEPI2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl IjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4/5ODFlitppK+ULdjG+BqXH/9Apy bW1EDp3zdHSo1TRJ6V6e6bR64eVaH4QwnNOfpSXY -----END CERTIFICATE-----","format":"pem-certificate","type":"string"},"domain":{"description":"The certificate's hostname.","example":"example.com","format":"domain","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return certificate's CA bundle and hostname","tags":["SSL","cPanel Account SSL Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty --user=username SSL get_cabundle cert='-----BEGIN CERTIFICATE-----\\r\\nMIIDcTCCAlmgAwIBAgIFAU+BNVgwDQYJKoZIhvcNAQEFBQAwUTESMBAGA1UEAwwJ\\r\\nc2lza28udGxkMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGY1BhbmVsMQswCQYDVQQI\\r\\nDAJUWDEQMA4GA1UEBwwHSG91c3RvbjAeFw0xNDEwMDYyMjI2MTlaFw0xNTEwMDYy\\r\\nMjI2MTlaMFExEjAQBgNVBAMMCXNpc2tvLnRsZDELMAkGA1UEBhMCVVMxDzANBgNV\\r\\nBAoMBmNQYW5lbDELMAkGA1UECAwCVFgxEDAOBgNVBAcMB0hvdXN0b24wggEiMA0G\\r\\nCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9zx6zGiHdmWA0dKtoXmJiWXpZ9E3P\\r\\nXx3YHsjFEWW7e5pH0vZ+jVMzDmm5nsJ7RXrAkZO1IvpIpVLvoQfiJOWVvkD+o9fW\\r\\nvoK1tWJS72FSgPju+58mA2ieBuc87A790Pzuv1P3NR3zFLAjUR99zkHR1fpri/da\\r\\nM3PBWO8ET48FWkyU1kOeZaUlF67/+wrEiNgg+t1qhKOCAB61PdNVkLaSGHimksuC\\r\\n+Czk8Kq9nuS0E0TCnDtjjEyJ455FUcaCfczlTb8xkB/F9ORe74yTzD+vlk0tFMG6\\r\\nPLj/ajIwWqwO0qmQ8wX3NRxkWgGz5kVO1wrVJarKQ5EYQ3/mgvit0v6dAgMBAAGj\\r\\nUDBOMB0GA1UdDgQWBBRw+wKBo34+bgexjAa3EMDsgSCd7zAfBgNVHSMEGDAWgBRw\\r\\n+wKBo34+bgexjAa3EMDsgSCd7zAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUA\\r\\nA4IBAQCHRXIs53opzKM2rM8Qe8lcw524WK6hqy2EWrZHp78N7rU7/6DQ/I3hv3Wh\\r\\ncDDIO04I2/Xhe88MLBaLoM367Ya+vy7CaLr14aLi/SfQszMA0ALBvMao+Fis0iVw\\r\\nFYq/NLgSXw+fgnpFskt8v8iQZ+4Kaal8U8e9sVgu8m0RgO7rzym1eRiIKpsKd1rh\\r\\n/SD7LbSN7M7TRL3QqF7ltw9sQhAAsQcRaBBF21pdWrqhiGZ+Eioo3hhgwNavH2ag\\r\\nqz78ddHwrFpHFwrEeUk1OfpPb76MYIce7xIy/4oQNdg6fOq4l/FrajBv+WkzDVPa\\r\\nKm6r7YmwfLN/YMZBHXSR58oOGP9W\\r\\n-----END CERTIFICATE-----'"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/get_cabundle?cert=-----BEGIN%20CERTIFICATE-----%5cr%5cnMIIDcTCCAlmgAwIBAgIFAU%2bBNVgwDQYJKoZIhvcNAQEFBQAwUTESMBAGA1UEAwwJ%5cr%5cnc2lza28udGxkMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGY1BhbmVsMQswCQYDVQQI%5cr%5cnDAJUWDEQMA4GA1UEBwwHSG91c3RvbjAeFw0xNDEwMDYyMjI2MTlaFw0xNTEwMDYy%5cr%5cnMjI2MTlaMFExEjAQBgNVBAMMCXNpc2tvLnRsZDELMAkGA1UEBhMCVVMxDzANBgNV%5cr%5cnBAoMBmNQYW5lbDELMAkGA1UECAwCVFgxEDAOBgNVBAcMB0hvdXN0b24wggEiMA0G%5cr%5cnCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9zx6zGiHdmWA0dKtoXmJiWXpZ9E3P%5cr%5cnXx3YHsjFEWW7e5pH0vZ%2bjVMzDmm5nsJ7RXrAkZO1IvpIpVLvoQfiJOWVvkD%2bo9fW%5cr%5cnvoK1tWJS72FSgPju%2b58mA2ieBuc87A790Pzuv1P3NR3zFLAjUR99zkHR1fpri%2fda%5cr%5cnM3PBWO8ET48FWkyU1kOeZaUlF67%2f%2bwrEiNgg%2bt1qhKOCAB61PdNVkLaSGHimksuC%5cr%5cn%2bCzk8Kq9nuS0E0TCnDtjjEyJ455FUcaCfczlTb8xkB%2fF9ORe74yTzD%2bvlk0tFMG6%5cr%5cnPLj%2fajIwWqwO0qmQ8wX3NRxkWgGz5kVO1wrVJarKQ5EYQ3%2fmgvit0v6dAgMBAAGj%5cr%5cnUDBOMB0GA1UdDgQWBBRw%2bwKBo34%2bbgexjAa3EMDsgSCd7zAfBgNVHSMEGDAWgBRw%5cr%5cn%2bwKBo34%2bbgexjAa3EMDsgSCd7zAMBgNVHRMEBTADAQH%2fMA0GCSqGSIb3DQEBBQUA%5cr%5cnA4IBAQCHRXIs53opzKM2rM8Qe8lcw524WK6hqy2EWrZHp78N7rU7%2f6DQ%2fI3hv3Wh%5cr%5cncDDIO04I2%2fXhe88MLBaLoM367Ya%2bvy7CaLr14aLi%2fSfQszMA0ALBvMao%2bFis0iVw%5cr%5cnFYq%2fNLgSXw%2bfgnpFskt8v8iQZ%2b4Kaal8U8e9sVgu8m0RgO7rzym1eRiIKpsKd1rh%5cr%5cn%2fSD7LbSN7M7TRL3QqF7ltw9sQhAAsQcRaBBF21pdWrqhiGZ%2bEioo3hhgwNavH2ag%5cr%5cnqz78ddHwrFpHFwrEeUk1OfpPb76MYIce7xIy%2f4oQNdg6fOq4l%2fFrajBv%2bWkzDVPa%5cr%5cnKm6r7YmwfLN%2fYMZBHXSR58oOGP9W%5cr%5cn-----END%20CERTIFICATE-----"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_get_cabundle.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_get_cabundle.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/get_cabundle/,\n    {\n        'cert' => '-----BEGIN CERTIFICATE-----\\r\\nMIIDcTCCAlmgAwIBAgIFAU+BNVgwDQYJKoZIhvcNAQEFBQAwUTESMBAGA1UEAwwJ\\r\\nc2lza28udGxkMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGY1BhbmVsMQswCQYDVQQI\\r\\nDAJUWDEQMA4GA1UEBwwHSG91c3RvbjAeFw0xNDEwMDYyMjI2MTlaFw0xNTEwMDYy\\r\\nMjI2MTlaMFExEjAQBgNVBAMMCXNpc2tvLnRsZDELMAkGA1UEBhMCVVMxDzANBgNV\\r\\nBAoMBmNQYW5lbDELMAkGA1UECAwCVFgxEDAOBgNVBAcMB0hvdXN0b24wggEiMA0G\\r\\nCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9zx6zGiHdmWA0dKtoXmJiWXpZ9E3P\\r\\nXx3YHsjFEWW7e5pH0vZ+jVMzDmm5nsJ7RXrAkZO1IvpIpVLvoQfiJOWVvkD+o9fW\\r\\nvoK1tWJS72FSgPju+58mA2ieBuc87A790Pzuv1P3NR3zFLAjUR99zkHR1fpri/da\\r\\nM3PBWO8ET48FWkyU1kOeZaUlF67/+wrEiNgg+t1qhKOCAB61PdNVkLaSGHimksuC\\r\\n+Czk8Kq9nuS0E0TCnDtjjEyJ455FUcaCfczlTb8xkB/F9ORe74yTzD+vlk0tFMG6\\r\\nPLj/ajIwWqwO0qmQ8wX3NRxkWgGz5kVO1wrVJarKQ5EYQ3/mgvit0v6dAgMBAAGj\\r\\nUDBOMB0GA1UdDgQWBBRw+wKBo34+bgexjAa3EMDsgSCd7zAfBgNVHSMEGDAWgBRw\\r\\n+wKBo34+bgexjAa3EMDsgSCd7zAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUA\\r\\nA4IBAQCHRXIs53opzKM2rM8Qe8lcw524WK6hqy2EWrZHp78N7rU7/6DQ/I3hv3Wh\\r\\ncDDIO04I2/Xhe88MLBaLoM367Ya+vy7CaLr14aLi/SfQszMA0ALBvMao+Fis0iVw\\r\\nFYq/NLgSXw+fgnpFskt8v8iQZ+4Kaal8U8e9sVgu8m0RgO7rzym1eRiIKpsKd1rh\\r\\n/SD7LbSN7M7TRL3QqF7ltw9sQhAAsQcRaBBF21pdWrqhiGZ+Eioo3hhgwNavH2ag\\r\\nqz78ddHwrFpHFwrEeUk1OfpPb76MYIce7xIy/4oQNdg6fOq4l/FrajBv+WkzDVPa\\r\\nKm6r7YmwfLN/YMZBHXSR58oOGP9W\\r\\n-----END CERTIFICATE-----',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_get_cabundle.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_get_cabundle.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'get_cabundle',\n    array (\n        'cert' => '-----BEGIN CERTIFICATE-----\\r\\nMIIDcTCCAlmgAwIBAgIFAU+BNVgwDQYJKoZIhvcNAQEFBQAwUTESMBAGA1UEAwwJ\\r\\nc2lza28udGxkMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGY1BhbmVsMQswCQYDVQQI\\r\\nDAJUWDEQMA4GA1UEBwwHSG91c3RvbjAeFw0xNDEwMDYyMjI2MTlaFw0xNTEwMDYy\\r\\nMjI2MTlaMFExEjAQBgNVBAMMCXNpc2tvLnRsZDELMAkGA1UEBhMCVVMxDzANBgNV\\r\\nBAoMBmNQYW5lbDELMAkGA1UECAwCVFgxEDAOBgNVBAcMB0hvdXN0b24wggEiMA0G\\r\\nCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9zx6zGiHdmWA0dKtoXmJiWXpZ9E3P\\r\\nXx3YHsjFEWW7e5pH0vZ+jVMzDmm5nsJ7RXrAkZO1IvpIpVLvoQfiJOWVvkD+o9fW\\r\\nvoK1tWJS72FSgPju+58mA2ieBuc87A790Pzuv1P3NR3zFLAjUR99zkHR1fpri/da\\r\\nM3PBWO8ET48FWkyU1kOeZaUlF67/+wrEiNgg+t1qhKOCAB61PdNVkLaSGHimksuC\\r\\n+Czk8Kq9nuS0E0TCnDtjjEyJ455FUcaCfczlTb8xkB/F9ORe74yTzD+vlk0tFMG6\\r\\nPLj/ajIwWqwO0qmQ8wX3NRxkWgGz5kVO1wrVJarKQ5EYQ3/mgvit0v6dAgMBAAGj\\r\\nUDBOMB0GA1UdDgQWBBRw+wKBo34+bgexjAa3EMDsgSCd7zAfBgNVHSMEGDAWgBRw\\r\\n+wKBo34+bgexjAa3EMDsgSCd7zAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUA\\r\\nA4IBAQCHRXIs53opzKM2rM8Qe8lcw524WK6hqy2EWrZHp78N7rU7/6DQ/I3hv3Wh\\r\\ncDDIO04I2/Xhe88MLBaLoM367Ya+vy7CaLr14aLi/SfQszMA0ALBvMao+Fis0iVw\\r\\nFYq/NLgSXw+fgnpFskt8v8iQZ+4Kaal8U8e9sVgu8m0RgO7rzym1eRiIKpsKd1rh\\r\\n/SD7LbSN7M7TRL3QqF7ltw9sQhAAsQcRaBBF21pdWrqhiGZ+Eioo3hhgwNavH2ag\\r\\nqz78ddHwrFpHFwrEeUk1OfpPb76MYIce7xIy/4oQNdg6fOq4l/FrajBv+WkzDVPa\\r\\nKm6r7YmwfLN/YMZBHXSR58oOGP9W\\r\\n-----END CERTIFICATE-----',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/SSL/get_cn_name":{"get":{"description":"This function retrieves the most secure domain for a service.","operationId":"get_cn_name","parameters":[{"description":"A domain name, cPanel username, or email address.","example":"example.com","in":"query","name":"domain","required":true,"schema":{"anyOf":[{"description":"A valid domain.","format":"domain","type":"string"},{"description":"A valid email address.","format":"email","type":"string"},{"description":"A valid cPanel username.","format":"username","type":"string"}]}},{"description":"The service's name.\n\n* `cpanel`\n* `imap`\n* `pop3`\n* `smtp`","in":"query","name":"service","required":true,"schema":{"enum":["cpanel","imap","pop3","smtp"],"example":"cpanel","type":"string"}},{"description":"Whether to append `mail` to the `domain` value to find the best match.\n\nFor example, if you specify the domain `example.com` and call this parameter, the\nfunction only searches the `mail.example.com` service domains.\n\n* `1` — Append `mail` to the `domain` value during the search.\n* `0` — Match on the specified `domain` value **only**.","in":"query","name":"add_mail_subdomain","required":false,"schema":{"default":0,"enum":[1,0],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_cn_name","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"properties":{"cert_match_method":{"description":"The method that the system used to match the certificate with the mail\nservice.\n\n* `none` — No domain matches the certificate.\n* `exact` — The domain exactly matches the certificate.\n* `exact-wildcard` — The domain exactly matches the certificate.\n* `mail-wildcard` — The `mail` subdomain of the domain matches the domain of the wildcard certificate.\n* `www-wildcard` — The `www` subdomain of the domain matches the domain of the wildcard certificate.\n* `hostname-wildcard` — The hostname's domain matches the domain of the wildcard certificate.\n* `hostname` — The hostname matches the domain of the certificate.\n* `localdomain_on_cert-mail-wildcard` — A `mail` subdomain of a domain on the server that matches the certificate.\n* `localdomain_on_cert-www-wildcard` — A `www` subdomain of a domain on the server matches the certificate.\n* `localdomain_on_cert` — A domain on the server matches the certificate.","enum":["none","exact","exact-wildcard","mail-wildcard","www-wildcard","hostname-wildcard","hostname","localdomain_on_cert-mail-wildcard","localdomain_on_cert-www-wildcard","localdomain_on_cert"],"example":"hostname","type":"string"},"cert_valid_not_after":{"description":"The certificate's expiration date.","example":1394288638,"format":"unix_timestamp","type":"integer"},"is_currently_valid":{"description":"Whether the certificate is currently valid.\n\n* `1` — Valid.\n* `0` — Invalid.\n\n**Note:**\n\nIf the certificate is valid, the following statements are true:\n  * The certificate is **not** self-signed (the `ssldomain_matches_cert` value is `1`).\n  * The certificate matches the SSL domain (the `ssldomain_matches_cert` value is `1`).\n  * The certificate is within its validity period (the `cert_valid_not_after` value is **less** than the current time and date).","enum":[1,0],"example":0,"type":"integer"},"is_self_signed":{"description":"Whether the certificate is self-signed.\n\n* `1` — Self-signed.\n* `0` — Not self-signed.\n\n**Note:**\n\nIf the `cert_match_method` value is `none`, you should ignore this return's value.","enum":[1,0],"example":1,"type":"integer"},"is_wild_card":{"description":"Whether the certificate is a wildcard certificate.\n\n* `1` — Wildcard.\n* `0` — Not a wildcard.","enum":[1,0],"example":0,"type":"integer"},"ssldomain":{"description":"The best domain to use to access the service.","example":"hostname.example.com","format":"domain","type":"string"},"ssldomain_matches_cert":{"description":"Whether an SSL-protected domain matches the certificate.\n\n* `1` — Matches.\n* `0` — Does **not** match.","enum":[1,0],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Request best SSL domain for service","tags":["SSL","cPanel Account SSL Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  get_cn_name \\\n  domain='example.com' \\\n  service='cpanel'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/get_cn_name?domain=example.com&service=cpanel"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_get_cn_name.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_get_cn_name.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/get_cn_name/,\n    {\n        'domain' => 'example.com',\n        'service' => 'cpanel',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_get_cn_name.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_get_cn_name.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'get_cn_name',\n    array (\n        'domain' => 'example.com',\n        'service' => 'cpanel',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/SSL/installed_host":{"get":{"description":"This function retrieves information about a certificate that is installed on a domain's dedicated IP address.\n\n**Important:**\n\n  * If you do **not** possess a dedicated IP address, this function will **fail**. For non-dedicated IP addresses, use the `SSL::installed_hosts` function.\n  * When you disable the _Calendars and Contacts_, _Receive Mail_, _Web Disk_ , _Webmail_ , **and**  _Web Server_ [roles](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"installed_host","parameters":[{"description":"The domain name.\n\n**Note:**\n\nThe parameter defaults to the account's main domain.","in":"query","name":"domain","required":false,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"Verify the certificate.\n* `1` — Verify the certificate.\n* `0` — Do **not** verify the certificate.","in":"query","name":"verify_certificate","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"installed_host","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"properties":{"certificate":{"description":"An object containing the certificate information.","properties":{"domains":{"description":"The domains that the certificate covers.","items":{"example":"example.com","format":"domain","type":"string"},"type":"array"},"ecdsa_curve_name":{"description":"The ECDSA curve that the certificate's key uses.\n\n* `prime256v1`\n* `secp384r1`\n* `null` — The certificate's key is **not** an ECDSA key.","enum":["prime256v1","secp384r1"],"example":null,"nullable":true,"type":"string"},"ecdsa_public":{"description":"The certificate's key's ECDSA compressed public point, in hexadecimal format.\n\n* `null` — The certificate's key is **not** an ECDSA key.","example":null,"nullable":true,"type":"string"},"id":{"description":"The certificate's ID.","example":"example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041","type":"string"},"is_self_signed":{"description":"Whether the certificate is self-signed.\n* `1` — Self-signed.\n* `0` — Not self-signed.","enum":[0,1],"example":1,"type":"integer"},"issuer.commonName":{"description":"The issuer's Common Name, typically a domain name.","example":"example.com","type":"string"},"issuer.organizationName":{"description":"The certificate's organization.","example":"Organization","type":"string"},"issuer_text":{"description":"The X.509 information about the issuer that contains CSR information.","example":"commonName\nexample.com\ncountryName\nUS\nemailAddress\nusername@example.com\norganizationName\nExample\nstateOrProvinceName\nTexas\nlocalityName\nHouston","type":"string"},"key_algorithm":{"description":"The certificate's key's algorithm.\n\n  * `rsaEncryption` — RSA.\n  * `id-ecPublicKey` — ECDSA.","enum":["rsaEncryption","id-ecPublicKey"],"example":"rsaEncryption","type":"string"},"modulus":{"description":"The certificate's key's modulus, in hexadecimal format.\n\n* `null` — The certificate's key is **not** an RSA key.","example":"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db","nullable":true,"type":"string"},"modulus_length":{"description":"The length, in bits, of the certificate's key's modulus.\n\n* `null` — The certificate's key is **not** an RSA key.","example":2048,"minimum":1,"nullable":true,"type":"integer"},"not_after":{"description":"The certificate's expiration time.","example":1397169490,"format":"unix_timestamp","type":"integer"},"not_before":{"description":"The certificate's start time.","example":1365633490,"format":"unix_timestamp","type":"integer"},"signature_algorithm":{"description":"The signature algorithm of the certificate.","example":"sha256WithRSAEncryption","type":"string"},"subject.commonName":{"description":"The certificate's Common Name.","example":"example.com","type":"string"},"subject_text":{"description":"The X.509 information about the certificate's subject that contains CSR information.","example":"commonName\nexample.com","type":"string"},"validation_type":{"description":"The certificate's validation type.\n* `ev` — Extended Validation.\n* `ov` — Organization Validation.\n* `dv` — Domain Validation.\n* `null` — The system could not parse and determine the certificate's validation type.","enum":["ev","ov","dv"],"example":"dv","nullable":true,"type":"string"},"verify_error":{"description":"Any errors that exist during the certificate verification process. If there are no errors, this will return an empty string.\n\n**Note:**\n\nYou **must** set the `verify_certificate` parameter to `1` for this return to appear.","example":"","type":"string"}},"type":"object"},"host":{"description":"The issuer's hostname.","example":"example.com","format":"domain","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return SSL certificate's info for dedicated IP","tags":["SSL","cPanel Account SSL Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  installed_host\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/installed_host"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_installed_host.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_installed_host.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/installed_host/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_installed_host.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_installed_host.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'installed_host'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/SSL/installed_hosts":{"get":{"description":"This function retrieves a list of the account's websites, their domains, and certificate information.\n\n**Important:**\n\n  For a dedicated IP address, use the UAPI `SSL::installed_host` function.\n\n**Important:**\n\n When you disable the *CalendarContact* , *MailReceive* , *WebDisk* , *Webmail* , and  *WebServer* [roles](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"installed_hosts","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"installed_hosts","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"certificate":{"description":"An object that contains information about each certificate.","properties":{"auto_ssl_provider":{"description":"The AutoSSL provider's name.","example":"cPanel","type":"string"},"auto_ssl_provider_display_name":{"description":"The AutoSSL provider's display name.","example":"Sectigo","type":"string"},"domains":{"description":"The domains that the certificate covers.","items":{"example":"example.com","format":"domain","type":"string"},"type":"array"},"ecdsa_curve_name":{"description":"The ECDSA curve that the certificate's key uses.\n\n* `prime256v1`\n* `secp384r1`\n* `null` — The certificate's key is **not** an ECDSA key.","enum":["prime256v1","secp384r1"],"example":null,"nullable":true,"type":"string"},"ecdsa_public":{"description":"The certificate's key's ECDSA compressed public point, in hexadecimal format.\n\n* `null` — The certificate's key is **not** an ECDSA key.","example":null,"nullable":true,"type":"string"},"id":{"description":"The certificate's ID.","example":"example_com_a74f7_9dddf_1446659822_eae1ff43c4ec1991e195877c55755eff","type":"string"},"is_autossl":{"description":"Whether the AutoSSL service provided the certificate.\n* `1` - Provided by the AutoSSL service.\n* `0` - Not provided by the AutoSSL service.","enum":[0,1],"example":1,"type":"integer"},"is_self_signed":{"description":"Whether the certificate is self-signed.\n* `1` - Self-signed.\n* `0` - Not self-signed.","enum":[0,1],"example":1,"type":"integer"},"issuer.commonName":{"description":"The name that issued the certificate.","example":"example.com","format":"domain","type":"string"},"issuer.organizationName":{"description":"The certificate's organization name.","example":"The Example Organization","type":"string"},"issuer_text":{"description":"The issuer's X.509 information.","example":"example.com\ncountryName\nUS\nemailAddress\nusername@example.com\norganizationName\nExample\nstateOrProvinceName\nTexas\nlocalityName\nHouston","type":"string"},"key_algorithm":{"description":"The certificate's key's algorithm.\n\n* `rsaEncryption` — RSA.\n* `id-ecPublicKey` — ECDSA.","enum":["rsaEncryption","id-ecPublicKey"],"example":"rsaEncryption","type":"string"},"modulus":{"description":"The certificate's key's modulus, in hexadecimal format.\n\n* `null` — The certificate's key is **not** an RSA key.","example":"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db","format":"hex","nullable":true,"type":"string"},"modulus_length":{"description":"The length, in bits, of the certificate's key's modulus.\n\n* `null` — The certificate's key is **not** an RSA key.","example":2048,"minimum":1,"nullable":true,"type":"integer"},"not_after":{"description":"When the certificate expired.","example":1446659822,"format":"unix_timestamp","type":"integer"},"not_before":{"description":"When the certificate started.","example":1415123822,"format":"unix_timestamp","type":"integer"},"signature_algorithm":{"description":"The signature algorithm of the certificate.","example":"sha256WithRSAEncryption","format":"sha256","type":"string"},"subject.commonName":{"description":"The certificate's common name.","example":"example.com","format":"domain","type":"string"},"subject_text":{"description":"The subject's X.509 information.","example":"commonName\nexample.com","type":"string"},"validation_type":{"description":"The certificate's validation type.\n\n**Note:**\n* `ev` -  Extended Validation.\n* `ov` - Organization Validation.\n* `dv` - Domain Validation.\n* null - The system could not parse and determine the certificate's validation type.","enum":["ev","ov","dv"],"example":"dv","nullable":true,"type":"string"}},"type":"object"},"certificate_text":{"description":"The certificate's text.","example":"-----BEGIN CERTIFICATE-----\nMIIDcTCCAlmgAwIBAgIFAU+BNVgwDQYJKoZIhvcNAQEFBQAwUTESMBAGA1UEAwwJ\nc2lza28udGxkMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGY1BhbmVsMQswCQYDVQQI\nDAJUWDEQMA4GA1UEBwwHSG91c3RvbjAeFw0xNDEwMDYyMjI2MTlaFw0xNTEwMDYy\nMjI2MTlaMFExEjAQBgNVBAMMCXNpc2tvLnRsZDELMAkGA1UEBhMCVVMxDzANBgNV\nBAoMBmNQYW5lbDELMAkGA1UECAwCVFgxEDAOBgNVBAcMB0hvdXN0b24wggEiMA0G\nCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9zx6zGiHdmWA0dKtoXmJiWXpZ9E3P\nXx3YHsjFEWW7e5pH0vZ+jVMzDmm5nsJ7RXrAkZO1IvpIpVLvoQfiJOWVvkD+o9fW\nvoK1tWJS72FSgPju+58mA2ieBuc87A790Pzuv1P3NR3zFLAjUR99zkHR1fpri/da\nM3PBWO8ET48FWkyU1kOeZaUlF67/+wrEiNgg+t1qhKOCAB61PdNVkLaSGHimksuC\n+Czk8Kq9nuS0E0TCnDtjjEyJ455FUcaCfczlTb8xkB/F9ORe74yTzD+vlk0tFMG6\nPLj/ajIwWqwO0qmQ8wX3NRxkWgGz5kVO1wrVJarKQ5EYQ3/mgvit0v6dAgMBAAGj\nUDBOMB0GA1UdDgQWBBRw+wKBo34+bgexjAa3EMDsgSCd7zAfBgNVHSMEGDAWgBRw\n+wKBo34+bgexjAa3EMDsgSCd7zAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUA\nA4IBAQCHRXIs53opzKM2rM8Qe8lcw524WK6hqy2EWrZHp78N7rU7/6DQ/I3hv3Wh\ncDDIO04I2/Xhe88MLBaLoM367Ya+vy7CaLr14aLi/SfQszMA0ALBvMao+Fis0iVw\nFYq/NLgSXw+fgnpFskt8v8iQZ+4Kaal8U8e9sVgu8m0RgO7rzym1eRiIKpsKd1rh\n/SD7LbSN7M7TRL3QqF7ltw9sQhAAsQcRaBBF21pdWrqhiGZ+Eioo3hhgwNavH2ag\nqz78ddHwrFpHFwrEeUk1OfpPb76MYIce7xIy/4oQNdg6fOq4l/FrajBv+WkzDVPa\nKm6r7YmwfLN/YMZBHXSR58oOGP9W\n-----END CERTIFICATE-----","format":"pem-certificate","type":"string"},"docroot":{"description":"The document root of the domain that the certificate covers.","example":"/home/username/public_html","format":"path","type":"string"},"domains":{"description":"The domains that the certificate covers.","items":{"example":"example.com","format":"domain","type":"string"},"type":"array"},"fqdns":{"description":"An array of every valid fully qualified domain\nname (FQDN) on the virtual host, which includes service\nsubdomains (proxy subdomains).","items":{"example":"www.example.com","format":"domain","type":"string"},"type":"array"},"ip":{"description":"The host's IP address.","example":"192.168.0.1","oneOf":[{"format":"ipv4","type":"string"},{"format":"ipv6","type":"string"}]},"is_primary_on_ip":{"description":"Whether the website is primary on the IP address.\n* `1` - Primary.\n* `0` - Not primary.","enum":[0,1],"example":1,"type":"integer"},"mail_sni_status":{"description":"Whether SNI is active on the domain.\n* `1` - Active.\n* `0` - Inactive.","enum":[0,1],"example":1,"type":"integer"},"needs_sni":{"description":"Whether the website requires SNI to function.\n* `1` - Requires SNI.\n* `0` - Does not require SNI.","enum":[0,1],"example":0,"type":"integer"},"servername":{"description":"The server's hostname.","example":"example.com","format":"domain","type":"string"}},"type":"object"},"properties":{},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return domains with SSL certificate information","tags":["SSL","cPanel Account SSL Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  installed_hosts\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/installed_hosts"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_installed_hosts.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_installed_hosts.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/installed_hosts/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_installed_hosts.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_installed_hosts.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'installed_hosts'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/SSL/is_mail_sni_supported":{"get":{"description":"This function checks whether the sslinstall feature is enabled.\n\n**Warning:**\n\nMail SNI is always enabled.\n* Mail SNI is **not** compatible with Webmail and will **not** function for any Webmail connection. Webmail connections use the cPanel service SSL certificate.\n* Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled.\n* Functions that disable Mail SNI will fail and make no changes.\n\n**Important:**\n\nWhen you disable the [Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"is_mail_sni_supported","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"is_mail_sni_supported","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"description":"Whether the sslinstall feature is enabled.\n* `1` - Enabled.\n* `0` - Disabled.","enum":[0,1],"example":1,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return whether mail SNI is enabled","tags":["SSL","SNI Email Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  is_mail_sni_supported\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/is_mail_sni_supported"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_is_mail_sni_supported.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_is_mail_sni_supported.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/is_mail_sni_supported/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_is_mail_sni_supported.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_is_mail_sni_supported.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'is_mail_sni_supported'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.48"}},"/SSL/is_sni_supported":{"get":{"description":"This function checks whether the Apache web server supports SNI.\n\n**Important:**\n\nWhen you disable the [Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"is_sni_supported","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"is_sni_supported","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"description":"Whether the Apache web server supports SNI.\n* `1` - Supported.\n* `0` - **Not** supported.","enum":[0,1],"example":1,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return whether Apache web server supports mail SNI","tags":["SSL","SNI Email Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  is_sni_supported\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/is_sni_supported"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_is_sni_supported.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_is_sni_supported.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/is_sni_supported/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_is_sni_supported.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_is_sni_supported.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'is_sni_supported'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/SSL/list_certs":{"get":{"description":"This function lists an account's certificates.\n\n**Important:**\n\nWhen you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail,\nand Web Server [roles](https://go.cpanel.net/howtouseserverprofiles#roles),\nthe system **disables** this function.","operationId":"list_certs","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_certs","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"created":{"description":"The date the certificate was created.","example":1569884400,"format":"unix_timestamp","type":"integer"},"domain_is_configured":{"description":"Whether the certificate is installed on the account.\n\n* `1` — Installed.\n* `0` — Not installed.","enum":[1,0],"example":1,"type":"integer"},"domains":{"description":"A list of domains that the certificate covers.","items":{"example":"example.com","type":"string"},"type":"array"},"ecdsa_curve_name":{"description":"The ECDSA curve that the certificate's key uses.\n\n* `prime256v1`\n* `secp384r1`\n* `null` — The certificate's key is **not** an ECDSA key.","enum":["prime256v1","secp384r1"],"example":null,"nullable":true,"type":"string"},"ecdsa_public":{"description":"The certificate's key's ECDSA compressed public point, in hexadecimal format.\n\n* `null` — The certificate's key is **not** an ECDSA key.","example":null,"nullable":true,"type":"string"},"friendly_name":{"description":"The certificate's friendly name.","example":"TestCert","type":"string"},"id":{"description":"The certificate's ID.","example":"example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041","type":"string"},"is_self_signed":{"description":"Whether the certificate is self-signed.\n\n* `1` — Self-signed.\n* `0` — Not self-signed.","enum":[1,0],"example":1,"type":"integer"},"issuer.commonName":{"description":"The issuer's name.","example":"example.com","type":"string"},"issuer.organizationName":{"description":"The certificate's organization.","example":"Organization","type":"string"},"issuer_text":{"description":"The certificate's issuer information.","example":"countryName\nUS\nstateOrProvinceName\nTX\nlocalityName\nHouston\norganizationName\nWebPros International, LLC\ncommonName\nWebPros International, LLC Certification Authority","type":"string"},"key_algorithm":{"description":"The certificate's key's algorithm.\n\n* `rsaEncryption` — RSA.\n* `id-ecPublicKey` — ECDSA.","enum":["rsaEncryption","id-ecPublicKey"],"example":"rsaEncryption","type":"string"},"modulus":{"description":"The certificate's key's modulus, in hexadecimal format.\n\n* `null` — The certificate's key is **not** an RSA key.","example":"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db","nullable":true,"type":"string"},"modulus_length":{"description":"The length, in bits, of the certificate's key's modulus.\n\n* `null` — The certificate's key is **not** an RSA key.","example":2048,"nullable":true,"type":"integer"},"not_after":{"description":"The certificate's expiration date.","example":1601467200,"format":"unix_timestamp","type":"integer"},"not_before":{"description":"The certificate's start date.","example":1569844800,"format":"unix_timestamp","type":"integer"},"serial":{"description":"The certificate's serial number.","example":"45462cd0d6537b20cf2f3eb8aec07140","type":"string"},"signature_algorithm":{"description":"The OID hash algorithm signature of the certificate.","example":"sha256WithRSAEncryption","type":"string"},"subject.commonName":{"description":"The certificate's Common Name (CN).","example":"example.com","type":"string"},"subject_text":{"description":"The certificate's subject text information.","example":"commonName\nwww.example.com","type":"string"},"validation_type":{"description":"The certificate's validation type.\n\n* `ev` — Extended Validation.\n* `ov` — Organization Validation.\n* `dv` — Domain Validation.\n* `null` — The system could not parse and determine the\ncertificate's validation type.","enum":["ev","ov","dv"],"example":"dv","nullable":true,"type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return all SSL certificates","tags":["SSL","cPanel Account SSL Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  list_certs\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/list_certs"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_list_certs.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_list_certs.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/list_certs/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_list_certs.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_list_certs.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'list_certs'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/SSL/list_keys":{"get":{"description":"This function lists an account's private keys.\n\n**Important:**\n\nWhen you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail,\nand Web Server [roles](https://go.cpanel.net/howtouseserverprofiles#roles),\nthe system **disables** this function.","operationId":"list_keys","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_keys","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"created":{"description":"The key's creation date.","example":1569844800,"format":"unix_timestamp","type":"integer"},"ecdsa_curve_name":{"description":"The ECDSA curve that the key uses.\n\n* `prime256v1`\n* `secp384r1`\n* `null` — The key is **not** an ECDSA key.","enum":["prime256v1","secp384r1"],"example":null,"nullable":true,"type":"string"},"ecdsa_public":{"description":"The key's ECDSA compressed public point, in hexadecimal format.\n\n* `null` — The key is **not** an ECDSA key.","example":null,"nullable":true,"type":"string"},"friendly_name":{"description":"The key's friendly name.","example":"TestKey","type":"string"},"id":{"description":"The key ID.","example":"b116e_473f5_ad6b3bd9517fb157830d0e37a03bc596","type":"string"},"key_algorithm":{"description":"The key's algorithm.\n\n* `rsaEncryption` — RSA.\n* `id-ecPublicKey` — ECDSA.","enum":["rsaEncryption","id-ecPublicKey"],"example":"rsaEncryption","type":"string"},"modulus":{"description":"The key's modulus, in hexadecimal format.\n\n* `null` — The key is **not** an RSA key.","example":"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db","nullable":true,"type":"string"},"modulus_length":{"description":"The length, in bits, of the key's modulus.\n\n* `null` — The key is **not** an RSA key.","example":2048,"minimum":1,"nullable":true,"type":"integer"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return all private keys","tags":["SSL","cPanel Account SSL Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  list_keys\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/list_keys"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_list_keys.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_list_keys.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/list_keys/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_list_keys.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_list_keys.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'list_keys'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/SSL/list_ssl_items":{"get":{"description":"This function lists SSL-related items on a domain.\n\n**Important:**\n\nWhen you disable the [Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles](https://go.cpanel.com/serverroles), the system **disables** this function.","operationId":"list_ssl_items","parameters":[{"description":"The domain name or names.","examples":{"multiple":{"summary":"Multiple domains.","value":"domains=example1.com|example2.com"},"single":{"summary":"A single domain.","value":"example.com"}},"in":"query","name":"domains","required":false,"schema":{"type":"string"}},{"description":"The SSL item type or types.\n* `key`\n* `csr`\n* `crt`","examples":{"multiple":{"summary":"Multiple item types.","value":"item=key|csr"},"single":{"summary":"A single item type.","value":"key"}},"in":"query","name":"item","required":false,"schema":{"default":"key","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_ssl_items","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"host":{"description":"The hostname.","example":"example.com","format":"domain","type":"string"},"id":{"description":"The certificate's ID.","example":"example_com_a74f7_9dddf_1446659822_eae1ff43c4ec1991e195877c55755eff","type":"string"},"type":{"description":"The type of SSL item.\n* `key`\n* `csr`\n* `crt`","enum":["key","csr","crt"],"example":"key","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return SSL-related items","tags":["SSL","cPanel Account SSL Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  list_ssl_items\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/list_ssl_items"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_list_ssl_items.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_list_ssl_items.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/list_ssl_items/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_list_ssl_items.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_list_ssl_items.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'list_ssl_items'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/SSL/list_csrs":{"get":{"description":"This function lists an account's certificate signing requests (CSR).\n\n**Important:**\n\nWhen you disable the Calendars and Contacts, Receive Mail, Web Disk,\nWebmail, and Web Server\n[roles](https://go.cpanel.net/howtouseserverprofiles#roles),\nthe system **disables** this function.","operationId":"list_csrs","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_csrs","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"commonName":{"description":"The CSR's Common Name or Distinguished Name.","example":"example.com","type":"string"},"created":{"description":"The CSR's creation date.","example":1538265600,"format":"unix_timestamp","type":"integer"},"domains":{"description":"A list of the domains that the CSR covers.","items":{"example":"example.com","format":"domain","type":"string"},"type":"array"},"ecdsa_curve_name":{"description":"The ECDSA curve that the CSR's key uses.\n\n* `prime256v1`\n* `secp384r1`\n* `null` — The CSR's key is **not** an ECDSA key.","enum":["prime256v1","secp384r1"],"example":null,"nullable":true,"type":"string"},"ecdsa_public":{"description":"The CSR's key's ECDSA compressed public point, in hexadecimal format.\n\n* `null` — The CSR's key is **not** an ECDSA key.","example":null,"nullable":true,"type":"string"},"friendly_name":{"description":"The CSR's friendly name.","example":"TestCSR","type":"string"},"id":{"description":"The CSR's ID.","example":"example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041","type":"string"},"key_algorithm":{"description":"The CSR's key's algorithm.\n\n* `rsaEncryption` — RSA.\n* `id-ecPublicKey` — ECDSA.","enum":["rsaEncryption","id-ecPublicKey"],"example":"rsaEncryption","type":"string"},"modulus":{"description":"The CSR's key's modulus, in hexadecimal format.\n\n* `null` — The CSR's key is **not** an RSA key.","example":"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db","nullable":true,"type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return all certificate signing requests","tags":["SSL","cPanel Account SSL Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  list_csrs\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/list_csrs"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_list_csrs.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_list_csrs.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/list_csrs/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_list_csrs.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_list_csrs.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'list_csrs'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/SSL/mail_sni_status":{"get":{"description":"This function retrieves the status of the domain's SNI mail services.\n\n**Warning:**\n\nMail SNI is **not** compatible with Webmail and will not function for any Webmail connection. Webmail connections use the cPanel service SSL certificate.\n\n**Note:**\n\nMail SNI is always enabled.\n* Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled.\n* Functions that disable Mail SNI fail and make no changes.","operationId":"mail_sni_status","parameters":[{"description":"The account's domain.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"mail_sni_status","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"properties":{"enabled":{"description":"Whether SNI for mail is enabled.\n* `1` - SNI is enabled.\n* `0` - SNI is **not** enabled.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return status of domain's SNI mail services","tags":["SSL","SNI Email Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  mail_sni_status \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/mail_sni_status?domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_mail_sni_status.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_mail_sni_status.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/mail_sni_status/,\n    {\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_mail_sni_status.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_mail_sni_status.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'mail_sni_status',\n    array (\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.48"}},"/SSL/is_autossl_check_in_progress":{"get":{"description":"This function verifies whether the `autossl_check` task is in progress for the current user.\n\n**Important:**\n\nWhen you disable the [Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"is_autossl_check_in_progress","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"is_autossl_check_in_progress","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"description":"Whether the `autossl_check` task is in progress for the current user.\n* `1` - In progress.\n* `0` - **Not** currently in progress.","enum":[0,1],"example":1,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return whether AutoSSL check in progress","tags":["SSL","Auto-generated SSL Certificates"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  is_autossl_check_in_progress\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/is_autossl_check_in_progress"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_is_autossl_check_in_progress.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_is_autossl_check_in_progress.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/is_autossl_check_in_progress/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_is_autossl_check_in_progress.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_is_autossl_check_in_progress.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'is_autossl_check_in_progress'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 68"}},"/SSL/rebuild_mail_sni_config":{"get":{"description":"This function rebuilds the SNI configuration files.\n\n**Note:**\n\n* You **must** run this function after you change the SNI status through the UAPI's `enable_mail_sni` or `disable_mail_sni` functions.\n* Mail SNI is **always** enabled.\n  * Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled. Functions that disable Mail SNI fail and make no changes.\n  * Functions that disable Mail SNI will fail and make no changes.\n\n**Important:**\n\n When you disable the _Calendars and Contacts_, _Receive Mail_, _Web Disk_, _Webmail_, **and**  _Web Server_ [roles](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"rebuild_mail_sni_config","parameters":[{"description":"Whether to reload the Dovecot service after the system rebuilds\nthe configuration files.\n* `1` - Reload Dovecot.\n* `0` - Do **not** reload Dovecot.","in":"query","name":"reload_dovecot","required":false,"schema":{"default":1,"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"rebuild_mail_sni_config","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"properties":{"success":{"description":"Whether the system rebuilt the configuration files.\n* `1` - Configuration files rebuilt.\n* `0` - Configuration files **not** rebuilt.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Start SNI configuration files rebuild","tags":["SSL","SNI Email Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  rebuild_mail_sni_config\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/rebuild_mail_sni_config"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_rebuild_mail_sni_config.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_rebuild_mail_sni_config.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/rebuild_mail_sni_config/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_rebuild_mail_sni_config.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_rebuild_mail_sni_config.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'rebuild_mail_sni_config'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.48"}},"/SSL/remove_autossl_excluded_domains":{"get":{"description":"This function enables AutoSSL for the domains that you specify.\n\n**Important:**\n\nWhen you disable the [Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"remove_autossl_excluded_domains","parameters":[{"description":"Enable AutoSSL for this domain.","examples":{"multiple":{"summary":"Multiple domains.","value":"domains=example1.com,example2.com"},"single":{"summary":"A single domain.","value":"example.com"}},"in":"query","name":"domains","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"remove_autossl_excluded_domains","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable AutoSSL for specifed domains","tags":["SSL","Auto-generated SSL Certificates"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  remove_autossl_excluded_domains \\\n  domains='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/remove_autossl_excluded_domains?domains=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_remove_autossl_excluded_domains.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_remove_autossl_excluded_domains.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/remove_autossl_excluded_domains/,\n    {\n        'domains' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_remove_autossl_excluded_domains.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_remove_autossl_excluded_domains.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'remove_autossl_excluded_domains',\n    array (\n        'domains' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 66"}},"/SSL/rebuildssldb":{"get":{"description":"This function rebuilds the account's SSL database.","operationId":"rebuildssldb","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"rebuildssldb","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success.\n- 0 - Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Start SSL database rebuild","tags":["SSL","cPanel Account SSL Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  rebuildssldb\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/rebuildssldb"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_rebuildssldb.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_rebuildssldb.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/rebuildssldb/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_rebuildssldb.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_rebuildssldb.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'rebuildssldb'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/SSL/set_autossl_excluded_domains":{"get":{"description":"This function disables AutoSSL for every domain that you specify.\n\n**Warning:**\n\nThis function **replaces** the list of any domains that you previously excluded. To add domains to the list of excluded domains, use the UAPI function `SSL::add_autossl_excluded_domains`.\n\n**Important:**\n\nWhen you disable the the [Calendar and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"set_autossl_excluded_domains","parameters":[{"description":"A comma-separated list of domains for which to disable AutoSSL.\n\n**Note:**\n\nIf you do not include this parameter, the function will **enable** AutoSSL for every domain on the account.","in":"query","name":"domains","required":false,"schema":{"example":"example.com,example.net","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_autossl_excluded_domains","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"enum":[null],"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Disable AutoSSL for specifed domains","tags":["SSL","Auto-generated SSL Certificates"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  set_autossl_excluded_domains\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/set_autossl_excluded_domains"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_set_autossl_excluded_domains.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_set_autossl_excluded_domains.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/set_autossl_excluded_domains/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_set_autossl_excluded_domains.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_set_autossl_excluded_domains.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'set_autossl_excluded_domains'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 66"}},"/SSL/set_cert_friendly_name":{"get":{"description":"This function changes a certificate's friendly name.\n\n**Important:**\n\nWhen you disable the [Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"set_cert_friendly_name","parameters":[{"description":"The certificate's friendly name.","in":"query","name":"friendly_name","required":true,"schema":{"example":"TestCert","type":"string"}},{"description":"The certificate's new friendly name.","in":"query","name":"new_friendly_name","required":true,"schema":{"example":"TestCert2","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_cert_friendly_name","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update SSL certificate's friendly name","tags":["SSL","SSL Certificate Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  set_cert_friendly_name \\\n  friendly_name='TestCert' \\\n  new_friendly_name='TestCert2'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/set_cert_friendly_name?friendly_name=TestCert&new_friendly_name=TestCert2"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_set_cert_friendly_name.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_set_cert_friendly_name.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/set_cert_friendly_name/,\n    {\n        'friendly_name' => 'TestCert',\n        'new_friendly_name' => 'TestCert2',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_set_cert_friendly_name.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_set_cert_friendly_name.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'set_cert_friendly_name',\n    array (\n        'friendly_name' => 'TestCert',\n        'new_friendly_name' => 'TestCert2',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/DynamicDNS/create":{"get":{"description":"This function creates a Dynamic DNS (DDNS) domain.\n\n**Important:**\n\nWhen you disable the [_DNS_ role](https://go.cpanel.net/serverroles), the system disables this function.","operationId":"dynamicdns-create","parameters":[{"description":"The fully-qualified domain name to create as a DDNS domain.","in":"query","name":"domain","required":true,"schema":{"example":"home.example.com","format":"domain","type":"string"}},{"description":"A human-readable string that describes the domain.","in":"query","name":"description","required":false,"schema":{"example":"Home network","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"create","type":"string"},"module":{"description":"The name of the module called.","example":"DynamicDNS","type":"string"},"result":{"properties":{"data":{"description":"Information about the newly-created DDNS domain.","properties":{"created_time":{"description":"The creation time of the Dynamic DNS domain.","format":"unix_timestamp","type":"integer"},"id":{"description":"The DDNS domain’s ID.","example":"ggiugyxxjwnkmqtwysgmvrurplmafxpq","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create Dynamic DNS domain","tags":["DynamicDNS","Dynamic DNS"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DynamicDNS \\\n  create \\\n  domain='home.example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DynamicDNS/create?domain=home.example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DynamicDNS_create.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DynamicDNS_create.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DynamicDNS/,\n    q/create/,\n    {\n        'domain' => 'home.example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DynamicDNS_create.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DynamicDNS_create.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DynamicDNS',\n    'create',\n    array (\n        'domain' => 'home.example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":82}},"/SSL/set_csr_friendly_name":{"get":{"description":"This function changes a certificate signing request's (CSR) friendly name.\n\n**Important:**\n\n* You **must** call either the `friendly_name` or `id` parameter.\n* When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server [roles](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"set_csr_friendly_name","parameters":[{"description":"The CSR's friendly name.","in":"query","name":"friendly_name","required":true,"schema":{"example":"TestCSR","type":"string"}},{"description":"The CSR's ID.\n\n**Note:**\n\nTo retrieve a CSR's ID, use the UAPI `list_csrs` function.","in":"query","name":"id","required":true,"schema":{"example":"example_com_eda9d_543fb_a3009b4b01a592390866ab3a47c0df18","type":"string"}},{"description":"The CSR's new friendly name.","in":"query","name":"new_friendly_name","required":true,"schema":{"example":"TestCSR2","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_csr_friendly_name","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update certificate signing request's friendly name","tags":["SSL","SSL Certificate Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  set_csr_friendly_name \\\n  friendly_name='TestCSR' \\\n  id='example_com_eda9d_543fb_a3009b4b01a592390866ab3a47c0df18' \\\n  new_friendly_name='TestCSR2'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/set_csr_friendly_name?friendly_name=TestCSR&id=example_com_eda9d_543fb_a3009b4b01a592390866ab3a47c0df18&new_friendly_name=TestCSR2"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_set_csr_friendly_name.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_set_csr_friendly_name.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/set_csr_friendly_name/,\n    {\n        'friendly_name' => 'TestCSR',\n        'id' => 'example_com_eda9d_543fb_a3009b4b01a592390866ab3a47c0df18',\n        'new_friendly_name' => 'TestCSR2',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_set_csr_friendly_name.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_set_csr_friendly_name.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'set_csr_friendly_name',\n    array (\n        'friendly_name' => 'TestCSR',\n        'id' => 'example_com_eda9d_543fb_a3009b4b01a592390866ab3a47c0df18',\n        'new_friendly_name' => 'TestCSR2',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/SSL/set_key_friendly_name":{"get":{"description":"This function changes a key's friendly name.\n\n**Important:**\n\n* You **must** call either the `friendly_name` or `id` parameter.\n* When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server [roles](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"set_key_friendly_name","parameters":[{"description":"The key's friendly name.","in":"query","name":"friendly_name","required":true,"schema":{"example":"TestKey","type":"string"}},{"description":"The key's ID.","in":"query","name":"id","required":true,"schema":{"example":"a9b72_63971_2cb6d8897b362cfb1548e047d8428b8d","type":"string"}},{"description":"The key's new friendly name.","in":"query","name":"new_friendly_name","required":true,"schema":{"example":"TestKey2","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_key_friendly_name","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update private key's friendly name","tags":["SSL","SSL Certificate Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  set_key_friendly_name \\\n  friendly_name='TestKey' \\\n  id='a9b72_63971_2cb6d8897b362cfb1548e047d8428b8d' \\\n  new_friendly_name='TestKey2'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/set_key_friendly_name?friendly_name=TestKey&id=a9b72_63971_2cb6d8897b362cfb1548e047d8428b8d&new_friendly_name=TestKey2"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_set_key_friendly_name.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_set_key_friendly_name.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/set_key_friendly_name/,\n    {\n        'friendly_name' => 'TestKey',\n        'id' => 'a9b72_63971_2cb6d8897b362cfb1548e047d8428b8d',\n        'new_friendly_name' => 'TestKey2',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_set_key_friendly_name.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_set_key_friendly_name.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'set_key_friendly_name',\n    array (\n        'friendly_name' => 'TestKey',\n        'id' => 'a9b72_63971_2cb6d8897b362cfb1548e047d8428b8d',\n        'new_friendly_name' => 'TestKey2',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/SSL/set_primary_ssl":{"get":{"description":"This function sets a new primary SSL website for a dedicated IP address.\n\n**Important:**\n\nWhen you disable the [Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"set_primary_ssl","parameters":[{"description":"The primary SSL website's servername.","in":"query","name":"servername","required":true,"schema":{"example":"hostname.example.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_primary_ssl","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update SSL website for dedicated IP address","tags":["SSL","SSL Certificate Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  set_primary_ssl \\\n  servername='hostname.example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/set_primary_ssl?servername=hostname.example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_set_primary_ssl.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_set_primary_ssl.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/set_primary_ssl/,\n    {\n        'servername' => 'hostname.example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_set_primary_ssl.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_set_primary_ssl.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'set_primary_ssl',\n    array (\n        'servername' => 'hostname.example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/SSL/show_cert":{"get":{"description":"This function retrieves a certificate.\n\n**Note:**\n\nWhen you call this parameter, you **must** include either the `id` or\nthe `friendly_name` parameter.\n\n**Important:**\n\nWhen you disable the Calendars and Contacts, Receive Mail, Web Disk,\nWebmail, **and** Web Server [roles](https://go.cpanel.net/howtouseserverprofiles#roles),\nthe system **disables** this function.","operationId":"show_cert","parameters":[{"description":"The certificate's ID.","in":"query","name":"id","required":false,"schema":{"example":"example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041","type":"string"}},{"description":"The certificate's friendly name.","in":"query","name":"friendly_name","required":false,"schema":{"example":"TestCert","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"show_cert","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"properties":{"cert":{"description":"The contents of the certificate.","example":"-----BEGIN CERTIFICATE-----MIIDcTCCAlmgAwIBAgIFAU+BNVgwDQYJKoZIhvcNAQEFBQAwUTESMBAGA1UEAwwJc2lza28udGxkMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGY1BhbmVsMQswCQYDVQQIDAJUWDEQMA4GA1UEBwwHSG91c3RvbjAeFw0xNDEwMDYyMjI2MTlaFw0xNTEwMDYyMjI2MTlaMFExEjAQBgNVBAMMCXNpc2tvLnRsZDELMAkGA1UEBhMCVVMxDzANBgNVBAoMBmNQYW5lbDELMAkGA1UECAwCVFgxEDAOBgNVBAcMB0hvdXN0b24wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9zx6zGiHdmWA0dKtoXmJiWXpZ9E3PXx3YHsjFEWW7e5pH0vZ+jVMzDmm5nsJ7RXrAkZO1IvpIpVLvoQfiJOWVvkD+o9fWvoK1tWJS72FSgPju+58mA2ieBuc87A790Pzuv1P3NR3zFLAjUR99zkHR1fpri/daM3PBWO8ET48FWkyU1kOeZaUlF67/+wrEiNgg+t1qhKOCAB61PdNVkLaSGHimksuC+Czk8Kq9nuS0E0TCnDtjjEyJ455FUcaCfczlTb8xkB/F9ORe74yTzD+vlk0tFMG6PLj/ajIwWqwO0qmQ8wX3NRxkWgGz5kVO1wrVJarKQ5EYQ3/mgvit0v6dAgMBAAGj\\UDBOMB0GA1UdDgQWBBRw+wKBo34+bgexjAa3EMDsgSCd7zAfBgNVHSMEGDAWgBRw+wKBo34+bgexjAa3EMDsgSCd7zAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUAA4IBAQCHRXIs53opzKM2rM8Qe8lcw524WK6hqy2EWrZHp78N7rU7/6DQ/I3hv3WhcDDIO04I2/Xhe88MLBaLoM367Ya+vy7CaLr14aLi/SfQszMA0ALBvMao+Fis0iVwFYq/NLgSXw+fgnpFskt8v8iQZ+4Kaal8U8e9sVgu8m0RgO7rzym1eRiIKpsKd1rh/SD7LbSN7M7TRL3QqF7ltw9sQhAAsQcRaBBF21pdWrqhiGZ+Eioo3hhgwNavH2agqz78ddHwrFpHFwrEeUk1OfpPb76MYIce7xIy/4oQNdg6fOq4l/FrajBv+WkzDVPaKm6r7YmwfLN/YMZBHXSR58oOGP9W-----END CERTIFICATE-----","format":"pem-certificate","type":"string"},"details":{"description":"An object containing the certificate's details.","properties":{"domains":{"description":"A list of the certificate's domains.","items":{"example":"example.com","format":"domain","type":"string"},"type":"array"},"ecdsa_curve_name":{"description":"The ECDSA curve that the certificate's key uses.\n\n* `prime256v1`\n* `secp384r1`\n* `null` — The certificate's key is **not** an ECDSA key.","enum":["prime256v1","secp384r1"],"example":null,"nullable":true,"type":"string"},"ecdsa_public":{"description":"The certificate's key's ECDSA compressed public point, in hexadecimal format.\n\n* `null` — The certificate's key is **not** an ECDSA key.","example":null,"nullable":true,"type":"string"},"friendly_name":{"description":"The certificate's friendly name.","example":"TestCert","type":"string"},"id":{"description":"The certificate's ID.","example":"example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041","type":"string"},"is_self_signed":{"description":"Whether the certificate is self-signed.\n\n* `1` — Self-signed.\n* `0` — Not self-signed.","enum":[1,0],"example":1,"type":"integer"},"issuer":{"description":"A object that contains the issuer's details.","properties":{"commonName":{"description":"The issuer's Common Name or Distinguished Name.","example":"example.com","type":"string"},"countryName":{"description":"The certificate's two-letter country code.","example":"US","format":"ISO-3166-1 (alpha-2)","type":"string"},"emailAddress":{"description":"The issuer's email address.","example":"username@example.com","format":"email","type":"string"},"localityName":{"description":"The issuer's locality or city.","example":"Houston","type":"string"},"organizationName":{"description":"The issuer's organization name.","example":"Organization","type":"string"},"stateOrProvinceName":{"description":"The issuer's state or province name.","example":"Texas","type":"string"}},"type":"object"},"key_algorithm":{"description":"The certificate's key's algorithm.\n\n* `rsaEncryption` — RSA.\n* `id-ecPublicKey` — ECDSA.","enum":["rsaEncryption","id-ecPublicKey"],"example":"rsaEncryption","type":"string"},"modulus":{"description":"The certificate's key's modulus, in hexadecimal format.\n\n* `null` — The certificate's key is **not** an RSA key.","example":"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db","nullable":true,"type":"string"},"not_after":{"description":"The certificate's expiration date.","example":1601467200,"format":"unix_timestamp","type":"integer"},"not_before":{"description":"The certificate's start time.","example":1569844800,"format":"unix_timestamp","type":"integer"},"signature_algorithm":{"description":"The certificate's OID hash algorithm signature.","example":"sha256WithRSAEncryption","type":"string"},"subject":{"description":"An object containing the certificate's ownership details.","properties":{"commonName":{"description":"The certificate's Common Name or Distinguished Name.","example":"example.com","type":"string"},"countryName":{"description":"The certificate's two-letter country code.","example":"US","format":"ISO-3166-1 (alpha-2)","type":"string"},"emailAddress":{"description":"The certificate's email address.","example":"username@example.com","format":"email","type":"string"},"localityName":{"description":"The certificate's locality or city.","example":"Houston","type":"string"},"organizationName":{"description":"The certificate's organization name.","example":"Organization","type":"string"},"stateOrProvinceName":{"description":"The certificate's state or province name.","example":"Texas","type":"string"}},"type":"object"},"validation_type":{"description":"The certificate's validation type.\n\n* `ev` — Extended Validation.\n* `ov` — Organization Validation.\n* `dv` — Domain Validation.\n* `null` — The system could not parse and determine the\ncertificate's validation type.","enum":["ev","ov","dv"],"example":"dv","nullable":true,"type":"string"}},"type":"object"},"text":{"description":"The parsed information from the OpenSSL command-line tool.","example":"Certificate:\n Data:\n Version: 3 (0x2)\n Serial Number:\n d1:e8:74:8c:d0:69:d2:55\n Signature Algorithm: sha1WithRSAEncryption\n Issuer: CN = example.com, C = US, emailAddress = username@example.com, O = Example, ST = Texas, L = Houston\n Validity\n Not Before: Apr 10 22:38:10 2013 GMT\n Not After : Apr 10 22:38:10 2014 GMT\n Subject: CN = example.com, C = US, emailAddress = username@example.com, O = Example, ST = Texas, L = Houston\n Subject Public Key Info:\n Public Key Algorithm: rsaEncryption\n Public-Key: (2048 bit)\n Modulus:\n 00:c6:9c:e3:37:1a:fc:e6:1b:e4:29:4d:8e:ee:ec:\n bd:7a:52:12:ef: 34:71:64:77:e0:79:76:6d:ba:f0:\n 77:fd:f0:92:18:b0:84:c3:f7:12:3a:a9:b9:1d:16:\n 6c:a0:10:6d:f0:55:17:35:27:ff:81:a7:46:e6:d4:\n 36:97:34:01:3a:2f:6d:61:9a: 04:20:e3:fd:06:11:\n 8b:a4:5e:4f:6d:0d:93:8e:3b:cc:cb:19:b3:cb:74:\n 7a:54:82:ae:52:9e:46:31:7a:02:44:0b:7b:26:e8:\n 84:aa:91:2b:25:c1:42:0c:cc:5d:c4:d5: c4:cf:df:\n de:4c:7c:22:99:ab:06:79:99:16:1e:a7:49:5b:9b:\n 89:97:18:3c:1e:4b:c6:c5:b5:b2:9d:7d:be:b9:91:\n c6:08:38:7d:dc:81:18:2b:0c:2c:da:29:f4:aa:a2:\n 72:46:d9:c2:68:31:89:51:ab:32:af:7a:8d:9b:a7:\n d8:b8:b5:37:21:03:91:1d:4e:d8:fc:f1:0e:1f:96:\n 17:d6:90:25:c1:3a:1a:76:4c:9e:2b:7e:b9:9c:f5:\n 86:0a:cf:ea: 2f:eb:bc:33:ee:69:49:b9:c2:e6:a0:\n ef:ee:90:19:4a:2a:64:7e:ef:96:46:7e:7d:e2:35:\n ec:d9:cf:34:42:7a:3d:c1:22:b9:68:a2:b3:02:a3:\n 7f:f5\n Exponent: 65537 (0x10001)\n X509v3 extensions:\n X509v3 Subject Key Identifier:\n 6A:A1:EA:62:FB:B2:C4:AC:04:B0:43:DD:56:BE:8A:8D:FA:16:D3:F4\n X509v3 Authority Key Identifier:\n keyid:6A:A1:EA:62:FB:B2:C4:AC:04:B0:43:DD:56:BE:8A:8D:FA:16:D3:F4\n\n X509v3 Basic Constraints:\n CA:TRUE\n Signature Algorithm: sha1WithRSAEncryption\n 3c:1e:f7:3d:20:1b:a2:bd:5c:d6:0f:2a:9e:f3:b0:83:bf:a9:\n a0:90:9b:96:b1:a6:1e:8b:be:7c:f5:72:58:a0:48:3e:68: 43:\n 06:37:63:0a:cb:9c:23:98:c6:9e:f1:73:e8:4b:71:ac:07:fc:\n d0:5c:e1:55:4f:be:a7:75:5a:57:da:a1:c2:46:63:8f:3a:70:\n 4c:42:3c:03:4c:a0:47:a3:fc: ae:15:03:25:a5:78:63:a2:73:\n cd:47:d5:64:7c:d4:f5:85:f7:03:b8:b4:d8:95:75:6a:78:5c:\n e6:c7:69:02:7b:a4:fc:4d:8c:80:7b:c7:1c:71:04:ba:53:71:\n 7a: ce:00:cb:0e:5e:21:89:02:ba:90:02:8e:b5:79:8e:84:50:\n b0:21:63:b0:ac:19:80:c5:1d:a2:95:68:b7:ee:35:10:fa:db:\n f5:bf:b0:16:b1:34:76:f2:d6:ee:07:3b:6d:b6:0c:1d:b4:e5:\n 53:50:23:b8:c4:bf:fe:d6:77:ec:89:68:a0:d8:dd:f4:f5:fa:\n 7d:f6:c4:72:02:b1:e8:87:f7:e1:16:71:80:2e:e7:94:7b:eb:\n c6:a7:07:36:05:6d:34:b4:25:74:e9:c2:2c:9e:3d:bc:97:8e:\n 84:ce:cc:4f:1f:11:67:ad:30:f6:83:3e:be:bb:88:48:10:65:\n f7:4b:2f:80\n","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Export SSL certificate","tags":["SSL","SSL Certificate Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  show_cert\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/show_cert"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_show_cert.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_show_cert.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/show_cert/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_show_cert.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_show_cert.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'show_cert'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/SSL/show_key":{"get":{"description":"This function retrieves a private key.\n\n**Important:**\n\nWhen you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, **and** Web Server [roles](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"show_key","parameters":[{"description":"The key's ID.\n\n**Note:**\n\nYou **must** use either the `id` or the `friendly_name` parameter.","in":"query","name":"id","required":false,"schema":{"example":"example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041","type":"string"}},{"description":"The key's friendly name.\n\n**Note:**\n\nYou **must** use either the `id` or the `friendly_name` parameter.","in":"query","name":"friendly_name","required":false,"schema":{"example":"TestKey","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"show_key","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"properties":{"details":{"description":"An object of the key's details.","properties":{"created":{"description":"The key's creation date.","example":1365633415,"format":"unix_timestamp","type":"integer"},"ecdsa_curve_name":{"description":"The ECDSA curve that the key uses.\n\n* `prime256v1`\n* `secp384r1`\n* `null` — The key is **not** an ECDSA key.","enum":["prime256v1","secp384r1"],"example":null,"nullable":true,"type":"string"},"ecdsa_public":{"description":"The key's ECDSA compressed public point, in hexadecimal format.\n\n* `null` — The key is **not** an ECDSA key.","example":null,"nullable":true,"type":"string"},"friendly_name":{"description":"The key's friendly name.","example":"TestKey","type":"string"},"id":{"description":"The key's ID.","example":"example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041","type":"string"},"key":{"description":"The key's contents.","example":"-----BEGIN RSA PRIVATE KEY-----\nMIIJJwIBAAKCAgEA4yilqsoCdEpiNOyLcPJ4FLT7vgwaLdOBeJLTMUeV2uZM4v65\n/tiZe7H0soDp1C55SCr3uEIEa7Lq7RUZ+F5p67BgRR19rmerKGxfN7N5Vu97pfTw\nW1f+lVsxUF/56lVeoAmm4okU98xJHiGGlI8ZHGJbUMYfLPy0OrA+gNwMHqMVOv1B\nSgpbEWCILMvnvtp0rwPutjnPVX2Dj40ia40L4Wqvp+0Yg7mZyhIOl+q6VZVIdXZs\nlR4ZywfRBYt3ieFBDYMyNw9wN3Xy44fCpHc77+ho84W3BqrGaWSSDyf6UkZGD5mf\nohGf2JSp+c8J6H7hsxo7pta3K1diVXFOSfnaA+k56zW445XruwYs/SN/zvGetGi6\nuqhMAcVRQcYCmLCixcC6RkcUx3exxgR4q3gthDnFvWC4+NuTh8/K0BcxcuCEhRug\n/MfVfO3+f7RJFSJPFb9m9Lf4HHBSVkDP5WtG4XiBKCe++9Wuvxbd4QxS7YrnSopN\nKxkuHKswH8ONpADMYDqfLODMhNrslHNHu95Nv7AlQr8weLqMGWMp7GFqzXcl39Rn\nVkF4Bxd3bAAsMN8/JvanMKCPjTTDrfzVFZcmHXPYOljYDdY1xfIstYVtbyFkUHZP\n2RPPBaPUAt90lzrKGVF8a2vdIKRiey5SZ5qu9c/mGri3oz7Lkk7qkNPAqDMCAwEA\nAQKCAgA3f9raG3j2CKZt381Bzzvfc0h+al6LC736Q4Ut6RuH2/S1ER9IUItPWW87\nnZuDp8ciBr13W0nRNmmHezxZHlgqqXEb8dSfI90Bh1jMNyFSSDihl3KSHrGotBsc\nVBavViREXZdUicGBuXuxtkYno96yvKUq2v0K9MLkA+OBgEHFynqJaw7klBsj573d\nlAQO8TjI+eD8zKsHbB8Ul5rtRAy/Cl3YXWk75cDZSggevc7A0jRd3o0w8aXDoSlE\nfYq7OTm3n3JJWZBFPKAXTzgTDr6qItJhjS4IxXsq7RNyeIYES/8aGKKT6lJvjALr\ncdYt47IpHCOu447lG/h+f6xtDophLGZoAirO7lJFRVfLJh76sLF12bpXJKbbmMN+\naut0nM+MLEw8A5K9OV24jJ/3+afj//5789asIyvNaQFPOX23SdLX0QbA5QWvJt2t\nWvvpS3ubcIJaBEMTK8asEBC68eUW0BBKJaSiYNzecUFYCBjQlxKsIrYuWZoW6fMy\nRel+cnqMdiH7r2p6RmgF5c9myDwq3E47jE+VrOy8uhw7EMQvT8+YSKaIbgtFZcUS\nU02BDRB7gWNa842m6nGs5tj5xFNQ6Wt410vilTwL+6zCQqJaKmcdE3woiIgSdrw5\nMssAHHjqo7QJthZfbpUAUTc6jGPNO13U1ediIRAGdQW5ALqTwQKCAQEA884bmFFZ\nLTewHIv1PJFfNxVZfk3C7LhWE2JcI/5P/YrN4ZA8G08OYhgxqa5XnsHHQPwMM85i\n1HeOoPwqgTMIyLDX/Sf88+eW3ef4V2M1Y4op0ahWFEwbwXKGxOhncElObN7dfZUw\nVlxCReaiw2XQAGRqtQC0f+9dZysqPJr+Rz6poTiOtm7DcpW/WiGfBPvVhzBENyqo\nuL9V3vCWYPJSLtCexECoGoPSpHKgUkwbh3+ra8SfG6FOIBj4PpMB82R7oPDjIyXF\n1VDfb0EwYQlKxyZoP9+NPT2MhZv/hF/Mbm/5LolVHx92hO9q6yxS6nvaFmEPr9fY\n1EOTWzzPOA+VyQKCAQEA7oVioaTqxENt+wHITZq100iYUpm4X1N1eENTp97QyQbQ\nOVR/t8iGLUdvOZdIxBSTS3JFQ8TNcGDPPc+o319QGdZABNnKwFGY3Ss+5QgVeX6n\n0WKdxCRelUOUB174aBeXcJCKplh6xBUrLfSZxvZQQb7fv0Mb+2eKUBKTymvES1kp\nYdn1T0vCCHA3bVpaHuqliCoDSX3RmQICZlfSgCGBbAkmU8RuxDd9yR9l7O9MXUmL\nsqlsw6hvbUt+7Y13YlDtyX8gbCwEEYsoALOotY1xNfXnyZKTAXhrg+xsQLrURYZU\noZiCJyK/mHCWRTPVkt89wq4IexbJ9hqlRjzpmlr8GwKCAQBxRSCs855q06SOnreh\nHCkQfmrFs3sMX9gdyWTllBG1yfc9BLXoOiKEkJkCLG2o5H6eQnuo1go0jBdH0+Ar\nhnpeQ0sV4q4y4zXEgzFt6Dm1tUsYjQzxASskBQF4GkF0eZpmGmTtI5MBjHt93llg\nTr0EcaLh1SIHDj5m4DcPUTMyBnro3E3xlCRZ6Biu10/6EMZzuIj42Gjq7HoIyd4T\nzIFCHsqkgyWWrAgBPwAdPB7OJRKPTxpcy+RwJSmwaLxPSC/n5gKhIbt4D8q+9Zp0\nesyzGbT1d/c2rJHMwV1FMvzXkk5CwKs7enKl8FXMTRt4tXHtU8rl93JVq8+aY/Yi\nJZuBAoIBAERG2lz7IFjeFHVtpTDRwIqilTfP2P8wnMe4PhInrgxdbu16SrUJKZ98\ne1I5BBNc8G0AYONtSoGItMo0z1phpkQ/GERLM8aplOB6qJ5XGg6VOuStHgwvfQOt\nPIp/nQvu9OK7/XRwj3Phu2KESiCyEXdAdDwDsdbdZLJXHwcqoh4Pf9EK2zW/seNI\nfBVJb9K5yHiZzicTZRQvhxBUw2T6MloCpH4GFM8GM3OHEV4pgeqSSvLxnLjFVmAq\n5EKL5Ei4cdjkExvj3aZH90N8KicOPgH8SkVhN8OL/Prein5c/LaKJV+8kEUzpTS1\nxc45cEGCteMsfjD97QINzpG0jgopUVECggEADIaKsx8NUQT3hm0wHRanEFJnQH5H\nzxaQjWbsjm2uz0KROPNIK1X5L8kypsb+EzlJtvWUqxPaOaTv4DZVpFaVzk8/2PPG\nsYR3mUjqMqNFYMrNwYZAXvJ/huzDPqq6+w2Pn9jcAifHNw3S8UR650v8gl7BU4fV\nBvhamG8JelvwLqeGWoikST9NBXVqG5IKBpUkUiFOMUNmRih9ooKvhy7GosoK8MWb\nmhWo1v8TTSXSagACUhAoIzb6mMN/VFC5WDbFx5AEB/G9tq/zmTqQkuo39dvgl30w\nyZGRNwc1aFf1Kxeven10/JN9ipp0mTa7NYSdn0RAe9ZRp5cCkgmktqmB0g==\n-----END RSA PRIVATE KEY-----","format":"pem-private-key","type":"string"},"key_algorithm":{"description":"The key's algorithm.\n\n* `rsaEncryption` — RSA.\n* `id-ecPublicKey` — ECDSA.","enum":["rsaEncryption","id-ecPublicKey"],"example":"rsaEncryption","type":"string"},"modulus":{"description":"The key's modulus, in hexadecimal format.\n\n* `null` — The key is **not** an RSA key.","example":"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db","nullable":true,"type":"string"},"modulus_length":{"description":"The length, in bits, of the key's modulus.\n\n* `null` — The key is **not** an RSA key.","example":2048,"nullable":true,"type":"integer"}},"type":"object"},"text":{"description":"The raw information from the [OpenSSL](https://www.openssl.org/) command-line tool.","example":"Private-Key: (2048 bit)\nmodulus:\n 00:b1:16:ee:3e:de:ff:41:3c:f2:cb:b5:c5:0a:3d:\n    c8:0d:64:bc:02:9f:e1:90:c9:7f:da:e8:03:e6:2c:\n 47:9f:e4:ff:5e:0d:95:64:5d:32:c2:b7:c9:01:ae:\n    30:e5:17:da:82:78:f4:15:b9:46:40:eb:8b:99:5c:\n cc:4b:e4:2a:e4:ee:0e:28:29:01:79:ee:d4:90:bc:\n    5d:9e:ab:b0:46:7c:de:4f:df:b2:d7:d1:76:89:88:\n ad:f3:6c:36:f3:a0:07:8c:90:88:19:52:0a:68:a1:\n    4d:c0:26:9e:8d:53:70:91:83:87:f4:8a:d9:b5:0f:\n a7:ed:31:f3:8f:34:d2:ca:e7:d1:31:ea:42:17:5d:\n    4d:48:7d:b3:73:07:72:40:9a:58:55:c8:b3:b6:ff:\n c2:b5:f6:ba:64:bd:3e:06:62:42:cd:44:0b:d2:f1:\n    76:5e:bb:20:55:47:d4:10:86:2d:ec:6b:e7:d2:0e:\n 5d:99:48:ca:4d:66:35:e1:1a:db:1b:96:0a:41:64:\n    aa:c4:1b:1f:9d:90:e3:2e:aa:70:61:f7:77:b6:7b:\n f7:44:22:d8:73:0b:53:84:63:c3:f4:a4:19:e2:07:\n    f6:0b:42:8a:3d:70:cb:92:24:80:44:e7:36:5d:01:\n a2:e0:e5:cd:50:e1:f7:7c:5a:9a:b5:da:c4:0f:c4:\n    73:f5\npublicExponent: 65537 (0x10001)\nprivateExponent:\n 5b:c3:ae:21:16:1c:df:09:5e:27:01:41:e1:54:b2:\n    5d:7e:5d:8e:5e:9a:dc:14:0e:14:b9:35:8c:08:55:\n f5:1d:0c:d7:07:e2:e9:e7:01:6e:b5:1d:8b:a9:5f:\n    dc:d6:c7:7b:e4:81:56:e0:72:ef:21:1f:6d:91:10:\n ac:22:c7:b7:69:44:1c:bb:62:f0:74:39:e1:e6:39:\n    fd:06:aa:89:5c:1b:36:f8:8c:0c:19:96:7b:1e:40:\n 45:6b:45:ee:68:76:80:f8:44:0e:1a:dd:19:ea:bc:\n    07:5d:fb:ba:f0:09:dc:dd:73:8d:dc:85:83:b5:61:\n 27:20:43:3d:69:f9:f0:f9:e1:73:76:29:5a:b0:05:\n    23:65:47:e8:39:f0:21:be:17:84:73:0a:08:15:4e:\n 7b:e2:14:6a:72:c7:d3:13:ff:98:ee:96:c9:40:a3:\n    d3:0d:6c:90:48:25:7c:79:74:bf:be:fa:18:62:4d:\n c9:95:d4:d9:1a:47:59:4b:98:9a:2f:95:94:f4:4e:\n    78:cc:39:ef:9f:f7:6e:eb:db:cb:e5:95:ef:8f:ee:\n 5b:bf:c7:2a:29:e5:76:16:28:53:04:8e:ef:3f:66:\n    6f:34:a1:21:09:d6:da:ac:dd:ad:8c:2e:72:78:87:\n 01:45:f2:fa:3b:b9:23:2d:cf:5f:66:dc:c7:1c:0b:\n    e1\nprime1:\n 00:e9:14:c4:18:92:16:8e:ad:fd:cf:17:f0:8c:f7:\n 55:e0:58:3d:e3:cd:bd:4d:4e:00:64:ee:f0:cf:a5:\n    b0:14:19:85:ea:03:a8:be:18:78:34:3b:04:8c:b8:\n be:9a:ee:fc:0a:3e:6f:d2:8f:8f:fd:31:2d:02:97:\n    6e:bb:18:5b:9c:6a:85:6e:25:95:a4:40:4e:0b:91:\n a1:c3:85:bd:84:0c:d5:72:34:13:12:d9:20:56:52:\n    06:53:aa:06:2d:d0:61:2b:0b:d9:94:c6:d7:62:0f:\n c9:7d:17:cc:81:39:b3:59:e5:ce:77:d5:8a:82:ab:\n    2d:37:8a:51:49:3a:aa:c7:37\nprime2:\n 00:c2:80:b7:b4:85:25:37:30:b4:45:f3:3a:69:cf:\n    c3:86:43:89:db:d4:09:6b:72:54:a6:89:b4:a7:43:\n 3c:dd:da:c6:46:89:93:0a:05:9a:8c:d6:05:5c:6a:\n    4d:34:1e:84:5b:14:28:b7:ef:d2:be:a5:10:9c:5f:\n e7:35:fb:15:e2:9e:4a:60:0a:73:01:f0:55:6c:75:\n    25:8a:9b:b0:32:d3:28:41:11:e2:85:2d:f6:35:76:\n 6c:68:14:ba:02:98:44:82:e1:c6:ca:f7:07:78:ca:\n    ff:1a:60:3a:e1:88:91:55:a1:ae:11:46:29:4b:f0:\n 0f:e0:de:8a:0d:26:91:5c:33\nexponent1:\n    1d:2a:ad:13:4a:0c:aa:94:19:43:b6:02:33:11:ac:\n 5c:63:8e:73:18:46:cd:0a:aa:bf:f6:aa:89:c1:79:\n    14:3a:d1:68:24:47:14:6a:a9:78:17:be:8d:01:7d:\n 50:94:01:54:22:d6:09:6a:4f:a1:66:6a:f4:7d:10:\n    ad:36:f2:17:d3:b8:98:bc:f9:49:d1:86:32:aa:69:\n ac:b6:ea:ad:40:91:e1:35:a5:01:61:cc:4b:20:fe:\n    8b:af:a6:10:4b:98:2d:33:d1:69:6d:ac:7c:27:ef:\n 95:c8:c9:9d:8e:23:e4:66:fe:7c:3e:6b:93:c8:69:\n    e3:1e:5a:e7:a8:00:c0:e7\nexponent2:\n 6d:2e:3b:f0:c5:5c:a2:a2:60:4f:73:bd:32:70:41:\n    dd:38:44:46:75:bb:e3:e8:85:c4:06:40:b6:33:74:\n 13:45:1f:4f:b1:22:2c:da:00:6b:56:28:24:3c:37:\n    a2:2e:0f:35:e1:17:0a:49:41:0f:6b:30:eb:d6:99:\n bf:1f:76:a5:83:1d:54:d4:08:c2:e9:d9:c9:cb:e8:\n    8a:e9:e1:fa:65:b5:8e:f1:2f:2a:7b:26:5d:d4:5f:\n fd:fc:c4:7d:78:63:dc:e4:47:e6:de:cb:fe:ee:54:\n    4c:c5:ff:c7:62:15:d2:ef:b2:fa:57:5c:0f:18:6e:\n 91:57:da:3e:8f:8b:c1:29\ncoefficient:\n    00:bd:71:a9:3c:18:7b:0c:93:ab:d5:bf:f3:be:ea:\n 35:45:86:ce:60:0f:67:b3:2d:ba:5f:cf:9f:b6:1a:\n    13:27:cb:da:e7:ad:f3:c7:c2:06:7c:9e:00:d5:6c:\n 07:74:71:2c:35:39:c9:4b:24:cc:11:fd:60:c2:a2:\n    0b:28:b9:8b:4d:48:c6:0d:f0:39:34:dc:e2:c9:3a:\n b8:c6:64:0a:17:df:c4:f1:3d:fb:18:0b:af:ed:27:\n    3f:98:3b:e1:24:72:fc:5d:af:2c:e3:b6:07:3e:e1:\n 2f:fe:db:44:b0:8b:c3:e5:72:82:e5:a4:4a:3a:37:\n    8f:c4:9f:db:e9:1c:33:6a:f3\n","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success.\n- 0 - Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Export private key","tags":["SSL","SSL Certificate Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  show_key\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/show_key"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_show_key.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_show_key.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/show_key/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_show_key.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_show_key.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'show_key'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/SSL/start_autossl_check":{"get":{"description":"This function initiates an [AutoSSL](https://go.cpanel.net/whmdocsManageAutoSSL) check for the user.\n\n**Important:**\n\nWhen you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and  Web Server [roles](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"start_autossl_check","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"start_autossl_check","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success.\n- 0 - Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Start AutoSSL for current user","tags":["SSL","Auto-generated SSL Certificates"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  start_autossl_check\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/start_autossl_check"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_start_autossl_check.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_start_autossl_check.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/start_autossl_check/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_start_autossl_check.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_start_autossl_check.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'start_autossl_check'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 68"}},"/SSL/show_csr":{"get":{"description":"This function retrieves a certificate signing request (CSR).\n\n**Important:**\n\nWhen you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail,\nand Web Server [roles](https://go.cpanel.net/howtouseserverprofiles#roles),\nthe system **disables** this function.\n\n**Note:**\n\nWhen you call this function, you **must** include either the `id`\nor the `friendly_name` parameter.","operationId":"show_csr","parameters":[{"description":"The CSR's ID.","in":"query","name":"id","required":false,"schema":{"example":"example_com_e095f_0ab2f_ebcbe4a571276f48562241411556647f","type":"string"}},{"description":"The CSR's friendly name.","in":"query","name":"friendly_name","required":false,"schema":{"example":"TestCSR","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"show_csr","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"properties":{"csr":{"description":"The CSR's text.","example":"-----BEGIN CERTIFICATE REQUEST-----\nMIIC3TCCAcUCAQAwgZcxFDASBgNVBAMMC2V4YW1wbGUuY29tMRYwFAYDVQQLDA1E\nb2N1bWVudGF0aW9uMQswCQYDVQQGEwJVUzEiMCAGCSqGSIb3DQEJARYTbGF1cmVu\nY2VAY3BhbmVsLm5ldDEUMBIGA1UECgwLY1BhbmVsIEluYy4xDjAMBgNVBAgMBVRl\neGFzMRAwDgYDVQQHDAdIb3VzdG9uMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAp092NvpqyT7mg2qDqZW1XetQGeo217o9r7AOONaTrNsMgbL/d31rQzpC\nD65SPxJ/NSpovMi48tbue3A5W6+r2CN62oFk/d34N2swN1w11NTLzOfTPQgGnBe0\nCRdqNonx68l8Cwj+auRMGakqxtaESOfx0T87Ngr/1CIqUbTzU0LembWh+1VI5Djy\n2CRmRWKkSAAu7X/OJN7cfcPh7ReZc9Ha6VmzNxbutBDRcnCJVOAGMsv2Cg4mQZhg\nyMC8KF1r/ktHneDdGJdypdrmdr0qkqzMwTaYIb6M/93Yp+bswGH4oyqa4GYeTpRu\n2OOCeydxONOnYRZWfL0SnL2Gnvnd3wIDAQABoAAwDQYJKoZIhvcNAQEFBQADggEB\nAFlolzJbcviWcdZUv+PJ7G8cAqFAxa8a3W2a0Y1U0BaMrpDfuOHpQgOtO62rr+i+\nhkrIReuk7Isyl6GoZkX17KhQ1Vo9aW8a8Ur7+0RGDbxRlK9jJWnvSFn6cMMqRSfA\nDXpptxhqBFZJIZMc3pPX9Jqycuu8bxeIvUKeSMe3Jxcl1ZXEXX47FeRZxvd+WXF9\n4Xu4KZXHdzb5tB6jPhzIaN0/3d92N/KhvCcnw3YC2fEGDkpOlZaoa7O72+aq5K3b\nM1htFv9deAHqIHefV41iOrxUCIKIhdPIjvAm774lDHLzPpJVrshO/NpA74LEkny5\nFMwKKx+6Jgx1HSWucn5kWek=\n-----END CERTIFICATE REQUEST-----","type":"string"},"details":{"description":"An object contaning the CSR's contents.","properties":{"commonName":{"description":"The CSR's Common Name or Distinguished Name.","example":"example.com","type":"string"},"countryName":{"description":"The CSR's [ISO-3166](https://en.wikipedia.org/wiki/ISO_3166)\ncountry code.","example":"US","type":"string"},"created":{"description":"The CSR's creation date.","example":1538265600,"format":"unix_timestamp","type":"integer"},"domains":{"description":"A list of the domains that the CSR covers.","items":{"example":"example.com","type":"string"},"type":"array"},"emailAddress":{"description":"The CSR's email address.","example":"username@example.com","format":"email","type":"string"},"friendly_name":{"description":"The CSR's friendly name.","example":"TestCSR","type":"string"},"id":{"description":"The CSR's ID.","example":"example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041","type":"string"},"key_algorithm":{"description":"The key algorithm that encrypts the CSR.","example":"rsaEncryption","type":"string"},"localityName":{"description":"The certificate's locality or city.","example":"Houston","type":"string"},"modulus":{"description":"The CSR's modulus.","example":"a74f7636fa6ac93ee6836a83a995b55deb5019ea36d7ba3dafb00e38d693acdb0c81b2ff777d6b433a420fae523f127f352a68bcc8b8f2d6ee7b70395bafabd8237ada8164fdddf8376b30375c35d4d4cbcce7d33d08069c17b409176a3689f1ebc97c0b08fe6ae44c19a92ac6d68448e7f1d13f3b360affd4222a51b4f35342de99b5a1fb5548e438f2d824664562a448002eed7fce24dedc7dc3e1ed179973d1dae959b33716eeb410d172708954e00632cbf60a0e26419860c8c0bc285d6bfe4b479de0dd189772a5dae676bd2a92acccc1369821be8cffddd8a7e6ecc061f8a32a9ae0661e4e946ed8e3827b277138d3a76116567cbd129cbd869ef9dddf","nullable":true,"type":"string"},"organizationName":{"description":"The CSR's organization name.","example":"Organization","type":"string"},"organizationalUnitName":{"description":"The CSR's organizational unit name.","example":"Department","type":"string"},"stateOrProvinceName":{"description":"The CSR's state or province name.","example":"Texas","type":"string"}},"type":"object"},"text":{"description":"The parsed information from the OpenSSL command-line tool.","example":"Certificate Request:\n Data:\n Version: 0 (0x0)\n Subject: CN = example.com, C = US, emailAddress = username@example.com, O = Example, ST = Texas, L = Houston\n Subject Public Key Info:\n Public Key Algorithm: rsaEncryption\n Public-Key: (2048 bit)\n Modulus:\n 00:bf:44:22:cb:13:2b:7f:41:9f:48:85:d6:2c:77:\n 03:cf:84:db:90:5c:5a:ed:e5:9c:cb:d6:9d:4b:fc:\n 67:58:b7:db:71:dd:eb:8e:5a:77:6f:03:5d:96:85:\n 60:dc:91:45:59:85:ff:9e:57:76:a5:b5:cd:dc:48:\n 25:89:3f:8f:17:c1:c2:1e:4d:ec:f0:08:1a:a9:cc:\n 2d:45:34:be:82:77:a5:e4:bb:0b:82:bc:82:51:c3:\n ac:1b:ed:c3:a4:b3:e6:14:4f:ba:9e:39:af:08:ae:\n 3c:2c:15:bd:dc:03:17:93:01:95:4f:c0:2a:0f:3b:\n 46:5f:5e:6f:96:d5:b2:dd:53:22:a9:91:e4:36:8e:\n f2:60:5b:ca:b3:72:e6:be:53:8b:9e:b6:72:26:04:\n 85:37:f4:89:c1:78:91:7d:46:96:71:c4:be:39:f3:\n cc:1d:79:bc:33:61:5c:5f:76:52:4a:7d:d0:60:31:\n 79:96:44:6e:6a:77:72:70:1f:3f:08:24:e6:d1:50:\n c0:6a:86:98:df:56:8b:ae:2f:c1:97:bc:ed:4c:70:\n a1:a6:b2:7e:25:97:8f:95:73:a1:84:71:43:da:33:\n 48:d5:44:17:e1:28:1e:37:93:63:fa:ec:45:17:39:\n e5:ff:62:90:6b:b2:eb:11:5b:32:b2:ce:51:0b:8a:\n 3e:95\n Exponent: 65537 (0x10001)\n Attributes:\n a0:00\n Signature Algorithm: sha1WithRSAEncryption\n 41:bd:99:89:7a:1b:c2:71:90:f7:5a:17:05:c9:77:c8:f0:0e:\n 62:0f:85:0d:fb:16:02:74:34:5f:7a:93:3e:50:8e:cf:f4:6f:\n ee:ab:7b:c9:ef:7c:76:59:dd:85:fd:7d:4e:ac:95:9d:b7:ae:\n 8a:89:fc:1f:5b:ee:ee:6b:cd:9b:4e:2d:2a:fb:1b:32:8f:8f:\n 56:70:d1:42:c1:72:ed:04:4b:27:5a:ee:5a:e1:2b:6e:53:59:\n aa:14:25:87:7f:2b:c3:7a:f5:b2:6c:71:2a:93:62:40:ca:87:\n b4:fe:34:a1:95:77:1e:98:f1:71:5e:14:97:61:73:07:8d:bc:\n 3e:e1:f8:47:f7:00:8b:06:a5:1c:84:a3:88:9a:7b:37:74:5d:\n 34:a6:ae:22:ab:a3:b8:9f:d7:ab:60:9a:70:81:15:13:0f:d9:\n ff:ab:7a:2b:fd:cb:96:04:ad:00:6b:e4:74:4e:59:57:a5:9e:\n 84:c7:74:d8:62:08:37:b3:ee:cc:74:b2:b6:26:e8:c0:37:32:\n 19:dc:1c:ff:97:4a:cc:1c:36:c3:a7:2d:ca:77:53:c4:1d:1c:\n 3c:36:5b:f8:90:46:01:48:49:61:9b:ef:bb:b3:a8:94:0b:3f:\n 50:51:93:29:9f:aa:9a:ab:ae:3d:3c:72:8a:0b:bc:2f:3f:19:\n d7:5d:70:14\n","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Export certificate signing request","tags":["SSL","SSL Certificate Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  show_csr\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/show_csr"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_show_csr.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_show_csr.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/show_csr/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_show_csr.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_show_csr.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'show_csr'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/SSL/toggle_ssl_redirect_for_domains":{"get":{"description":"This function enables or disables secure redirects (HTTPS) for the cPanel account's domains that you specify.\n\n**Important:**\n\nTo call this function, one of the following conditions **must** exist:\n\n* AutoSSL **must** exist on the domains for which you enable secure redirects.\n* A valid SSL certificate **must** exist for each domain for which you wish to enable secure redirects.\n* You **must** own the domains for which you wish to enable secure redirects.","operationId":"toggle_ssl_redirect_for_domains","parameters":[{"description":"A comma-separated list of the cPanel account's domains for which to enable or disable secure redirects.\n\n**Important:**\n\nTo enable or disable redirects for addon domains, you **must** pass the addon domain **and** its subdomain.","in":"query","name":"domains","required":true,"schema":{"example":"main.example,addon.example,addon.main.example","type":"string"}},{"description":"Whether to enable or disable redirects for the specified domains.\n\n* `1` — Enable.\n* `0` — Disable.","in":"query","name":"state","required":true,"schema":{"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"toggle_ssl_redirect_for_domains","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"description":"The domains for which the function enabled or disabled secure redirects.","example":["main.example","addon.example","addon.main.example"],"items":{"type":"string"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` - Success\n- `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable or disable secure redirects","tags":["SSL","cPanel Account SSL Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  toggle_ssl_redirect_for_domains \\\n  domains='main.example,addon.example,addon.main.example' \\\n  state='1'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/toggle_ssl_redirect_for_domains?domains=main.example%2caddon.example%2caddon.main.example&state=1"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_toggle_ssl_redirect_for_domains.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_toggle_ssl_redirect_for_domains.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/toggle_ssl_redirect_for_domains/,\n    {\n        'domains' => 'main.example,addon.example,addon.main.example',\n        'state' => '1',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_toggle_ssl_redirect_for_domains.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_toggle_ssl_redirect_for_domains.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'toggle_ssl_redirect_for_domains',\n    array (\n        'domains' => 'main.example,addon.example,addon.main.example',\n        'state' => '1',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 80"}},"/SSL/upload_cert":{"post":{"description":"This function uploads a certificate.\n\n**Important:**\n\n* Due to the limited field length of HTTP GET method calls, you **must** use the HTTP\nPOST method. For this reason, you **cannot** use a cPanel or Webmail session URL to\ncall this function.\n* When you disable the Calendar and Contacts, Receive Mail, Web Disk, Webmail, and\nWeb Server [roles](https://go.cpanel.net/howtouseserverprofiles#roles),\nthe system **disables** this function.","operationId":"upload_cert","parameters":[{"description":"The certificate's contents.","in":"query","name":"crt","required":true,"schema":{"example":"\"-----BEGIN CERTIFICATE-----/nMIIDcTCCAlmgAwIBAgIFAU+BNVgwDQYJKoZIhvcNAQEFBQAwUTESMBAGA1UEAwwJc2lza28udGxkMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGY1BhbmVsMQswCQYDVQQIDAJUWDEQMA4GA1UEBwwHSG91c3RvbjAeFw0xNDEwMDYyMjI2MTlaFw0xNTEwMDYyMjI2MTlaMFExEjAQBgNVBAMMCXNpc2tvLnRsZDELMAkGA1UEBhMCVVMxDzANBgNVBAoMBmNQYW5lbDELMAkGA1UECAwCVFgxEDAOBgNVBAcMB0hvdXN0b24wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9zx6zGiHdmWA0dKtoXmJiWXpZ9E3PXx3YHsjFEWW7e5pH0vZ+jVMzDmm5nsJ7RXrAkZO1IvpIpVLvoQfiJOWVvkD+o9fWvoK1tWJS72FSgPju+58mA2ieBuc87A790Pzuv1P3NR3zFLAjUR99zkHR1fpri/daM3PBWO8ET48FWkyU1kOeZaUlF67/+wrEiNgg+t1qhKOCAB61PdNVkLaSGHimksuC+Czk8Kq9nuS0E0TCnDtjjEyJ455FUcaCfczlTb8xkB/F9ORe74yTzD+vlk0tFMG6PLj/ajIwWqwO0qmQ8wX3NRxkWgGz5kVO1wrVJarKQ5EYQ3/mgvit0v6dAgMBAAGjUDBOMB0GA1UdDgQWBBRw+wKBo34+bgexjAa3EMDsgSCd7zAfBgNVHSMEGDAWgBRw+wKBo34+bgexjAa3EMDsgSCd7zAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUAA4IBAQCHRXIs53opzKM2rM8Qe8lcw524WK6hqy2EWrZHp78N7rU7/6DQ/I3hv3WhcDDIO04I2/Xhe88MLBaLoM367Ya+vy7CaLr14aLi/SfQszMA0ALBvMao+Fis0iVwFYq/NLgSXw+fgnpFskt8v8iQZ+4Kaal8U8e9sVgu8m0RgO7rzym1eRiIKpsKd1rh/SD7LbSN7M7TRL3QqF7ltw9sQhAAsQcRaBBF21pdWrqhiGZ+Eioo3hhgwNavH2agqz78ddHwrFpHFwrEeUk1OfpPb76MYIce7xIy/4oQNdg6fOq4l/FrajBv+WkzDVPaKm6r7YmwfLN/YMZBHXSR58oOGP9W/n-----END CERTIFICATE-----\"","format":"pem-certificate","type":"string"}},{"description":"The certificate's friendly name.","in":"query","name":"friendly_name","required":false,"schema":{"example":"TestCert","type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"crt":{"description":"The certificate file.","format":"pem-certificate","type":"string"},"friendly_name":{"description":"The certificate's friendly name.","type":"string"}},"type":"object"}}},"description":"The certificate's contents."},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"upload_cert","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"created":{"description":"The certificate's creation date.","example":1569844800,"format":"unix_timestamp","type":"integer"},"domains":{"description":"A list of the certificate's domains.","items":{"example":"example.com","format":"domain","type":"string"},"type":"array"},"ecdsa_curve_name":{"description":"The ECDSA curve that the certificate's key uses.\n\n* `prime256v1`\n* `secp384r1`\n* `null` — The certificate's key is **not** an ECDSA key.","enum":["prime256v1","secp384r1"],"example":null,"nullable":true,"type":"string"},"ecdsa_public":{"description":"The certificate's key's ECDSA compressed public point, in hexadecimal format.\n\n* `null` — The certificate's key is **not** an ECDSA key.","example":null,"nullable":true,"type":"string"},"friendly_name":{"description":"The certificate's friendly name.","example":"TestCert","type":"string"},"id":{"description":"The certificate's ID.","example":"example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041","type":"string"},"is_self_signed":{"description":"Whether the certificate is self-signed.\n\n* `1` — Self-signed.\n* `0` — Not self-signed.","enum":[1,0],"example":1,"type":"integer"},"issuer.commonName":{"description":"The issuer's Common Name or Distinguished Name.","example":"VeriSign Trial Secure Server CA - G2","type":"string"},"issuer.organizationName":{"description":"The issuer's Organization Name.","example":"VeriSign, Inc.","type":"string"},"key_algorithm":{"description":"The certificate's key's algorithm.\n\n* `rsaEncryption` — RSA.\n* `id-ecPublicKey` — ECDSA.","enum":["rsaEncryption","id-ecPublicKey"],"example":"rsaEncryption","type":"string"},"modulus":{"description":"The certificate's key's modulus, in hexadecimal format.\n\n* `null` — The certificate's key is **not** an RSA key.","example":"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db","nullable":true,"type":"string"},"modulus_length":{"description":"The length, in bits, of the certificate's key's modulus.\n\n* `null` — The certificate's key is **not** an RSA key.","example":2048,"minimum":1,"nullable":true,"type":"integer"},"not_after":{"description":"The certificate's expiration date.","example":1601467200,"format":"unix_timestamp","type":"integer"},"not_before":{"description":"The certificate's start date.","example":1569844800,"format":"unix_timestamp","type":"integer"},"signature_algorithm":{"description":"The certificiate's OID hash algorithm signature.","example":"sha256WithRSAEncryption","type":"string"},"subject.commonName":{"description":"The issuer's Common Name or Distinguished Name.","example":"example.com","type":"string"},"validation_type":{"description":"The certificate's validation type.\n\n* `ev` — Extended Validation.\n* `ov` — Organization Validation.\n* `dv` — Domain Validation.\n* `null` — The system could not parse and determine\nthe certificate's validation type.","enum":["ev","ov","dv"],"example":"dv","nullable":true,"type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Import SSL certificate","tags":["SSL","SSL Certificate Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --input=json --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  upload_cert\n"},{"label":"HTTP Request (Wire Format)","lang":"HTTP","source":"POST /cpsess##########/execute/SSL/upload_cert HTTP/1.1\nHost: example.com:2083\nCookie: ###################################\nContent-Type: application/json\nContent-Length: 0\n\n"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/SSL/upload_key":{"post":{"description":"This function uploads a private key.\n\n**Note:**\n\nDue to the limited field length of HTTP GET method calls, you **must** use\nthe HTTP POST method. For this reason, you **cannot** use a cPanel or Webmail\nsession URL to call this function.\n\n**Important:**\n\nWhen you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail,\n**and** Web Server [roles](https://go.cpanel.net/howtouseserverprofiles#roles),\nthe system **disables** this function.","operationId":"upload_key","parameters":[{"description":"The key's contents.","in":"query","name":"key","required":true,"schema":{"example":"\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEowIBAAKCAQEAyeiHvMuJuVk8ZEY6wMzUS1g0eWaHaIWmIRe+Qrn6SwiRrm1p\\npsJCiGPPPQGOSg4FzrMXqE0zsi/Tk3hUO/EEsi7CcZe8cUanjlUeXhiwrb86FCMF\\nOb9siRHQvlss7VCg8ZGXXTWZgf5yD3A1xPwdayYwF2Tc7GkNcZGUAI58geuYaq+U\\nGiLczRGZep1IQ0b1cZnqDvGMx6AS6hiDqLISjnmXYY2OhG6Uyp+SuinjYzLPJ6eO\\nN/7i9qqbcGmt0ssddmhR897+bTEom5SlSuyi03KZ9Rn4ZmNJgOsup9MclSBGxBys\\nb6MuuM3N0/tF5QuwmDc8H6h2rNBP9vGV7RTTXQIDAQABAoIBAFS/WVoRRLmbjxG3\\nuKl8UA9f8oaSVnu0vUpeoOl5Dmm4Kw2/tvzbxPlii3Xb1VGYGS/tVBy8atp74J6h\\nfxm5zHLN1afAPMR/F41ShPCSBHapMUOKf4MBqhjOdYOw2Way1RsQNSxWdxxtJIr+\\nWlNYTzDOUpk/KMvCPHZS2IBzTidpcFpDQ3pyDXjOoKJJH0EQWPtvxJNGrFqmU29D\\n9WBqQemHnDrzg3s7JzQ5cGpbbCE+QX8IckNkslAkyhm771CtqWdeo+c45e6YfGcx\\nKuAy1zGSVzQBuitzYoMUOL5olXLEj8fHzXd/cZP4yCyyabcGz2vi6luxF+28l1OL\\nG1axyLECgYEA+bD5B+Y/Dp5hZ/uVR1bbvyraQpwbDesS1zgnJ53KOIl926dnWzIt\\nUvM46+c9IF+UJrtzwIB6IvjAQioNFrK36bHgNGzNf9WQ54NN172qveaFLdW34z/i\\nGR2ix/efm9OC41QREQ/5IKV07TibCwVazVBWascMPkH7FnguTvTCiosCgYEAzwJ+\\nGPlIWjK+sqkK5JMUyuH43qAvgVfkZV906JpNRQH0Mob3bC0nXN95EoTwWXk68ULT\\no1GHv9XLbj8e+Ok7kpJQZT5vEZnDN+cy3jdTLCvcjU5Q3ToImOTp9isSAFWRTbtk\\nyabLNoIIsTR/ZwwPFTZcRiK2d8k7ZhcRKdfGnrcCgYAPZ06FoTukoDqsGoYkB4S4\\n72DVmSHGIwlfg5ROylouULUV9ubWZmsLYfvR+cr4k0zlcsz6RDLEs4nQyx1RmCbm\\nYNXPBiNLTpaI4b3MoGPHIVB3+mZEu60sFXr0UR9kkpDRi18eKVkaHXrwI3zVGjh2\\n0Az0u2DS+mkOAs4AivLxbwKBgQC0XPqbLc+Bb0dCCREJmLD8GCkrZ6wcaQUB4krN\\nQ2vhnVM0Fu5K3Yi3XapynUuA2aSmgtA9MxMw7MkjlHGa9DPIgBz2KZDCaBN0iMeE\\nX/XivZCbucmxBxhohsLmjh5QFj3U2Vp2bBIQuvlx1EjQ8uvNUqDRJvuOoNFVIPH+\\nYBeZPwKBgA//kXfNtNMHOpch699i3rgTzbRFDmGwsr1otzvJsXw7Pr2bM4WIzUJy\\nG2SUSUlQRSZK4+BBKT9S0d7TynJD6X/6R7IBotZbfXs1myYxEsKj89/BQmr47x2h\\nHjYVCClNoJlsbd5C2yu1R3PikweWGoVaxE3c+AN5knqjwJ0g21Cf\\n-----END RSA PRIVATE KEY-----\"","format":"pem-private-key","type":"string"}},{"description":"The key's friendly name.","in":"query","name":"friendly_name","required":false,"schema":{"example":"TestKey","type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"crt":{"description":"The key's contents.","format":"pem-private-key","type":"string"},"friendly_name":{"description":"The key's friendly name.","type":"string"}},"type":"object"}}},"description":"The certificate's contents."},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"upload_key","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"created":{"description":"The key's creation date.","example":1569844800,"format":"unix_timestamp","type":"integer"},"ecdsa_curve_name":{"description":"The ECDSA curve that the key uses.\n\n* `prime256v1`\n* `secp384r1`\n* `null` — The key is **not** an ECDSA key.","enum":["prime256v1","secp384r1"],"example":null,"nullable":true,"type":"string"},"ecdsa_public":{"description":"The key’s ECDSA compressed public point, in hexadecimal format.\n\n* `null` — The key is **not** an ECDSA key.","example":null,"nullable":true,"type":"string"},"friendly_name":{"description":"The key's friendly name.","example":"TestKey","type":"string"},"id":{"description":"The key's ID.","example":"bbe7e_16e2d_df7539f280eb1ecf6c1096190e41ada7","type":"string"},"key_algorithm":{"description":"The key’s algorithm.\n\n* `rsaEncryption` — RSA.\n* `id-ecPublicKey` — ECDSA.","enum":["rsaEncryption","id-ecPublicKey"],"example":"rsaEncryption","type":"string"},"modulus":{"description":"The key's modulus, in hexadecimal format.\n\n* `null` — The key is **not** an RSA key.","example":"a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db","nullable":true,"type":"string"},"modulus_length":{"description":"The length, in bits, of the key's modulus.\n\n* `null` — The key is **not** an RSA key.","example":2048,"minimum":1,"nullable":true,"type":"integer"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Import private key","tags":["SSL","SSL Certificate Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --input=json --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  upload_key\n"},{"label":"HTTP Request (Wire Format)","lang":"HTTP","source":"POST /cpsess##########/execute/SSL/upload_key HTTP/1.1\nHost: example.com:2083\nCookie: ###################################\nContent-Type: application/json\nContent-Length: 0\n\n"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Session/create_webmail_session_for_mail_user_check_password":{"get":{"description":"This function creates a temporary session with a password for the calling cPanel user to connect to Webmail.\n\n**Note:**\n\n* The cPanel user must own the Webmail account.\n* This function works like the UAPI Session::create_webmail_session_for_mail_user function with one exception. This function requires a correct password to create the Webmail session. If you use an incorrect password or attempt to connect to a suspended account, the login will fail.\n\n### How to use this API\n\nAfter you successfully call this API, you will need to log in to [Webmail](https://go.cpanel.net/webmailinterface).\nTo do this, send an HTTP POST to `https://$URL_AUTHTY:2096$token/login` with a message body of `session=$session` where:\n\n* `$URL_AUTHTY` represents the value from the `hostname` return.\n  * If the `hostname` return value is `null`, enter the hostname of the server that answered the API function.\n  * `$token` represents the value from the token return.\n* `$session` represents the value of the session return.\n\nFor example, an HTTP POST may resemble the following:\n\n```https://hostname.example.com:2096/cpsess2462418786/login```\n\nWith a message body of:\n\n```session=username:D7NiAZv1nf4bXeg9:CREATE_WEBMAIL_SESSION_FOR_MAIL_USER,728fb86a7df1cf20690c65f349ac3137```","operationId":"create_webmail_session_for_mail_user_check_password","parameters":[{"description":"The Webmail account's username.","in":"query","name":"login","required":true,"schema":{"example":"username","type":"string"}},{"description":"The domain for the Webmail account.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","type":"string"}},{"description":"The password for the Webmail account.","in":"query","name":"password","required":true,"schema":{"example":"luggage12345","type":"string"}},{"description":"The [locale](https://go.cpanel.net/localedocs) that the new session will use.\n\n**Note:**\n\n* You must **only** enter lowercase characters.\n* This parameter defaults to the cPanel user's locale.","in":"query","name":"locale","required":false,"schema":{"example":"en","type":"string"}},{"description":"The session's account's client IP address.\n\n**Note:**\n\n* If you run this function from the command line, this parameter is **required**.\n* This parameter defaults to the API caller's IP address.","in":"query","name":"remote_address","required":false,"schema":{"example":"192.168.0.1","format":"ipv4","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"create_webmail_session_for_mail_user_check_password","type":"string"},"module":{"description":"The name of the module called.","example":"Session","type":"string"},"result":{"properties":{"data":{"properties":{"hostname":{"description":"The Webmail server's hostname.\n\n**Note:**\n\nThe function returns a `null` value when the Webmail server is not remote.","example":"hostname.example.com","nullable":true,"type":"string"},"session":{"description":"The session value to submit via POST to begin using the new session.","example":"username:D7NiAZv1nf4bXeg9:CREATE_WEBMAIL_SESSION_FOR_MAIL_USER,728fb86a7df1cf20690c65f349ac3137","type":"string"},"token":{"description":"A new security token.","example":"/cpsess2462418786","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create Webmail session with credentials","tags":["Session","Webmail Sessions"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Session \\\n  create_webmail_session_for_mail_user_check_password \\\n  login='username' \\\n  domain='example.com' \\\n  password='luggage12345'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Session/create_webmail_session_for_mail_user_check_password?login=username&domain=example.com&password=luggage12345"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Session_create_webmail_session_for_mail_user_check_password.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/Session_create_webmail_session_for_mail_user_check_password.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Session/,\n    q/create_webmail_session_for_mail_user_check_password/,\n    {\n        'login' => 'username',\n        'domain' => 'example.com',\n        'password' => 'luggage12345',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Session_create_webmail_session_for_mail_user_check_password.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/Session_create_webmail_session_for_mail_user_check_password.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Session',\n    'create_webmail_session_for_mail_user_check_password',\n    array (\n        'login' => 'username',\n        'domain' => 'example.com',\n        'password' => 'luggage12345',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 86"}},"/Session/create_webmail_session_for_self":{"get":{"description":"Create a temporary session to connect to Webmail for the authenticated cPanel user.\n\n### How to use this API\n\nAfter you successfully call this API, you will need to log in to [Webmail](https://go.cpanel.net/webmailinterface).\nTo do this, send an HTTP POST to `https://$URL_AUTHTY:2096$token/login` with a message body of `session=$session` where:\n\n* `$URL_AUTHTY` represents the value from the `hostname` return.\n  * If the `hostname` return value is `null`, enter the hostname of the server that answered the API function.\n  * `$token` represents the value from the token return.\n* `$session` represents the value of the session return.\n\nFor example, an HTTP POST may resemble the following:\n\n```https://hostname.example.com:2096/cpsess2462418786/login```\n\nWith a message body of:\n\n```session=username:D7NiAZv1nf4bXeg9:CREATE_WEBMAIL_SESSION_FOR_MAIL_USER,728fb86a7df1cf20690c65f349ac3137```","operationId":"create_webmail_session_for_self","parameters":[{"description":"The [locale](https://go.cpanel.net/localedocs) that the new session will use.\n\nUse UAPI `Locale::list_locales` to see a list of valid locales.\n\n**Note:**\n\n* You must **only** enter lowercase characters.\n* This parameter defaults to the cPanel user's locale.","in":"query","name":"locale","required":false,"schema":{"example":"en","type":"string"}},{"description":"The session's client IP address.\n\n**Note:**\n\n* If you run this function from the command line, this parameter is **required**.\n* This parameter defaults to the API caller's IP address.","in":"query","name":"remote_address","required":false,"schema":{"example":"192.168.0.1","format":"ipv4","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"create_webmail_session_for_self","type":"string"},"module":{"description":"The name of the module called.","example":"Session","type":"string"},"result":{"properties":{"data":{"properties":{"hostname":{"description":"The Webmail server's hostname.\n\n**Note:**\n\nThe function returns a `null` value when the Webmail server is **not** remote.","example":"hostname.example.com","format":"domain","nullable":true,"type":"string"},"session":{"description":"The session value to submit via POST to begin using the new session.","example":"username:D7NiAZv1nf4bXeg9:CREATE_WEBMAIL_SESSION_FOR_SELF,728fb86a7df1cf20690c65f349ac3137","type":"string"},"token":{"description":"A new security token.","example":"/cpsess2462418786","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create Webmail session for current user","tags":["Session","Webmail Sessions"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Session \\\n  create_webmail_session_for_self\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Session/create_webmail_session_for_self"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Session_create_webmail_session_for_self.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/Session_create_webmail_session_for_self.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Session/,\n    q/create_webmail_session_for_self/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Session_create_webmail_session_for_self.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/Session_create_webmail_session_for_self.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Session',\n    'create_webmail_session_for_self'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 86"}},"/ServerInformation/get_information":{"get":{"description":"This function returns the status of each\n[cPanel service (daemon)](https://go.cpanel.net/ThecPanelWHMServiceDaemons),\ndevice, and server health check point on your server.","operationId":"get_information","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_information","type":"string"},"module":{"description":"The name of the module called.","example":"ServerInformation","type":"string"},"result":{"properties":{"data":{"description":"An array of objects containing the server's status.","example":[{"name":"apache_php_fpm","status":1,"type":"service","value":"up"},{"name":"cpanel-dovecot-solr","status":1,"type":"service","value":"up"},{"name":"cpanellogd","status":1,"type":"service","value":"up"},{"name":"cpdavd","status":1,"type":"service","value":"up"},{"name":"cphulkd","status":1,"type":"service","value":"up"},{"name":"cpsrvd","status":1,"type":"service","value":"up"},{"name":"crond","status":1,"type":"service","value":"up"},{"name":"dnsadmin","status":1,"type":"service","value":"up"},{"name":"exim","status":1,"type":"service","value":"up","version":"exim-4.92-1.cp1180.x86_64"},{"name":"ftpd","status":1,"type":"service","value":"up"},{"name":"httpd","status":1,"type":"service","value":"up","version":"2.4.39"},{"name":"imap","status":1,"type":"service","value":"up"},{"name":"ipaliases","status":1,"type":"service","value":"up"},{"name":"lmtp","status":1,"type":"service","value":"up"},{"name":"mailman","status":1,"type":"service","value":"up"},{"name":"mysql","status":1,"type":"service","value":"up","version":"5.7.25"},{"name":"named","status":1,"type":"service","value":"up"},{"name":"nscd","status":1,"type":"service","value":"up"},{"name":"pop","status":1,"type":"service","value":"up"},{"name":"queueprocd","status":1,"type":"service","value":"up"},{"name":"rsyslogd","status":1,"type":"service","value":"up"},{"name":"spamd","status":1,"type":"service","value":"up"},{"name":"sshd","status":1,"type":"service","value":"up"},{"name":"Server Load","status":1,"type":"metric","value":"1.73"},{"name":"CPU Count","status":1,"type":"metric","value":"2"},{"name":"Memory Used","status":1,"type":"device","value":"44.12%"},{"name":"Swap","status":1,"type":"device","value":"0.73%"},{"name":"Disk / (/)","status":1,"type":"device","value":"26%"},{"name":"Disk /tmp (/tmp)","status":1,"type":"device","value":"0%"},{"name":"Disk /var/tmp (/var/tmp)","status":1,"type":"device","value":"0%"}],"items":{"properties":{"error":{"description":"An error message about why system couldn't read a resource's status file.","example":"nscd is reporting errors.","type":"string"},"name":{"description":"The cPanel services, devices, and server health check points on the\nserver.\n\n* A valid [cPanel service](https://go.cpanel.net/ThecPanelWHMServiceDaemons). \n* `CPU Count` — The number of CPUs on the server.\n* `Disk mount (mount)` — The server's disk mounts, where `mount`\nrepresents the disk mount location.\n* `Server Load` — The server's CPU load.\n* `Memory Used` — The server's current memory use.\n* `Swap` — The server's swap space.","example":"cpsrvd","type":"string"},"status":{"description":"Whether the resource is enabled or disabled.\n\n* `1` — Enabled.\n* `0` — Disabled.\n* `unknown` — The system couldn't determine the resource's status.","example":1,"oneOf":[{"description":"Whether the resource is enabled or disabled.","enum":[1,0],"type":"integer"},{"description":"The system couldn't determine the resource's status.","enum":["unknown"],"type":"string"}]},"type":{"description":"The type of resource.\n\n* `device`\n* `metric`\n* `service`","enum":["device","metric","service"],"example":"service","type":"string"},"value":{"anyOf":[{"description":"The resource's status.","enum":["up","down","unknown"],"type":"string"},{"description":"The resource's current usage.","type":"string"}],"description":"The resource's status.\n\n* `up`\n* `down`\n* `unknown`\n* The current resource usage."},"version":{"description":"The resource's software version.\n\n**Important:**\n\nThe function **only** returns this value if a valid software\nversion exists.","example":"exim-4.92-1.cp1178.x86_64","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return service and device status","tags":["ServerInformation","cPanel Server Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  ServerInformation \\\n  get_information\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/ServerInformation/get_information"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file ServerInformation_get_information.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/ServerInformation_get_information.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/ServerInformation/,\n    q/get_information/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file ServerInformation_get_information.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/ServerInformation_get_information.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'ServerInformation',\n    'get_information'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/Session/create_webmail_session_for_mail_user":{"get":{"description":"Create a temporary session for a cPanel user to connect to Webmail.\n\n**Note:**\n\nThe cPanel user must own the Webmail account.\n\n### How to use this API\n\nAfter you successfully call this API, you will need to log in to [Webmail](https://go.cpanel.net/webmailinterface).\nTo do this, send an HTTP POST to `https://$URL_AUTHTY:2096$token/login` with a message body of `session=$session` where:\n\n* `$URL_AUTHTY` represents the value from the `hostname` return.\n  * If the `hostname` return value is `null`, enter the hostname of the server that answered the API function.\n  * `$token` represents the value from the token return.\n* `$session` represents the value of the session return.\n\nFor example, an HTTP POST may resemble the following:\n\n```https://hostname.example.com:2096/cpsess2462418786/login```\n\nWith a message body of:\n\n```session=username:D7NiAZv1nf4bXeg9:CREATE_WEBMAIL_SESSION_FOR_MAIL_USER,728fb86a7df1cf20690c65f349ac3137```","operationId":"create_webmail_session_for_mail_user","parameters":[{"description":"The Webmail account's username.","in":"query","name":"login","required":true,"schema":{"example":"username","type":"string"}},{"description":"The domain for the Webmail account.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","type":"string"}},{"description":"The [locale](https://go.cpanel.net/localedocs) that the new session will use.\n\n**Note:**\n\n* You must **only** enter lowercase characters.\n* This parameter defaults to the cPanel user's locale.","in":"query","name":"locale","required":false,"schema":{"example":"en","type":"string"}},{"description":"The session's client IP address.\n\n**Note:**\n\n* If you run this function from the command line, this parameter is **required**.\n* This parameter defaults to the API caller's IP address.","in":"query","name":"remote_address","required":false,"schema":{"example":"192.168.0.1","format":"ipv4","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"create_webmail_session_for_mail_user","type":"string"},"module":{"description":"The name of the module called.","example":"Session","type":"string"},"result":{"properties":{"data":{"properties":{"hostname":{"description":"The Webmail server's hostname.\n\n**Note:**\n\nThe function returns a `null` value when the Webmail server is not remote.","example":"hostname.example.com","nullable":true,"type":"string"},"session":{"description":"The session ID to submit via POST to begin using the new session.","example":"username:D7NiAZv1nf4bXeg9:CREATE_WEBMAIL_SESSION_FOR_MAIL_USER,728fb86a7df1cf20690c65f349ac3137","type":"string"},"token":{"description":"A new security token.","example":"/cpsess2462418786","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create Webmail session","tags":["Session","Webmail Sessions"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Session \\\n  create_webmail_session_for_mail_user \\\n  login='username' \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Session/create_webmail_session_for_mail_user?login=username&domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Session_create_webmail_session_for_mail_user.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/Session_create_webmail_session_for_mail_user.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Session/,\n    q/create_webmail_session_for_mail_user/,\n    {\n        'login' => 'username',\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Session_create_webmail_session_for_mail_user.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/Session_create_webmail_session_for_mail_user.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Session',\n    'create_webmail_session_for_mail_user',\n    array (\n        'login' => 'username',\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 86"}},"/SiteTemplates/list_site_templates":{"get":{"description":"This function lists available templates for cPanel's [Site Publisher](https://go.cpanel.net/cpaneldocsSitePublisher) feature.\n\n* If you call this function as the `root` or `system` user, the function lists the `root` user's templates.\n* If you call this function as a reseller, the function lists the `root` user's templates **and** the reseller's templates.\n* If you call this function as a cPanel user, the function's output depends on the account's owner:\n  * If the `root` user owns the account, the function only lists the `root` user's templates.\n  * If a reseller owns the account, the function lists the `root` user's templates **and** that reseller's templates.\n\n**Note:**\n\n  The template directory's location depends on whether the `root` user or a reseller owns the template:\n  * `/var/cpanel/customizations/site_templates/` — The `root` user's templates.\n  * `/home/username/var/cpanel/reseller/site_templates/` — A reseller's templates, where `username` represents the reseller's username.\n  * `/usr/local/cpanel/3rdparty/share/site_templates/` — cPanel-provided templates.\n\n**Important:**\n\n  When you disable the [Web Server role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"list_site_templates","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_site_templates","type":"string"},"module":{"description":"The name of the module called.","example":"SiteTemplates","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"meta":{"description":"A set of data that gives information on the template.","properties":{"fields":{"description":"This array of objects shows the information for each field the user can add input in the template.","items":{"properties":{"id":{"description":"The template's ID.","example":"fullName","type":"string"},"label":{"description":"The template's label.","example":"Full Name","type":"string"},"placeholder":{"description":"A string that temporarily takes the place of the final data.","example":"Your Name","type":"string"},"type":{"description":"The template's type.\n* `color`\n* `datetime-local`\n* `email`\n* `Medical`\n* `tel`\n* `text`\n* `textarea`\n* `url`","enum":["color","datetime-local","email","Medical","tel","text","textarea","url"],"example":"text","type":"string"}},"type":"object"},"type":"array"},"information":{"description":"An object that provides basic template information.","properties":{"date":{"description":"The template's add date.","example":"2020-06-30","format":"ISO-8601 Date","type":"string"},"description":{"description":"A string describing the template.","example":"Single page 'About Me' site","type":"string"},"id":{"description":"A template name.","example":"about_me","type":"string"},"name":{"description":"The template's name.","example":"About Me","type":"string"},"preview_image_path":{"description":"The preview directory path.","example":"/preview.png","format":"path","type":"string"}},"type":"object"}},"type":"object"},"path":{"description":"The template directory path.\n\n**Note:**\n\n  The template directory's location depends on whether the `root` user or a reseller owns the template.","example":"/usr/local/cpanel/3rdparty/share/site_templates","format":"path","type":"string"},"preview":{"description":"Whether the template includes a preview image.\n* `1` - The template directory contains a `preview.png` file.\n* `0` - The template directory does **not** contain a `preview.png` file. The cPanel interface will display a placeholder image for this template.","enum":[0,1],"example":1,"type":"integer"},"template":{"description":"The template's name. This is the name of a directory that contains a `meta.json` template information\nfile and exists within one of the following directories:\n* `/var/cpanel/customizations/site_templates/` — The `root` user's templates.\n* `/home/username/var/cpanel/reseller/site_templates/` — A reseller's templates, where `username` represents the reseller's username.\n* `/usr/local/cpanel/3rdparty/share/site_templates/` — cPanel-provided templates.\n\n**Note:**\n\n  The template directory's location depends on whether the `root` user or a reseller owns the template.","example":"about_me","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return available Site Publisher templates","tags":["SiteTemplates","Site Publisher Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SiteTemplates \\\n  list_site_templates\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SiteTemplates/list_site_templates"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SiteTemplates_list_site_templates.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SiteTemplates_list_site_templates.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SiteTemplates/,\n    q/list_site_templates/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SiteTemplates_list_site_templates.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SiteTemplates_list_site_templates.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SiteTemplates',\n    'list_site_templates'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 56"}},"/SiteTemplates/publish":{"get":{"description":"This function publishes a [Site Publisher](https://go.cpanel.net/cpaneldocsSitePublisher) website.\n* This function uses the `/scripts/process_site_template` script to publish the Site Publisher website.\n* This function creates the `configurations.json` file in the specified directory.\n  * This file contains the user-entered data for the Site Publisher website and uses `0700` permissions.\n  * For more information, read our [Guide to Site Publisher Templates](https://go.cpanel.net/SitePublisherTemplates) documentation.\n* When users publish a Site Publisher website, the system first creates a backup tarball of the target directory's contents in the `/site_publisher/backups/` directory within the user's home directory.\n\n**Notes:**\n\n  * When users publish a Site Publisher website, the system logs template information and the target directory to the `/usr/local/cpanel/logs/error_log` file.\n  * The template directory's location depends on whether the `root` user or a reseller owns the template:\n    * `/var/cpanel/customizations/site_templates/` — The `root` user's templates.\n    * `/home/username/var/cpanel/reseller/site_templates/` — A reseller's templates, where `username` represents the reseller's username.\n    * `/usr/local/cpanel/3rdparty/share/site_templates/` — cPanel-provided templates.\n\n**Important:**\n\n  When you disable the [_Web Server_](https://go.cpanel.net/howtouseserverprofiles#roles) role, the system **disables** this function.","operationId":"publish","parameters":[{"description":"The directory that will contain the Site Publisher website.","in":"query","name":"target  or  docroot","required":true,"schema":{"example":"/home/example/public_html","format":"path","type":"string"}},{"description":"The absolute path to a template directory that exists in one of the following directories:\n\n* `/var/cpanel/customizations/site_templates/` — The `root` user's templates.\n* `/home/username/var/cpanel/reseller/site_templates/` — A reseller's templates, where `username` represents the reseller's username.\n* `/usr/local/cpanel/3rdparty/share/site_templates/` — cPanel-provided templates.\n\nIf you do not specify a value, the system uses the path and template values to determine the template's source directory.\n\n**Note:**\n\n You **must** include either the `source` parameter **or** the `path` and `template` parameters.","in":"query","name":"source","required":false,"schema":{"example":"/usr/local/cpanel/3rdparty/share/site_templates/under_construction","format":"path","type":"string"}},{"description":"The directory that contains the template's source directory.\n* `/var/cpanel/customizations/site_templates/` — The `root` user's templates.\n* `/home/username/var/cpanel/reseller/site_templates/` — A reseller's templates, where `username` represents the reseller's username.\n* `/usr/local/cpanel/3rdparty/share/site_templates/` — cPanel-provided templates.\n\n**Note:**\n\nYou **must** include either the `source` parameter **or** the `path` and `template` parameters.","in":"query","name":"path","required":false,"schema":{"example":"/usr/local/cpanel/3rdparty/share/site_templates/","format":"path","type":"string"}},{"description":"The template's directory's name.\n\n**Note:**\n\nYou **must** include either the `source` parameter **or** the `path` and `template` parameters.","in":"query","name":"template","required":false,"schema":{"example":"under_construction","type":"string"}},{"description":"The template's variables and values.\n\n**Note:**\n\n* Use each variable's name as a parameter name for a parameter and value pair.\n* The template that you specify determines the values to define.\n* You **must** include the appropriate data for the selected template. If you use a cPanel-provided template, read our [Guide to Site Publisher Templates](https://go.cpanel.net/guide-to-site-publisher-templates-template-files) documentation for more information. If you use a third-party template, consult that template's documentation or its `meta.json` file.","in":"query","name":"parameter_name","required":false,"schema":{"example":"My Website","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"publish","type":"string"},"module":{"description":"The name of the module called.","example":"SiteTemplates","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- `1` — Success.\n- `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add Site Publisher website","tags":["SiteTemplates","Site Publisher Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SiteTemplates \\\n  publish \\\n  target  or  docroot='/home/example/public_html'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SiteTemplates/publish?target%20%20or%20%20docroot=%2fhome%2fexample%2fpublic_html"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SiteTemplates_publish.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SiteTemplates_publish.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SiteTemplates/,\n    q/publish/,\n    {\n        'target  or  docroot' => '/home/example/public_html',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SiteTemplates_publish.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SiteTemplates_publish.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SiteTemplates',\n    'publish',\n    array (\n        'target  or  docroot' => '/home/example/public_html',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 56"}},"/SpamAssassin/clear_spam_box":{"get":{"description":"This function clears the spam box of all its contents for all email accounts.\n\n**Important:**\n\nThis function deletes the Spam Box folder contents for every email address on the account, which includes the system user email account.","operationId":"clear_spam_box","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"clear_spam_box","type":"string"},"module":{"description":"The name of the module called.","example":"SpamAssassin","type":"string"},"result":{"properties":{"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete spam box contents","tags":["SpamAssassin","Spam Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SpamAssassin \\\n  clear_spam_box\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SpamAssassin/clear_spam_box"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SpamAssassin_clear_spam_box.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SpamAssassin_clear_spam_box.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SpamAssassin/,\n    q/clear_spam_box/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SpamAssassin_clear_spam_box.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SpamAssassin_clear_spam_box.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SpamAssassin',\n    'clear_spam_box'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 70"}},"/SiteTemplates/list_user_settings":{"get":{"description":"This function lists information for the cPanel account's [Site Publisher](https://go.cpanel.net/cpaneldocsSitePublisher) websites.\n\n**Note:**\n\n  To retrieve the list of Site Publisher website information, the function queries the `configurations.json` file in each domain's document root. For more information, read our [Guide to Site Publisher Templates](https://go.cpanel.net/SitePublisherTemplates) documentation.\n\n**Important:**\n\n  When you disable the [Web Server role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"list_user_settings","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_user_settings","type":"string"},"module":{"description":"The name of the module called.","example":"SiteTemplates","type":"string"},"result":{"properties":{"data":{"description":"An array of objects containing each domain's site template information.","items":{"properties":{"documentroot":{"description":"The domain's absolute path to the directory's document root inside of the account's home directory.","example":"/home/example/public_html","format":"path","type":"string"},"domain":{"description":"The domain name.","example":"example.com","format":"domain","type":"string"},"homedir":{"description":"The absolute path to the cPanel account's home directory.","example":"/home/example","format":"path","type":"string"},"serveralias":{"description":"A list of the domain's aliases.","items":{"example":"www.example.com","format":"domain","type":"string"},"type":"array"},"template_settings":{"description":"An object containing template settings.\n\n**Important:**\n\nThis object also contains the user's website content. The template provider determines these values.\n  * For information about the content for cPanel-provided templates, read our [Guide to Site Publisher Templates](https://go.cpanel.net/SitePublisherTemplates) documentation.\n  * For more information about other templates, contact the template provider.","properties":{"is_empty":{"description":"Whether the domain's `configurations.json` file exists and contains template information.\n* `1` — The `configurations.json` file exists and contains template information.\n* `0` — The `configurations.json` file does not exist, or does not contain template information.","enum":[0,1],"example":0,"type":"integer"},"path":{"description":"The template directory path.\n* `/var/cpanel/customizations/site_templates/` — The `root` user's templates.\n* `/home/username/var/cpanel/reseller/site_templates/` — A reseller's templates, where username represents the reseller's `username`.\n* `/usr/local/cpanel/3rdparty/share/site_templates/` — cPanel-provided templates.","enum":["/var/cpanel/customizations/site_templates/","/home/username/var/cpanel/reseller/site_templates/","/usr/local/cpanel/3rdparty/share/site_templates/"],"example":"/usr/local/cpanel/3rdparty/share/site_templates/","format":"path","type":"string"},"template":{"description":"The template's name as it appears in the `configurations.json` file.","example":"mytemplate","type":"string"}}},"type":{"description":"The domain's type.\n* `main` — The main domain.\n* `sub` — A subdomain.","enum":["main","sub"],"example":"main","type":"string"}}},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return Site Publisher websites' information","tags":["SiteTemplates","Site Publisher Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SiteTemplates \\\n  list_user_settings\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SiteTemplates/list_user_settings"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SiteTemplates_list_user_settings.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SiteTemplates_list_user_settings.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SiteTemplates/,\n    q/list_user_settings/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SiteTemplates_list_user_settings.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SiteTemplates_list_user_settings.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SiteTemplates',\n    'list_user_settings'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 56"}},"/SpamAssassin/get_symbolic_test_names":{"get":{"description":"This function lists the Apache SpamAssassin™ scores for each symbolic test.","operationId":"get_symbolic_test_names","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"errors":{},"func":{"description":"The name of the method called.","example":"get_symbolic_test_names","type":"string"},"messages":{},"module":{"description":"The name of the module called.","example":"SpamAssassin","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"key":{"description":"The name of the test.","example":"ACT_NOW_ALL_CAPS","type":"string"},"rule_type":{"description":"The type and section of the email that the SpamAssassin analyses.\n* `body_tests`\n* `full_evals`\n* `head_evals`\n* `head_tests`\n* `meta_tests`\n* `other_tests`\n* `rawbody_tests`\n* `uri_tests`","enum":["body_tests","full_evals","head_evals","head_tests","meta_tests","other_tests","rawbody_tests","uri_tests"],"example":"body_tests","type":"string"},"score":{"description":"The score to assign to the email if the result of the test is true.","example":1,"oneOf":[{"type":"number"},{"type":"integer"}]}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"},"status":{}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return SpamAssassin™ symbolic test scores","tags":["SpamAssassin","Spam Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SpamAssassin \\\n  get_symbolic_test_names\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SpamAssassin/get_symbolic_test_names"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SpamAssassin_get_symbolic_test_names.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SpamAssassin_get_symbolic_test_names.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SpamAssassin/,\n    q/get_symbolic_test_names/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SpamAssassin_get_symbolic_test_names.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SpamAssassin_get_symbolic_test_names.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SpamAssassin',\n    'get_symbolic_test_names'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 70"}},"/Session/create_temp_user":{"get":{"description":"This function creates a temporary user session.\n\n**Important:**\n\n* Because this function requires a valid cPanel session ID, you **must** call it via a cPanel or Webmail session URL. If you call this function via the command line or Template Toolkit, it will **not** create a temporary user session. You **must** use the WHM API 1 `create_user_session` function to create a temporary user session.\n* Third-party plugins that require access to temporary MySQL users **must** call this function via the URL. It will create the temporary users before they are available. You can find these users in the `$ENV{'REMOTE_DBOWNER'}` environment variable.\n* If you **cannot** update your system, update your scripts to call the `Cgi::phpmyadminlink` function. This will create a temporary user session for you.","operationId":"create_temp_user","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"create_temp_user","type":"string"},"module":{"description":"The name of the module called.","example":"Session","type":"string"},"result":{"properties":{"data":{"properties":{"created":{"description":"Whether the function successfully created the temporary user session.\n* `1` - Success.\n* `0` - Failure.","enum":[0,1],"example":1,"type":"integer"},"session_temp_user":{"description":"The temporary user's session ID.","example":"cpses_reviY3ZSQK","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create user session with existing session","tags":["Session","Webmail Sessions"],"x-codeSamples":[{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Session/create_temp_user"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Session_create_temp_user.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/Session_create_temp_user.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Session/,\n    q/create_temp_user/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Session_create_temp_user.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/Session_create_temp_user.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Session',\n    'create_temp_user'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54.0.16","x-cpanel-cli-support":false}},"/SpamAssassin/update_user_preference":{"get":{"description":"This function sets the Apache SpamAssassin™ settings for the account.\n\n**Note:**\n\nAdditional customizations may appear in the function's return. For more information,\nread the [Apache SpamAssassin configuration file documentation](https://spamassassin.apache.org/full/3.1.x/doc/Mail_SpamAssassin_Conf.html#user_preferences).","operationId":"update_user_preference","parameters":[{"description":"The variable that you want to manipulate.\n\n* `score`\n* `required_score`\n* `whitelist_from`\n* `blacklist_from`\n* A [custom SpamAssassin variable](https://spamassassin.apache.org/full/3.1.x/doc/Mail_SpamAssassin_Conf.html#user_preferences).\n\n**Important:**\n\n* You can **only** choose one of these possible values per call.\n* If you enter a value for the `preference` parameter, but you do **not** define a value for the `value` parameter, the function will remove any previous settings.","example":"score","in":"query","name":"preference","required":true,"schema":{"type":"string"}},{"description":"The value for the preference of the variable that you want to manipulate.\n\n* A valid SpamAssassin \"`TEST_NAME SCORE`\" value when the value of the `preference` parameter is `score`, where:\n\n    * `TEST_NAME` represents the symbolic name of the test. For list of symbolic test names, run the UAPI `SpamAssassin::get_symbolic_test_names` function.\n    * `SCORE` represents the floating-point value that SpamAssassin assigns to the mail when the test result is true. The score value must be greater than `0`, and less than `1000`.\n\n* A valid floating-point number if the value of the `preference` parameter is `required_score`.\n* A valid email address if the value of the `preference` parameter is `whitelist_from` or `blacklist_from`.\n* A [custom SpamAssassin variable](https://spamassassin.apache.org/full/3.1.x/doc/Mail_SpamAssassin_Conf.html#user_preferences) value.\n\n**Note:**\n\nTo enter multiple values, increment the parameter name. For example, use the `value-0` and `value-1` parameters.","examples":{"multiple":{"summary":"Define multiple variable values.","value":"value-0=ACT_NOW_CAPS 5.0 value-1=INVALID_DATE 3.2"},"single":{"summary":"Define a single variable value.","value":"ACT_NOW_CAPS 5.0"}},"in":"query","name":"value","required":false,"schema":{"example":"ACT_NOW_CAPS 5.0","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"update_user_preference","type":"string"},"module":{"description":"The name of the module called.","example":"SpamAssassin","type":"string"},"result":{"properties":{"data":{"example":{"blacklist_from":["username2@example.com"],"ok_locales":["all"],"required_score":[5],"score":["ACT_NOW_CAPS 5"],"whitelist_from":["username@example.com"]},"properties":{"additionalProperties":{"description":"An array containing custom SpamAssassin variable values.\n\n**Note:**\n\nThe array's name is the custom SpamAssassin variable's name.","items":{"example":"mycustomscore","type":"string"}},"blacklist_from":{"description":"An array of email addresses on the blacklist.","items":{"example":"username2@example.com","format":"email","type":"string"},"type":"array"},"required_score":{"description":"An array containing the score at which the system will mark a message as spam. The system considers mail that matches this score to be spam.","items":{"example":5,"format":"float","type":"number"},"type":"array"},"score":{"description":"An array of the symbolic test names and their scores.","items":{"example":"ACT_NOW_CAPS 5","type":"string"},"type":"array"},"whitelist_from":{"description":"An array of the email addresses on the whitelist.","items":{"example":"username@example.com","format":"email","type":"string"},"type":"array"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update SpamAssassin™ settings","tags":["SpamAssassin","Spam Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SpamAssassin \\\n  update_user_preference \\\n  preference='score'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SpamAssassin/update_user_preference?preference=score"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SpamAssassin_update_user_preference.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SpamAssassin_update_user_preference.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SpamAssassin/,\n    q/update_user_preference/,\n    {\n        'preference' => 'score',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SpamAssassin_update_user_preference.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SpamAssassin_update_user_preference.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SpamAssassin',\n    'update_user_preference',\n    array (\n        'preference' => 'score',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 70"}},"/SpamAssassin/get_user_preferences":{"get":{"description":"This function lists the Apache SpamAssassin™ settings for the account.\n\n**Note:**\n\nAdditional customizations may appear in the returns. Form more information read the [Apache SpamAssassin™ configuration file](https://spamassassin.apache.org/full/3.1.x/doc/Mail_SpamAssassin_Conf.html#user_preferences) documentation.","operationId":"get_user_preferences","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_user_preferences","type":"string"},"module":{"description":"The name of the module called.","example":"SpamAssassin","type":"string"},"result":{"properties":{"data":{"properties":{"blacklist_from":{"description":"The email addresses on the blacklist.","items":{"example":"username2@example.com","format":"email","type":"string"},"type":"array"},"required_score":{"description":"The score to mark a message as spam. The system considers mail that matches this score to be spam.","items":{"example":5.1,"format":"float","type":"number"},"type":"array"},"score":{"description":"The symbolic test name and score.","items":{"example":"ACT_NOW_CAPS 1","type":"string"},"type":"array"},"whitelist_from":{"description":"The email addresses on the whitelist.","items":{"example":"username@example.com","format":"email","type":"string"},"type":"array"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return SpamAssassin™ settings","tags":["SpamAssassin","Spam Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SpamAssassin \\\n  get_user_preferences\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SpamAssassin/get_user_preferences"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SpamAssassin_get_user_preferences.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SpamAssassin_get_user_preferences.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SpamAssassin/,\n    q/get_user_preferences/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SpamAssassin_get_user_preferences.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SpamAssassin_get_user_preferences.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SpamAssassin',\n    'get_user_preferences'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 70"}},"/Stats/get_site_errors":{"get":{"description":"This function returns entries from a domain's error log.","operationId":"get_site_errors","parameters":[{"description":"The domain for which to return error log entries.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"The [Apache log file](https://go.cpanel.net/cpanellogfiles) to query.\nThis parameter defaults to error.\n\n* `error` - The `/var/log/apache2/error_log` file.\n* `suexec` - The `/var/log/apache2/suexec_log` file.","in":"query","name":"log","required":false,"schema":{"enum":["error","suexec"],"example":"suexec","type":"string"}},{"description":"The number of lines to retrieve from the error log.","in":"query","name":"maxlines","required":false,"schema":{"default":300,"example":250,"maximum":5000,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_site_errors","type":"string"},"module":{"description":"The name of the module called.","example":"Stats","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"date":{"description":"The date that the system recorded the error.","example":1234576704,"format":"unix_timestamp","type":"integer"},"entry":{"description":"The error log entry.","example":"[Fri Feb 13 19:58:24.420593 2009] [core:error] [pid 29228:tid 47876185720577] (13)Permission denied: [client 10.0.0.2:62908] AH00132: file permissions deny server access: /home/user/public_html/index.html","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success\n* `0` - Failed. Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings\ndescribe non-critical failures or other problematic conditions\nnoted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return specified domain access log","tags":["Stats","Domain Statistics"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Stats \\\n  get_site_errors \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Stats/get_site_errors?domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Stats_get_site_errors.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/Stats_get_site_errors.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Stats/,\n    q/get_site_errors/,\n    {\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Stats_get_site_errors.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/Stats_get_site_errors.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Stats',\n    'get_site_errors',\n    array (\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 84"}},"/Stats/get_bandwidth":{"get":{"description":"This function retrieves a list of bandwidth records for the domains on a cPanel account.\n\n**Note:**\n\nThis function also returns the bandwidth use of a [distributed cPanel account](https://docs.cpanel.net/knowledge-base/cpanel-product/cpanel-glossary#distributed-cpanel-account).\n\n**Warning:**\n\nThis function requires the _Bandwidth Stats_ feature. To enable this feature, use WHM's [_Feature Manager_](https://go.cpanel.net/whmdocsFeatureManager)\ninterface (_WHM >> Home >> Packages >> Feature Manager_).","operationId":"get_bandwidth","parameters":[{"description":"The timezone in which to report the data, in [Olson tz format](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).\n\n**Note:**\n\nThis parameter defaults to the server's timezone.","in":"query","name":"timezone","required":false,"schema":{"example":"America/Chicago","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_bandwidth","type":"string"},"module":{"description":"The name of the module called.","example":"Stats","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"bytes":{"description":"The domain's bandwidth usage, in bytes.","example":74845,"minimum":0,"type":"integer"},"domain":{"description":"The domain for which to display bandwidth statistics.\n\n**Note:**\n\nThe function only returns this value if the `protocol` return's value is `http`.","example":"example.com","format":"domain","type":"string"},"month_start":{"description":"The beginning of the report window.","example":1561957200,"format":"unix_timestamp","type":"integer"},"protocol":{"description":"The protocol for which to provide data.\n  * `http`\n  * `imap`\n  * `smtp`\n  * `pop3`\n  * `ftp`","enum":["http","imap","smtp","pop3","ftp"],"example":"imap","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return bandwidth statistics for all domains","tags":["Stats","Domain Statistics"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Stats \\\n  get_bandwidth\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Stats/get_bandwidth"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Stats_get_bandwidth.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/Stats_get_bandwidth.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Stats/,\n    q/get_bandwidth/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Stats_get_bandwidth.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/Stats_get_bandwidth.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Stats',\n    'get_bandwidth'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 84"}},"/Stats/list_sites":{"get":{"description":"This function displays the Analog statistics for the domains on a cPanel account.","operationId":"list_sites","parameters":[{"description":"The statistics engine.\n* `webalizer`\n* `analog`","in":"query","name":"engine","required":true,"schema":{"enum":["webalizer","analog"],"example":"webalizer","type":"string"}},{"description":"The web traffic type.\n * `http`\n * `ftp`","in":"query","name":"traffic","required":false,"schema":{"default":"http","enum":["http","ftp"],"example":"http","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_sites","type":"string"},"module":{"description":"The name of the module called.","example":"Stats","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"all_domains":{"description":"Whether the statistics file's filepath is for all the domains on a cPanel account.\n* `1` - All domains.\n* `0` - An individual domain.","enum":[0,1],"example":1,"type":"integer"},"domain":{"description":"The domain for which to display statistics.","example":"example.com","format":"domain","type":"string"},"path":{"description":"The filepath to the statistics file.","example":"/tmp/user/webalizer/index.html","format":"path","type":"string"},"ssl":{"description":"Whether the function generates statistics from SSL requests.\n* `1` - Generates statistics for SSL requests.\n* `0` - Generates statistics for non-SSL requests.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return Analog statistics for all domains","tags":["Stats","Domain Statistics"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Stats \\\n  list_sites \\\n  engine='webalizer'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Stats/list_sites?engine=webalizer"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Stats_list_sites.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/Stats_list_sites.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Stats/,\n    q/list_sites/,\n    {\n        'engine' => 'webalizer',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Stats_list_sites.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/Stats_list_sites.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Stats',\n    'list_sites',\n    array (\n        'engine' => 'webalizer',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 84"}},"/Stats/list_stats_by_domain":{"get":{"description":"This function returns a domain's Analog statistics.","operationId":"list_stats_by_domain","parameters":[{"description":"The statistics engine. `analog` is the only possible value.","in":"query","name":"engine","required":true,"schema":{"enum":["analog"],"example":"analog","type":"string"}},{"description":"The domain from which to retrieve statistics.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"Whether to return statistics from SSL requests.\n  * `1` - Return statistics for SSL requests.\n  * `0` - Return statistics for non-SSL requests.","in":"query","name":"ssl","required":false,"schema":{"default":1,"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_stats_by_domain","type":"string"},"module":{"description":"The name of the module called.","example":"Stats","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"date":{"description":"The current date and time.","example":1565795929,"format":"unix_timestamp","type":"integer"},"url":{"description":"The URL of the file from which the system generates statistics reports.","example":"tmp/cptest/analog/8.html.com","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return Analog statistics for specified domain","tags":["Stats","Domain Statistics"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Stats \\\n  list_stats_by_domain \\\n  engine='analog' \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Stats/list_stats_by_domain?engine=analog&domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Stats_list_stats_by_domain.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/Stats_list_stats_by_domain.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Stats/,\n    q/list_stats_by_domain/,\n    {\n        'engine' => 'analog',\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Stats_list_stats_by_domain.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/Stats_list_stats_by_domain.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Stats',\n    'list_stats_by_domain',\n    array (\n        'engine' => 'analog',\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 84"}},"/StatsManager/get_configuration":{"get":{"description":"This function lists the configuration of the web log anayzers for each domain on the cPanel account.\n\n**Important:**\n\nWhen you disable the WebServer role the system disables this function. For more information, read our How to Use [Server Profiles documentation](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/).\n\n**Note**\n\nAdditional web log analyzer configuration such as if the user can edit their own configuration is provided in the metadata section of the return.","operationId":"stats_manager_get_configuration","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_configuration","type":"string"},"module":{"description":"The name of the module called.","example":"StatsManager","type":"string"},"result":{"properties":{"data":{"description":"A list of domains and the status of each of the web log analyzers available in cPanel for that domain.","items":{"properties":{"analyzers":{"description":"List of log analyzer configuration objects for this domain. Only analyzers that are enabled for this user on the system are shown.","example":[{"enabled":1,"enabled_by_user":1,"name":"awstats"},{"enabled":0,"enabled_by_user":0,"name":"analog"},{"enabled":0,"enabled_by_user":1,"name":"webalizer"}],"items":{"properties":{"enabled":{"description":"Whether the analyzer is turned on or off for the domain.\n\n- `1` - the analyzer is enabled.\n- `0` - the analyzer is disabled.\n\n**Note:** This is the cumulative effect of the choices the server admin and user make.","enum":[1,0],"type":"integer"},"enabled_by_user":{"description":"Whether the analyzer is turned on or off for the domain specifically by this user.\n\n- `1` - the analyzer is enabled by the user.\n- `0` - the analyzer is disabled by the user.","enum":[1,0],"type":"integer"},"name":{"description":"Name of the analyzer.\n\nIt must be one of the following:\n\n- `analog` - Analog weblog analyzer.\n- `awstats` - AWStats weblog analyzer.\n- `webalizer` - The Webalizer weblog analyzer.","enum":["analog","awstats","webalizer"],"type":"string"}},"type":"object"},"type":"array"},"domain":{"description":"The domain.","example":"domain.com","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"analyzers":{"description":"System configruation for each analyzer.","example":[{"available_for_user":1,"enabled_by_default":0,"name":"analog"},{"available_for_user":1,"enabled_by_default":1,"name":"awstats"},{"available_for_user":1,"enabled_by_default":0,"name":"webalizer"}],"items":{"properties":{"available_for_user":{"description":"Whether the analyzer can be configured by this user.\n\n- `1` - the analyzer can be configured by this user.\n- `0` - the analyzer cannot be configured by this user.","enum":[1,0],"type":"integer"},"enabled_by_default":{"description":"Whether the analyzer is turned on or off by default for all users.\n\n- `1` - the analyzer is enabled for all users on the server.\n- `0` - the analyzer is disabled for all users on the server.","enum":[1,0],"type":"integer"},"name":{"description":"Name of the analyzer.\n\nIt must be one of the following:\n\n- `analog` - Analog weblog analyzer.\n- `awstats` - AWStats weblog analyzer.\n- `webalizer` - The Webalizer weblog analyzer.","enum":["analog","awstats","webalizer"],"type":"string"}},"type":"object"},"type":"array"},"locked":{"description":"Whether the analyzer can be turned on or off for the domain by the cPanel user.\n\n- `1` - the analyzer cannot be managed by the cPanel user. The reseller or `root` controls the configuration.\n- `0` - the analyzer can be managed by the cPanel user.","enum":[1,0],"type":"integer"},"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Returns weblog analyzers' configuration","tags":["StatsManager","Weblog Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  StatsManager \\\n  get_configuration\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/StatsManager/get_configuration"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file StatsManager_get_configuration.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/StatsManager_get_configuration.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/StatsManager/,\n    q/get_configuration/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file StatsManager_get_configuration.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/StatsManager_get_configuration.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'StatsManager',\n    'get_configuration'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":90}},"/StatsManager/save_configuration":{"post":{"description":"This function saves the users choice about which web log anayzers are enabled for each domain on their cPanel users account.\nIf the log anayzers are controlled by the reseller or root account, the user cannot manage which log analyzers are enabled or disabled.\n\n**Important:**\n\nWhen you disable the WebServer role the system disables this function. For more information, read our How to Use Server Profiles documentation.","operationId":"stats_manager_save_configuration","requestBody":{"content":{"application/json":{"schema":{"properties":{"changes":{"items":{"properties":{"analyzers":{"description":"List of log analyzer configuration objects.","example":[{"enabled":1,"name":"awstats"},{"enabled":0,"name":"analog"},{"enabled":0,"name":"webalizer"}],"items":{"properties":{"enabled":{"description":"Whether the analyzer is turned on or off for the domain.\n\n- `1` - the analyzer is enabled.\n- `0` - the analyzer is disabled.","enum":[1,0],"type":"integer"},"name":{"description":"Name of the analyzer.\n\nIt must be one of the following:\n\n- `analog` - Analog weblog analyzer.\n- `awstats` - AWStats weblog analyzer.\n- `webalizer` - The Webalizer weblog analyzer.","enum":["analog","awstats","webalizer"],"type":"string"}},"type":"object"},"type":"array"},"domain":{"description":"Domain you want to configure.","example":"domain.com","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}}},"description":"List of domains and what web log analyzers to change."},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"save_configuration","type":"string"},"module":{"description":"The name of the module called.","example":"StatsManager","type":"string"},"result":{"properties":{"data":{"description":"A list of domains and the status of each of the web log analyzers available in cPanel for that domain.","items":{"properties":{"analyzers":{"description":"List of log analyzer configuration objects for this domain","example":[{"available":1,"enabled":1,"locked":0,"name":"awstats"},{"available":1,"enabled":0,"locked":0,"name":"analog"},{"available":0,"enabled":0,"locked":0,"name":"webalizer"}],"items":{"properties":{"available":{"description":"Whether the analyzer is turned on or off for the whole server.\n\n- `1` - the analyzer is enabled on the server.\n- `0` - the analyzer is disabled on the server.","enum":[1,0],"type":"integer"},"enabled":{"description":"Whether the analyzer is turned on or off for the domain.\n\n- `1` - the analyzer is enabled.\n- `0` - the analyzer is disabled.","enum":[1,0],"type":"integer"},"locked":{"description":"Whether the analyzer can be turned on or off for the domain by the cPanel user.\n\n- `1` - the analyzer can be managed by the cPanel user.\n- `0` - the analyzer cannot be managed by the cPanel user. The reseller or `root` controls the configuration.","enum":[1,0],"type":"integer"},"name":{"description":"Name of the analyzer.\n\nIt must be one of the following:\n\n- `analog` - Analog weblog analyzer.\n- `awstats` - AWStats weblog analyzer.\n- `webalizer` - The Webalizer weblog analyzer.","enum":["analog","awstats","webalizer"],"type":"string"}},"type":"object"},"type":"array"},"domain":{"description":"The domain.","example":"user","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Save current user's weblog analyzers configuration","tags":["StatsManager","Weblog Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"echo '{\"changes\":[{\"analyzers\":[{\"enabled\":\"1\",\"name\":\"awstats\"},{\"enabled\":\"0\",\"name\":\"analog\"},{\"enabled\":\"0\",\"name\":\"webalizer\"}],\"domain\":\"domain.com\"}]}' | \\\nuapi --input=json --output=jsonpretty \\\n  --user=username \\\n  StatsManager \\\n  save_configuration"},{"label":"HTTP Request (Wire Format)","lang":"HTTP","source":"POST /cpsess##########/execute/StatsManager/save_configuration HTTP/1.1\nHost: example.com:2083\nCookie: ###################################\nContent-Type: application/json\nContent-Length: 151\n\n{\"changes\":[{\"analyzers\":[{\"enabled\":\"1\",\"name\":\"awstats\"},{\"enabled\":\"0\",\"name\":\"analog\"},{\"enabled\":\"0\",\"name\":\"webalizer\"}],\"domain\":\"domain.com\"}]}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":90}},"/StatsBar/get_stats":{"get":{"description":"This function retrieves a cPanel account's statistics.","operationId":"get_stats","parameters":[{"description":"A pipe-delimited list of the account's statistics.\n\n<details>\n  <summary>Click for a list of available display parameters.</summary>\n\n  * `addondomains` — Information about the account's addon domains.\n  * `apacheversion` — The server's Apache version.\n  * `autoresponders` — Information about the account's auto-responders.\n  * `bandwidthusage` — Information about the account's bandwidth usage.\n  * `cachedlistdiskusage` — The amount of cached mailing list disk space the account currently uses.\n  * `cachedmysqldiskusage` — The amount of cached disk space that the account's MySQL® databases currently use.\n  * `cachedpostgresdiskusage` — The amount of cached disk space that the account's PostgreSQL databases use.\n  * `cpanelversion` — The server's cPanel version.\n  * `dedicatedip` — Account websites that use dedicated IP addresses.\n  * `diskusage` — Information the account's disk space usage.\n  * `emailaccounts` — Information about the account's email accounts.\n  * `emailfilters` — Information the account's email filters.\n  * `emailforwarders` — Information about the account's forwarders.\n  * `fileusage` — Information about the account's file usage.\n  * `ftpaccounts` — Information about the account's FTP accounts.\n  * `hostingpackage` — The account's hosting package.\n  * `hostname` — The server's hostname.\n  * `kernelversion` — The operating system's kernel version.\n  * `localip` — Account websites that use local IP addresses.\n  * `machinetype` — The type of operating system that the server uses.\n  * `mailinglists` — Information the account's mailing lists.\n  * `mysqldatabases` — The number of MySQL databases the account possesses.\n  * `mysqldiskusage` — The amount of disk space that the account's MySQL databases use.\n  * `mysqlversion` — The server's MySQL version.\n  * `operatingsystem` — The server's operating system.\n  * `parkeddomains` — Information about the account's parked domains (aliases).\n  * `perlpath` — The Perl binary's absolute path.\n  * `perlversion` — The server's Perl version.\n  * `phpversion` — The server's PHP version.\n  * `postgresqldatabases` — The number of PostgreSQL databases the cPanel account possesses.\n  * `postgresdiskusage` — The amount of disk space that the cPanel account's PostgreSQL databases use.\n  * `sendmailpath` — The path to the system's sendmail binary.\n  * `sharedip` — Any of the account's websites that use a shared IP address.\n  * `shorthostname` — The short version of your server's hostname.\n  * `sqldatabases` — Information about the all of the account's SQL databases.\n  * `subdomains` — Information about the account's subdomains.\n  * `theme` — The account's current theme.\n</details>\n\n**Note:**\n\n* This function may require URI-encode format (`%7C`) or quotes (`\"`) in some\ncontexts, such as the command line tool.\n* Some display parameters may be unavailable based on the server's configuration.","in":"query","name":"display","required":true,"schema":{"example":"bandwidthusage|diskusage","type":"string"}},{"description":"Whether to return all results with a warning.\n\n* `1` — Return only warnings that **exceed** the `warninglevel` parameter's\nvalue.\n* `0` — Return all results.","in":"query","name":"warnings","required":false,"schema":{"default":null,"enum":[1,0],"example":0,"nullable":true,"type":"integer"}},{"description":"The minimum level at which to return warnings.","in":"query","name":"warninglevel","required":false,"schema":{"default":null,"example":87,"maximum":100,"minimum":1,"nullable":true,"type":"integer"}},{"description":"Whether to display results with a value of `100%`.\n\n* `1` — Display results with a value of `100%`.\n* `0` — Hide results with a value of `100%`.","in":"query","name":"warnout","required":false,"schema":{"default":null,"enum":[1,0],"example":0,"nullable":true,"type":"integer"}},{"description":"The absolute file path to an alternative infinity symbol image.","in":"query","name":"infinityimg","required":false,"schema":{"default":null,"example":"/home/example/infinity.png","nullable":true,"type":"string"}},{"description":"A phrase to represent infinity that the locales system can use.","in":"query","name":"infinitylang","required":false,"schema":{"default":null,"example":"infinity","nullable":true,"type":"string"}},{"description":"The type of row.\n\n* `odd`\n* `even`","in":"query","name":"rowcounter","required":false,"schema":{"default":null,"example":"even","nullable":true,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_stats","type":"string"},"module":{"description":"The name of the module called.","example":"StatsBar","type":"string"},"result":{"properties":{"data":{"description":"An array of objects containing results from the queried account.","example":[{"_count":"0.00","_max":"1024.00","_maxed":0,"count":"0 bytes","feature":"bandwidth","id":"bandwidthusage","is_maxed":0,"item":"Monthly Bandwidth Transfer","max":"1 GB","maxed_phrase":"You have transferred your maximum allotment of data ([format_bytes,_1]) for this month.","module":"Stats","name":"bandwidthusage","near_limit_phrase":"You have transferred [format_bytes,_1] of your [format_bytes,_2] data allotment for this month.","normalized":1,"percent":0,"percent10":0,"percent20":0,"percent5":0,"phrase":"Monthly Bandwidth Transfer","rowtype":"even","units":"MB","zeroisunlimited":1},{"_count":"1.75","_max":"1024.00","_maxed":0,"count":"1.75 MB","id":"diskusage","is_maxed":0,"item":"Disk Space Usage","langkey":"INDXDiskUsage","max":"1 GB","maxed_phrase":"You are using your maximum storage allotment, [format_bytes,_1].","module":"Quota","name":"diskusage","near_limit_phrase":"You are using [format_bytes,_1] of the [format_bytes,_2] of storage available to you.","normalized":1,"percent":0,"percent10":0,"percent20":0,"percent5":0,"phrase":"Disk Space Usage","rowtype":"odd","units":"MB","zeroisunlimited":1}],"items":{"properties":{"_count":{"description":"The queried data's value.","type":"string"},"_max":{"description":"The queried parameter's limit.","type":"string"},"_maxed":{"description":"Whether the queried value reached its maximum value.\n\n* `1` — Reached maximum value.\n* `0` — Has **not** reached maximum value.","enum":[1,0],"type":"integer"},"condition":{"description":"Whether the queried data's value possesses a conditional requirement.\n\n* `1` — Possesses a condition.\n* `0` — Does **not** possess a condition.\n\n**Note:**\n\nThe function will **only** return this value if it determines that the\nrelated statistic meets the subsystem installation requirements.","enum":[1,0],"type":"integer"},"count":{"description":"The queried data's value.","type":"string"},"feature":{"description":"The queried item's feature name.","type":"string"},"id":{"description":"The queried item's reference name.","type":"string"},"is_maxed":{"description":"Whether the queried value has reached its maximum value.\n\n* `1` — The queried value has reached its maximum value.\n* `0` — The queried value has **not** reached its maximum value.","enum":[1,0],"type":"integer"},"item":{"description":"A human-readable version of the queried item.","type":"string"},"max":{"description":"The queried value's maximum limit.","type":"string"},"maxed_phrase":{"description":"The [`maketext`-formatted](https://go.cpanel.net/locale) message\nthat the interface displays when the user reaches their maximum\nallowed value.","type":"string"},"module":{"description":"The module that retrieved the information.","example":"Quota","type":"string"},"name":{"description":"The display key.","example":"diskusage","type":"string"},"near_limit_phrase":{"description":"The [`maketext`-formatted](https://go.cpanel.net/locale) message\nthat the interface displays when the user approaches their\nmaximum allowed value.","type":"string"},"normalized":{"description":"Whether the function normalized the output values.\n\n* `1` — Normalized.\n* `0` — Did **not** normalize.","enum":[1,0],"type":"integer"},"percent":{"description":"The percentage of value, if applicable.","type":"integer"},"percent10":{"description":"The percentage of value that the system rounds to the nearest ten, if applicable.","multipleOf":10,"type":"integer"},"percent20":{"description":"The percentage of value that the system rounds to the nearest twenty, if applicable.","multipleOf":20,"type":"integer"},"percent5":{"description":"The percentage of value that the system rounds to the nearest five, if applicable.","multipleOf":5,"type":"integer"},"phrase":{"description":"The human-readable name of the queried item.","type":"string"},"role":{"description":"The queried value's role.\n\n* `CalendarContact`\n* `DNS`\n* `FileStorage`\n* `FTP`\n* `MailLocal`\n* `MailReceive`\n* `MailSend`\n* `MySQL`\n* `Postgres`\n* `SpamFilter`\n* `Webmail`\n* `WebDisk`\n* `WebServer`","enum":["CalendarContact","DNS","FileStorage","FTP","MailLocal","MailReceive","MailSend","MySQL","Postgres","SpamFilter","Webmail","WebDisk","WebServer"],"type":"string"},"rowtype":{"description":"The queried value's row type.\n\n* `even`\n* `odd`","enum":["even","odd"],"type":"string"},"units":{"description":"The queried value's unit of measure.","type":"string"},"zeroisunlimited":{"description":"Whether a value of `0` means unlimited or zero.\n\n* `1` — Unlimited.\n* `0` — Zero.","enum":[1,0],"type":"integer"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel account statistics","tags":["StatsBar","Resource Usage and Statistics"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  StatsBar \\\n  get_stats \\\n  display='bandwidthusage|diskusage'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/StatsBar/get_stats?display=bandwidthusage%7cdiskusage"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file StatsBar_get_stats.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/StatsBar_get_stats.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/StatsBar/,\n    q/get_stats/,\n    {\n        'display' => 'bandwidthusage|diskusage',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file StatsBar_get_stats.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/StatsBar_get_stats.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'StatsBar',\n    'get_stats',\n    array (\n        'display' => 'bandwidthusage|diskusage',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/DirectoryPrivacy/delete_user":{"get":{"description":"This function deletes a user who can access a protected directory on the cPanel account.","operationId":"delete_user","parameters":[{"description":"The absolute directory path on the cPanel account from which to remove a user.","in":"query","name":"dir","required":true,"schema":{"example":"/home/example/example.com","format":"path","type":"string"}},{"description":"The username to remove from the directory.","in":"query","name":"user","required":true,"schema":{"example":"example1","format":"username","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"delete_user","type":"string"},"module":{"description":"The name of the module called.","example":"DirectoryPrivacy","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete authorized user for protected directory","tags":["DirectoryPrivacy","Directory Privacy"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DirectoryPrivacy \\\n  delete_user \\\n  dir='/home/example/example.com' \\\n  user='example1'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DirectoryPrivacy/delete_user?dir=%2fhome%2fexample%2fexample.com&user=example1"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DirectoryPrivacy_delete_user.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DirectoryPrivacy_delete_user.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DirectoryPrivacy/,\n    q/delete_user/,\n    {\n        'dir' => '/home/example/example.com',\n        'user' => 'example1',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DirectoryPrivacy_delete_user.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DirectoryPrivacy_delete_user.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DirectoryPrivacy',\n    'delete_user',\n    array (\n        'dir' => '/home/example/example.com',\n        'user' => 'example1',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 88"}},"/Email/delete_auto_responder":{"get":{"description":"This function deletes an autoresponder.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles#roles), the system **disables** this function.","operationId":"delete_auto_responder","parameters":[{"description":"The email account.","in":"query","name":"email","required":true,"schema":{"example":"user@example.com","format":"email","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"delete_auto_responder","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete email account's autoresponder","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  delete_auto_responder \\\n  email='user@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/delete_auto_responder?email=user%40example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_delete_auto_responder.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_delete_auto_responder.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/delete_auto_responder/,\n    {\n        'email' => 'user@example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_delete_auto_responder.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_delete_auto_responder.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'delete_auto_responder',\n    array (\n        'email' => 'user@example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Themes/get_theme_base":{"get":{"deprecated":true,"description":"This function is deprecated and does not return useful output.","operationId":"get_theme_base","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_theme_base","type":"string"},"module":{"description":"The name of the module called.","example":"Themes","type":"string"},"result":{"properties":{"data":{"description":"The cPanel account's base theme. The function returns **only** one of the following strings:\n* `jupiter`\n* `unknown` — The function returns this value when it cannot determine the base theme that\nyou modified to create the custom theme.","enum":["jupiter","unknown"],"example":"jupiter","type":"string"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return current theme","tags":["Themes","Theme Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Themes \\\n  get_theme_base\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Themes/get_theme_base"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Themes_get_theme_base.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Themes_get_theme_base.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Themes/,\n    q/get_theme_base/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Themes_get_theme_base.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Themes_get_theme_base.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Themes',\n    'get_theme_base'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.50"}},"/SubDomain/addsubdomain":{"get":{"description":"This function creates a subdomain.\n\n**Important:**\n\nWhen you disable the [Web Server role](https://go.cpanel.net/serverroles#roles), the system **disables** this function.","operationId":"addsubdomain","parameters":[{"description":"The subdomain name to create.","in":"query","name":"domain","required":true,"schema":{"example":"subdomain","type":"string"}},{"description":"The domain on which to create the new subdomain.  The domain **must** already exist on the cPanel account.","in":"query","name":"rootdomain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"Whether to use a canonical name (CNAME) in the [Apache® configuration for self-referential URLs](https://httpd.apache.org/docs/2.4/mod/core.html#usecanonicalname).\n* `1` - Use the CNAME.\n* `0` - Do **not** use the CNAME.","in":"query","name":"canoff","required":false,"schema":{"default":1,"enum":[0,1],"example":1,"type":"integer"}},{"description":"The subdomain's document `root` within the home directory, given as a valid directory path relative to the user's home directory.\n\nThis value defaults to the user's home directory `/public_html/` path.\n\n**Note:**\n\nIf the *Restrict document roots to public_html* value is set to *Off* in WHM's [*Tweak Settings*](https://go.cpanel.net/whmdocsTweakSettings#domains) interface (*WHM >> Home >> Server Configuration >> Tweak Settings*), this parameter defaults to the `/username/` path. For example, the `username` user's subdomain `example` would default to the `/home/username/example` path.","in":"query","name":"dir","required":false,"schema":{"example":"/public_html/directory_name","format":"path","type":"string"}},{"description":"Whether to remove the dot (`.`) characters from the `domain` value.\n* `1` - Remove dots from the domain.\n* `0` - Do **not** remove dots from the domain.","in":"query","name":"disallowdot","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"addsubdomain","type":"string"},"module":{"description":"The name of the module called.","example":"SubDomain","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create subdomain","tags":["SubDomain"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SubDomain \\\n  addsubdomain \\\n  domain='subdomain' \\\n  rootdomain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SubDomain/addsubdomain?domain=subdomain&rootdomain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SubDomain_addsubdomain.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SubDomain_addsubdomain.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SubDomain/,\n    q/addsubdomain/,\n    {\n        'domain' => 'subdomain',\n        'rootdomain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SubDomain_addsubdomain.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SubDomain_addsubdomain.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SubDomain',\n    'addsubdomain',\n    array (\n        'domain' => 'subdomain',\n        'rootdomain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 70"}},"/Themes/update":{"get":{"description":"This function applies a new theme to the cPanel interface.\n\n**Note:**\n\n  The `/usr/local/cpanel/scripts/modify_accounts` script allows you to modify the theme for many or all accounts on the server. For more information, read our [The modify_accounts Script](https://go.cpanel.net/modifyaccounts) documentation.","operationId":"Themes::update","parameters":[{"description":"The theme name.","in":"query","name":"theme","required":true,"schema":{"example":"jupiter","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"update","type":"string"},"module":{"description":"The name of the module called.","example":"Themes","type":"string"},"result":{"properties":{"data":{"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"Whether the theme changed.\n\n* `1` — The theme changed.\n* `0` — The theme did **not** change, or the function failed.\n\n**Note:**\n\nIf the function fails, check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update current theme","tags":["Themes","Theme Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Themes \\\n  update \\\n  theme='jupiter'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Themes/update?theme=jupiter"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Themes_update.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Themes_update.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Themes/,\n    q/update/,\n    {\n        'theme' => 'jupiter',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Themes_update.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Themes_update.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Themes',\n    'update',\n    array (\n        'theme' => 'jupiter',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Tokens/create_full_access":{"get":{"description":"This function creates a new API token with full access to all of a cPanel account's features.\n\n**Note:**\n\nThe token **only** grants access to the features that the account has access to. For example,\nif you disable the [*File Manager*](https://go.cpanel.net/cpaneldocsFileManager) feature, the\ntoken can't access it.","operationId":"create_full_access","parameters":[{"description":"The API token's name.\n\n**Note:**\n\nThe name may **only** contain alphanumeric characters, dashes (`-`), and underscores (`_`).","in":"query","name":"name","required":true,"schema":{"example":"example","maxLength":50,"type":"string"}},{"description":"The API token's expiration time.\n\n**Important:**\n\n* When an API token expires the system does **not** delete it. You **must** manually delete expired API tokens.\n* If you do not use this parameter, the API token will **not** expire.","in":"query","name":"expires_at","required":false,"schema":{"example":1609372800,"format":"unix_timestamp","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"create_full_access","type":"string"},"module":{"description":"The name of the module called.","example":"Tokens","type":"string"},"result":{"properties":{"data":{"properties":{"create_time":{"description":"The API token's creation date and time.","example":1549467298,"format":"unix_timestamp","type":"integer"},"token":{"description":"The generated API token.","example":"JPQNSRU0DH448UJLGXH7KVJECC5QN9N9","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create cPanel API token","tags":["Tokens","API Token Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Tokens \\\n  create_full_access \\\n  name='example'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Tokens/create_full_access?name=example"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Tokens_create_full_access.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Tokens_create_full_access.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Tokens/,\n    q/create_full_access/,\n    {\n        'name' => 'example',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Tokens_create_full_access.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Tokens_create_full_access.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Tokens',\n    'create_full_access',\n    array (\n        'name' => 'example',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 80"}},"/Tokens/list":{"get":{"description":"This function returns a list of a cPanel account's API tokens.","operationId":"Tokens-list","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list","type":"string"},"module":{"description":"The name of the module called.","example":"Tokens","type":"string"},"result":{"properties":{"data":{"description":"An array of objects containing the account's API tokens.","items":{"properties":{"create_time":{"description":"The API token's creation date and time.","example":1549471343,"format":"unix_timestamp","type":"integer"},"expires_at":{"description":"The API token's expiration time.\n\n* null — The API token does **not** expire.","example":1609372800,"format":"unix_timestamp","nullable":true,"type":"integer"},"features":{"description":"The account features that the API token has access to.\n\n* An empty array — The API token has full access.","example":[],"items":{"type":"string"},"type":"array"},"has_full_access":{"description":"Whether the API token has full access to the account's features.\n\n* `1` — The API token has full access to the account's features.\n* `0` — The API token does **not** have full access to the\naccount's features.","enum":[1,0],"example":1,"type":"integer"},"name":{"description":"The API token's name.","example":"exampletoken","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel API tokens","tags":["Tokens","API Token Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Tokens \\\n  list\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Tokens/list"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Tokens_list.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Tokens_list.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Tokens/,\n    q/list/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Tokens_list.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Tokens_list.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Tokens',\n    'list'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 80"}},"/Tokens/rename":{"get":{"description":"This function renames a cPanel account's existing API token.","operationId":"rename","parameters":[{"description":"The API token's name.","in":"query","name":"name","required":true,"schema":{"example":"example","type":"string"}},{"description":"The new name for the API token.\n\n**Note:**\n\nThe name may only contain alphanumeric characters, dashes (`-`), and underscores (`_`).","in":"query","name":"new_name","required":true,"schema":{"example":"newexample","maxLength":50,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"rename","type":"string"},"module":{"description":"The name of the module called.","example":"Tokens","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update cPanel API token's name","tags":["Tokens","API Token Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Tokens \\\n  rename \\\n  name='example' \\\n  new_name='newexample'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Tokens/rename?name=example&new_name=newexample"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Tokens_rename.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Tokens_rename.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Tokens/,\n    q/rename/,\n    {\n        'name' => 'example',\n        'new_name' => 'newexample',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Tokens_rename.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Tokens_rename.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Tokens',\n    'rename',\n    array (\n        'name' => 'example',\n        'new_name' => 'newexample',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 80"}},"/TwoFactorAuth/generate_user_configuration":{"get":{"description":"This function generates an authentication code to enable configuration of two-factor authentication.","operationId":"generate_user_configuration","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"generate_user_configuration","type":"string"},"module":{"description":"The name of the module called.","example":"TwoFactorAuth","type":"string"},"result":{"properties":{"data":{"properties":{"otpauth_str":{"description":"A one-time authentication URL to encode as the QR code.","example":"otpauth://totp/Example%20cPanel%20L.L.C.:fakedomain?secret=S3I4WUY7MTHRMMWN&issuer=Example%20cPanel%20L.L.C.","type":"string"},"secret":{"description":"A generated code for use with two-factor authentication.","example":"S3I4WUY7MTHRMMWN","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create 2FA authentication code","tags":["TwoFactorAuth","Two-Factor Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  TwoFactorAuth \\\n  generate_user_configuration\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/TwoFactorAuth/generate_user_configuration"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file TwoFactorAuth_generate_user_configuration.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/TwoFactorAuth_generate_user_configuration.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/TwoFactorAuth/,\n    q/generate_user_configuration/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file TwoFactorAuth_generate_user_configuration.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/TwoFactorAuth_generate_user_configuration.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'TwoFactorAuth',\n    'generate_user_configuration'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/Tokens/revoke":{"get":{"description":"This function removes an API token from a cPanel account.","operationId":"revoke","parameters":[{"description":"The API token to remove.","in":"query","name":"name","required":true,"schema":{"example":"example","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"revoke","type":"string"},"module":{"description":"The name of the module called.","example":"Tokens","type":"string"},"result":{"properties":{"data":{"description":"Whether the system removed the API token.\n\n* `1` - The system removed the API token or the API token doesn't exist.\n* `0` - The system did **not** remove the API token.\n\n**Note:**\n\nThe system returns the data value in the function's metadata. This differs from our usual API return format. For more information, read our [UAPI Introduction](/cpanel/introduction/) documentation.","enum":[0,1],"example":1,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove cPanel API token","tags":["Tokens","API Token Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Tokens \\\n  revoke \\\n  name='example'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Tokens/revoke?name=example"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Tokens_revoke.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Tokens_revoke.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Tokens/,\n    q/revoke/,\n    {\n        'name' => 'example',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Tokens_revoke.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Tokens_revoke.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Tokens',\n    'revoke',\n    array (\n        'name' => 'example',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 80"}},"/DAV/enable_shared_global_addressbook":{"get":{"description":"This function enables the shared global address book for the current cPanel account's webmail accounts.","operationId":"enable_shared_global_addressbook","parameters":[{"description":"cPanel account username or a Webmail user's email address. If you do **not** specify a user, this parameter defaults to the currently-authenticated user.","in":"query","name":"name","required":false,"schema":{"example":"user","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"enable_shared_global_addressbook","type":"string"},"module":{"description":"The name of the module called.","example":"DAV","type":"string"},"result":{"properties":{"data":{"properties":{"shared":{"description":"Whether the global address book is shared.\n* 1 — Shared.\n* 0 — **Not** shared.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* 1 — Success.\n* 0 — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable global address book","tags":["DAV","Calendar and Contacts (DAV)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DAV \\\n  enable_shared_global_addressbook\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DAV/enable_shared_global_addressbook"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DAV_enable_shared_global_addressbook.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DAV_enable_shared_global_addressbook.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DAV/,\n    q/enable_shared_global_addressbook/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DAV_enable_shared_global_addressbook.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DAV_enable_shared_global_addressbook.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DAV',\n    'enable_shared_global_addressbook'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/UserTasks/delete":{"get":{"description":"This function deletes a process from the user task queue.\n\nEach cPanel account uses a separate user task queue in order to ensure that\nprocesses for one user do not impede another user on the server.\n\n* For example, the [*Git Version Control*](https://go.cpanel.net/GitVersionControl)\ninterface (*cPanel >> Home >> Files >> Git Version Control*) uses the user task queue\nto clone repositories (via the `VersionControl::create` function).\n* For more information, read our\n[Task Queue Monitor](https://go.cpanel.net/whmdocsTaskQueueMonitor) documentation.","operationId":"UserTasks::delete","parameters":[{"description":"The task's ID number.","in":"query","name":"id","required":true,"schema":{"example":"00000000\\/5a9ec8dd4c345d","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"delete","type":"string"},"module":{"description":"The name of the module called.","example":"UserTasks","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove item from task queue","tags":["UserTasks","SSE Task Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty --user=username UserTasks delete id='00000000\\/5a9ec8dd4c345d'"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/UserTasks/delete?id=00000000%5c%2f5a9ec8dd4c345d"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file UserTasks_delete.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/UserTasks_delete.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/UserTasks/,\n    q/delete/,\n    {\n        'id' => '00000000\\/5a9ec8dd4c345d',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file UserTasks_delete.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/UserTasks_delete.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'UserTasks',\n    'delete',\n    array (\n        'id' => '00000000\\/5a9ec8dd4c345d',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 72"}},"/DAV/has_shared_global_addressbook":{"get":{"description":"This function checks whether the shared global address book is enabled on the current cPanel account's webmail accounts.","operationId":"has_shared_global_addressbook","parameters":[{"description":"cPanel account user name or a Webmail user's email address. If you do **not** specify a user, this parameter defaults to the currently-authenticated user.","in":"query","name":"name","required":false,"schema":{"example":"user","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"has_shared_global_addressbook","type":"string"},"module":{"description":"The name of the module called.","example":"DAV","type":"string"},"result":{"properties":{"data":{"properties":{"shared":{"description":"Whether the global address book is enabled.\n* `1` — Enabled.\n* `0` — **Not** enabled.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return whether global address book is enabled","tags":["DAV","Calendar and Contacts (DAV)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DAV \\\n  has_shared_global_addressbook\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DAV/has_shared_global_addressbook"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DAV_has_shared_global_addressbook.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DAV_has_shared_global_addressbook.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DAV/,\n    q/has_shared_global_addressbook/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DAV_has_shared_global_addressbook.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DAV_has_shared_global_addressbook.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DAV',\n    'has_shared_global_addressbook'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/DAV/disable_shared_global_addressbook":{"get":{"description":"This function disables the shared global address book for the current cPanel account's webmail accounts.","operationId":"disable_shared_global_addressbook","parameters":[{"description":"cPanel account username or a Webmail user's email address. If you do **not** specify a user, this parameter defaults to the currently-authenticated user.","in":"query","name":"name","required":false,"schema":{"example":"user","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"disable_shared_global_addressbook","type":"string"},"module":{"description":"The name of the module called.","example":"DAV","type":"string"},"result":{"properties":{"data":{"properties":{"shared":{"description":"Whether the global address book is shared.\n* `1` — Shared.\n* `0` — **Not** shared.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` — Success.\n- `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Disable global address book","tags":["DAV","Calendar and Contacts (DAV)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DAV \\\n  disable_shared_global_addressbook\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DAV/disable_shared_global_addressbook"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DAV_disable_shared_global_addressbook.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DAV_disable_shared_global_addressbook.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DAV/,\n    q/disable_shared_global_addressbook/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DAV_disable_shared_global_addressbook.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DAV_disable_shared_global_addressbook.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DAV',\n    'disable_shared_global_addressbook'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/UserManager/create_user":{"get":{"description":"This function creates a Subaccount.","operationId":"UserManager::create_user","parameters":[{"description":"An alternate email address for the Subaccount's user.\n\n**Note:**\n\n You **must** use this parameter if you set the `send_invite` value to `1`.","in":"query","name":"alternate_email","required":false,"schema":{"default":null,"example":"user@example.com","format":"email","type":"string"}},{"description":"The URL path to the user's Subaccount profile photo.\n\n**Note:**\n\nYou **must** use the HTTPS protocol to prevent mixed content warnings when users view the image from another HTTPS URL.\n\n**Warning:**\n\nWe reserved this parameter for future use. Do **not** use this parameter.","in":"query","name":"avatar_url","required":false,"schema":{"default":null,"example":"https://img.example.com/avatars/example.jpg","format":"url","type":"string"}},{"description":"The Subaccount user's associated domain that the cPanel account owns.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"The Subaccount's password.\n\n**Note:**\n\n Email, FTP, and Web Disk services use this password.","in":"query","name":"password","required":true,"schema":{"example":"123456luggage","format":"password","type":"string"}},{"description":"A phone number for the Subaccount user that conforms to\n[ITU-T](https://en.wikipedia.org/wiki/ITU-T)'s [E.164](https://en.wikipedia.org/wiki/E.164)\nstandards.\n\n**Warning:**\n\nWe reserved this parameter for future use. Do **not** use this parameter.","in":"query","name":"phone_number","required":false,"schema":{"default":null,"example":"+15551234567","type":"string"}},{"description":"The Subaccount user's first and/or last name.","in":"query","name":"real_name","required":false,"schema":{"default":null,"example":"John Doe","type":"string"}},{"description":"Whether to send a reset password email to the Subaccount's alternate email address.\n\n* `1` - Send.\n* `0` - Do not send.","in":"query","name":"send_invite","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"Whether to grant the Subaccount email access.\n\n* `1` - Can access.\n* `0` - **Cannot** access.","in":"query","name":"services.email.enabled","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"The maximum amount of disk space, in megabytes (MB), allocated to Subaccount's email account.\n\n* `0` or `unlimited` - The subaccount has unlimited disk space.\n\nThis value defaults to the defined system value.\n\n**Note:**\n\nThis value **cannot** be larger than the system's maximum email quota.","in":"query","name":"services.email.quota","required":false,"schema":{"example":"500","type":"string"}},{"description":"Whether to send client configuration instructions to the account.\n\n* `1` - Send the instructions.\n* `0` - Do **not** send the instructions.","in":"query","name":"services.email.send_welcome_email","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to grant the Subaccount FTP access.\n\n* `1` - Can access.\n* `0` - **Cannot** access.","in":"query","name":"services.ftp.enabled","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"The Subaccount's FTP home directory, relative to the cPanel account's home directory.\n\n**Note:**\n\n* This parameter is **required** if you enabled the `services.ftp.homedir` parameter.\n* The directory **must** exist.","in":"query","name":"services.ftp.homedir","required":false,"schema":{"example":"/Subaccount","format":"path","type":"string"}},{"description":"Whether to grant the Subaccount Web Disk access.\n\n* `1` _ Can access.\n* `0` - **Cannot** access.","in":"query","name":"services.webdisk.enabled","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to enable the Web Disk Digest Authentication.\n\n* `1` - Enabled.\n* `0` - Disabled.\n\n**Note:**\n\n* **Only** enable Digest Authentication for clients that require additional compatibility support on\n  certain versions of Windows® operating systems. This compatibility support is **only** required on servers\n  that use a self-signed certificate for the `cpsrvd` and `cpdavd` daemons.\n* We recommend that you do **not** use Digest Authentication.","in":"query","name":"services.webdisk.enabledigest","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"Whether to set the directory's permissions to public or private.\n\n* `1` - Private (`0700`).\n* `0` - Public (`0755`).","in":"query","name":"services.webdisk.private","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"The Subaccount's Web Disk home directory, relative to the cPanel account's home directory.\n\n**Note:**\n\nThis parameter is **required** if you enable the `services.webdisk.enabled` parameter.","in":"query","name":"services.webdisk.homedir","required":false,"schema":{"example":"/Subaccount","format":"path","type":"string"}},{"description":"The Subaccount's file permissions for its Web Disk home directory.\n\n* `ro` - Read-only permissions.\n* `rw` - Read and write permissions.\n\n**Note:**\n\n The `services.webdisk.homedir` parameter determines the Subaccount's Web Disk home directory.","in":"query","name":"services.webdisk.perms","required":false,"schema":{"default":"rw","example":"rw","type":"string"}},{"description":"The type of account.\n\n* `sub` - A Subaccount.","in":"query","name":"type","required":false,"schema":{"default":"sub","enum":["sub"],"example":"sub","type":"string"}},{"description":"The username for the Subaccount. The username can only contain alphanumeric characters, dots (`.`), hyphens (`-`), and underscores (`_`).\n\n**Note:**\n\nThis value does **not** include the domain name.","in":"query","name":"username","required":true,"schema":{"example":"example","format":"username","maxLength":64,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"create_user","type":"string"},"module":{"description":"The name of the module called.","example":"UserManager","type":"string"},"result":{"properties":{"data":{"$ref":"#/components/schemas/CreateUserResponse"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create Subaccount","tags":["UserManager","Subaccount Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  UserManager \\\n  create_user \\\n  domain='example.com' \\\n  password='123456luggage' \\\n  username='example'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/UserManager/create_user?domain=example.com&password=123456luggage&username=example"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file UserManager_create_user.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/UserManager_create_user.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/UserManager/,\n    q/create_user/,\n    {\n        'domain' => 'example.com',\n        'password' => '123456luggage',\n        'username' => 'example',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file UserManager_create_user.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/UserManager_create_user.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'UserManager',\n    'create_user',\n    array (\n        'domain' => 'example.com',\n        'password' => '123456luggage',\n        'username' => 'example',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/UserManager/delete_user":{"get":{"description":"This function deletes a Subaccount. This function returns only metadata if no other service accounts exist with the same username and domain.\n* If one service account uses the same username and domain, the function returns the service account's information.\n* If two or more service accounts use the same username and domain, the function returns a hypothetical Subaccount.\n\n**Note:**\n\n* A hypothetical Subaccount consists of two or more service accounts that use the same username and domain.\n* This function returns only metadata if the specified username and domain do **not** match any service accounts or hypothetical Subaccounts.","operationId":"UserManager::delete_user","parameters":[{"description":"The Subaccount's username.\n* Characters — `a-z`, `A-Z`, `0-9`, dot (`.`), hyphen (`-`), underscore (`_`)\n\n**Note:**\n\nThis value does **not** include the domain name.","in":"query","name":"username","required":true,"schema":{"example":"example","maxLength":64,"type":"string"}},{"description":"The Subaccount's associated domain.  The domain **must** be one that the cPanel account owns.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"delete_user","type":"string"},"module":{"description":"The name of the module called.","example":"UserManager","type":"string"},"result":{"properties":{"data":{"properties":{"alternate_email":{"description":"An alternate email address for the account's user.","example":"user@example.com","format":"email","type":"string"},"avatar_url":{"description":"The user's account profile photo.  The URL must point to an image file.","example":"https://img.example.com/avatars/example.jpg","format":"url","type":"string"},"can_delete":{"description":"Whether the cPanel account user can delete the account.\n* `1` - Can delete.\n* `0` - **Cannot** delete.","enum":[0,1],"example":0,"type":"integer"},"can_set_password":{"description":"Whether the cPanel account user can change the account's password.\n* `1` - Can change password.\n* `0` - **Cannot** change password.\n\n**Note:**\n\nThe function returns `0` for accounts that inherit their password from the cPanel account.","enum":[0,1],"example":1,"type":"integer"},"can_set_quota":{"description":"Whether the cPanel account user can change the account's disk usage quota.\n* `1` - Can change quota.\n* `0` - **Cannot** change quota.","enum":[0,1],"example":0,"type":"integer"},"dismissed":{"description":"Whether the cPanel account user dismissed the merge prompt for the service account.\n* `1` - Dismissed prompt.\n* `0` - Did **not** dismiss prompt.\n\n**Note:**\n\n**Only** service accounts return this value.","enum":[0,1],"example":1,"type":"integer"},"dismissed_merge_candidates":{"description":"An array of objects that represent the service accounts that the user dismissed the merge prompt for.\nThis array will always return empty.\n\n**Note:**\n\nWe reserved this return for future use.","items":{"type":"object"},"type":"array"},"domain":{"description":"The account user's associated domain.","example":"example.com","format":"domain","type":"string"},"full_username":{"description":"The account's username and domain name, separated by the `@` character.","example":"user@example.com","type":"string"},"guid":{"description":"The account unique identifier.","example":"N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4","type":"string"},"has_expired_invite":{"description":"Whether the Subaccount owns an expired invitation.\n* `1` - Owns an expired invitation.\n* `0` - Does **not** own an expired invitation.","enum":[0,1],"example":0,"type":"integer"},"has_invite":{"description":"Whether the Subaccount owns an active invitation.\n* `1` - Owns an invitation.\n* `0` - Does **not** own an invitation.","enum":[0,1],"example":0,"type":"integer"},"has_siblings":{"description":"Whether the service account shares a `full_username` value with another service account.\n* `1` - Shares.\n* `0` - Does not share.","enum":[0,1],"example":0,"type":"integer"},"invite_expiration":{"description":"The time at which the new Subaccount invitation will expire, given as a valid Unix epoch time or null.\n\nIf the account does not own an active invitation, this value returns `null`.","example":1466258282,"format":"unix_timestamp","nullable":true,"type":"integer"},"issues":{"description":"Information about any issues or problems with the account.","items":{"properties":{"area":{"description":"The affected section of cPanel & WHM.","example":"quota","type":"string"},"limit":{"description":"The set quota megabyte (MB) limit for the affected account.","example":1500,"minimum":0,"type":"integer"},"message":{"description":"The description of the issue.","example":"Your account is over quota.","type":"string"},"service":{"description":"The affected service.\n* `email`\n* `ftp`\n* `webdisk`","enum":["email","ftp","webdisk"],"example":"email","type":"string"},"type":{"description":"The type of issue.\n* `error`\n* `warning`\n* `info`","enum":["error","warning","info"],"example":"info","type":"string"},"used":{"description":"The number of megabytes (MB) that the account currently uses.","example":2000,"minimum":0,"type":"integer"}}},"type":"array"},"merge_candidates":{"description":"The service accounts that the system could merge for this account.\n\n**Note:**\n\nYou can find descriptions for this array's returns within this table.","items":{"properties":{"alternate_email":{"type":"string"},"avatar_url":{"type":"string"},"can_delete":{"type":"integer"},"can_set_password":{"type":"integer"},"can_set_quota":{"type":"integer"},"dismissed":{"type":"integer"},"dismissed_merge_candidates":{"items":{"type":"string"},"type":"array"},"domain":{"format":"domain","type":"string"},"full_username":{"type":"string"},"guid":{"type":"string"},"has_expired_invite":{"type":"integer"},"has_invite":{"type":"integer"},"has_siblings":{"type":"integer"},"invite_expiration":{"type":"integer"},"issues":{"items":{"type":"string"},"type":"array"},"merge_candidates":{"items":{"type":"string"},"type":"array"},"parent_type":{"type":"string"},"phone_number":{"type":"string"},"real_name":{"type":"string"},"services":{"type":"object"},"special":{"type":"integer"},"sub_account_exists":{"type":"integer"},"synced_password":{"type":"integer"},"type":{"type":"string"},"username":{"format":"username","type":"string"}},"type":"object"},"type":"array"},"parent_type":{"description":"The type of account that could own the service account.\n* `sub` - An account.\n* `hypothetical` - A hypothetical account does **not** yet exist, but that the user could create as part of a merge.\n* `null` - **Not** a merge candidate.","enum":["sub","hypothetical"],"example":"hypothetical","nullable":true,"type":"string"},"phone_number":{"description":"The account user's phone number.\n* A valid phone number that conforms to [ITU-T](https://en.wikipedia.org/wiki/ITU-T)'s [E.164-recommended standard](https://en.wikipedia.org/wiki/E.164) for the representation of telephone numbers.","example":"+15551234567","type":"string"},"real_name":{"description":"The name of the account's user.\n* A first name, a last name, or a first name and last name.\n* An empty string.","example":"John Doe","type":"string"},"services":{"description":"Information about the account's access to email, FTP, and Web Disk.","properties":{"email":{"description":"Information that indicates the account's email status.","properties":{"enabled":{"description":"Whether the account can access Webmail, POP, and IMAP services.\n* `1` - Can access.\n* `0` - **Cannot** access.","enum":[1,0],"example":1,"type":"integer"},"quota":{"description":"The account's email disk space quota.\n* The set quota megabyte (MB) limit for the account's email disk space.\n* `0` - Unlimited.","example":100,"maximum":999999,"minimum":0,"type":"integer"}},"type":"object"},"ftp":{"description":"Information about the account's FTP status.","properties":{"enabled":{"description":"Whether the account can access FTP.\n* `1` - Can access.\n* `0` - **Cannot** access.","enum":[1,0],"example":0,"type":"integer"},"homedir":{"description":"The account's FTP home directory.\n* A valid path, relative to the cPanel account's home directory.","example":"/account","format":"path","type":"string"},"quota":{"description":"The account's FTP disk space quota.\n* An integer that represents the account's maximum FTP disk usage, in megabytes (MB).\n* `0` - Unlimited.","example":100,"minimum":0,"type":"integer"}},"type":"object"},"webdisk":{"description":"Information about the account's Web Disk status.","properties":{"enabled":{"description":"Whether the account can access Web Disk.\n* `1` - Can access.\n* `0` - **Cannot** access.","enum":[1,0],"example":0,"type":"integer"},"homedir":{"description":"The account's Web Disk directory.\n* A valid path, relative to the cPanel account's home directory.","example":"/bob","format":"path","type":"string"},"perms":{"description":"Whether to grant write permissions to the account.\n* `ro` - Read-only permissions.\n* `rw` - Read and write permissions.","example":"rw","type":"string"},"private":{"description":"Whether to set the Web Disk directory's permissions to public or private.\n* `1` - Private (0700).\n* `0` - Public (0755).","enum":[1,0],"example":0,"type":"integer"}},"type":"object"}},"type":"object"},"special":{"description":"Whether the account is a system-created special account that the user **cannot** remove.\n* `1` - A special account.\n* `0` - **Not** a special account.","enum":[1,0],"example":1,"type":"integer"},"sub_account_exists":{"description":"Whether an account exists with the same username.\n* `1` - Exists.\n* `0` - Does not exist.\n* `null` - The account is **not** a service account.","enum":[1,0],"example":0,"nullable":true,"type":"integer"},"synced_password":{"description":"Whether the user has synchronized the passwords for each of the account's service accounts.\n* `1` - Synchronized.\n* `0` - **Not** synchronized.\n* `null` - The account is **not** a Subaccount","enum":[1,0],"example":0,"nullable":true,"type":"integer"},"type":{"description":"The type of account.\n* `hypothetical` - A hypothetical account that does not exist, but that the user could create as part of a merge.\n* `service` - A service account.","enum":["hypothetical","service"],"example":"service","type":"string"},"username":{"description":"The account username.\n\nThe username must meet the account name limitations.\n* Characters - `a-z`, `A-Z`, `0-9`, dot (`.`), hyphen (`-`), underscore (`_`)\n\n**Note::**\n\nThis value does **not** include the domain name.","format":"username","maxLength":64,"type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete Subaccount","tags":["UserManager","Subaccount Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  UserManager \\\n  delete_user \\\n  username='example' \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/UserManager/delete_user?username=example&domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file UserManager_delete_user.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/UserManager_delete_user.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/UserManager/,\n    q/delete_user/,\n    {\n        'username' => 'example',\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file UserManager_delete_user.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/UserManager_delete_user.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'UserManager',\n    'delete_user',\n    array (\n        'username' => 'example',\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/UserManager/check_account_conflicts":{"get":{"description":"This function lists the other Subaccounts or services accounts that conflict\nwith the specified username.\n\n**Note:**\n\nIf the function returns more than one account, it will return some values\nmultiple times within the return arrays.","operationId":"check_account_conflicts","parameters":[{"description":"The Subaccount's username and domain name.","in":"query","name":"full_username","required":true,"schema":{"example":"username@example.com","format":"email","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"check_account_conflicts","type":"string"},"module":{"description":"The name of the module called.","example":"UserManager","type":"string"},"result":{"properties":{"data":{"properties":{"accounts":{"description":"An object containing the service accounts that match the queried `full_username` parameter.","properties":{"alternate_email":{"description":"An alternate email address for the Subaccount's user.","example":"user@example.com","format":"email","nullable":true,"type":"string"},"avatar_url":{"description":"The URL to the user's Subaccount profile image file.","example":"https://img.example.com/avatars/example.jpg","format":"url","nullable":true,"type":"string"},"can_delete":{"description":"Whether the cPanel account user can delete the Subaccount.\n\n* `1` — Can delete.\n* `0` — **Cannot** delete.","enum":[1,0],"example":0,"type":"integer"},"can_set_password":{"description":"Whether the cPanel account user can change the Subaccount's\npassword.\n\n* `1` — Can change the password.\n* `0` — **Cannot** change the password.\n\n**Note:**\n\nthe function returns `0` for Subaccounts that inherit their password\nfrom the cPanel account.","enum":[1,0],"example":1,"type":"integer"},"can_set_quota":{"description":"Whether the cPanel account user can change the Subaccount's\ndisk usage quota.\n\n* `1` — Can change the Subaccount's disk usage quota.\n* `0` — **Cannot** change the Subaccount's disk useage quota.","enum":[1,0],"example":0,"type":"integer"},"dismissed":{"description":"Whether the cPanel account user dismissed the merge prompt\nfor the service account.\n\n* `1` — Dismissed.\n* `0` — Did **not** dismiss.\n\n**Note:**\n\n**Only** service accounts return this value.","enum":[1,0],"example":1,"type":"integer"},"dismissed_merge_candidates":{"description":"A list of the service accounts that the user dismissed the merge\nprompt for.\n\n**Note:**\n\n* This array **always** returns empty.\n* We reserved this return for future use.","type":"array"},"domain":{"description":"The Subaccount user's associated domain.","example":"example.com","format":"domain","type":"string"},"full_username":{"description":"The Subaccount's username.","example":"username@example.com","format":"email","type":"string"},"guid":{"description":"The Subaccount's system-assigned unique identifier.","example":"N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4","type":"string"},"has_expired_invite":{"description":"Whether the Subaccount owns an expired invitation.\n\n* `1` — Owns an expired invitation.\n* `0` — Does **not** own an expired invitation.","enum":[1,0],"example":0,"type":"integer"},"has_invite":{"description":"Whether the Subaccount owns an active invitation.\n\n* `1` — Own an active invitation.\n* `0` — Does **not** own an active invitation.","enum":[1,0],"example":0,"type":"integer"},"has_siblings":{"description":"Whether the service account shares the queried `full_username` value\nwith another service account.\n\n* `1` — Shares the service account.\n* `0` — Does **not** share the service account.","enum":[1,0],"example":0,"type":"integer"},"invite_expiration":{"description":"The time at which the new Subaccount invitation will expire.\n\n* `null` — The account does **not** own an active invitation.","example":1600162200,"format":"unix_timestamp","nullable":true,"type":"integer"},"issues":{"description":"An array of objects containing information about any issues or problems with the Subaccount.","items":{"properties":{"area":{"description":"The affected section of cPanel & WHM.","example":"info","type":"string"},"limit":{"description":"The set megabyte (MB) quota limit for the affected Subaccount.","example":1500,"minimum":1,"type":"integer"},"message":{"description":"A description of the issue.","example":"Your account is over quota.","type":"string"},"service":{"description":"The affected service.\n\n* `email`\n* `ftp`\n* `webdisk`","enum":["email","ftp","webdisk"],"example":"email","type":"string"},"type":{"description":"The type of issue.\n\n* `error`\n* `warning`\n* `info`","enum":["error","warning","info"],"example":"info","type":"string"},"used":{"description":"The number of megabytes (MB) the account currently uses.","example":2000,"minimum":1,"type":"integer"}},"type":"object"},"type":"array"},"merge_candidates":{"description":"An array of objects containing the service accounts that the system could merge for this Subaccount.","items":{"properties":{"parent_type":{"description":"The type of account that could own the service account.\n\n* `sub` — A Subaccount.\n* `hypothetical` — A hypothetical Subaccount that does **not**\nyet exist, but that the user could create as part of a merge.\n* `null` — **Not** a merge candidate.","enum":["sub","hypothetical"],"nullable":true,"type":"string"},"phone_number":{"description":"The Subaccount user's phone number, in\n[ITU-T-recommended E.164](https://en.wikipedia.org/wiki/E.164)\nformat.","example":"+15551234567","type":"string"},"real_name":{"description":"The name of the Subaccount user, if provided.","example":"John Doe","type":"string"},"services":{"description":"Information about the Subaccount's access to email, FTP, and Web Disk.","properties":{"email":{"description":"Information that indicates the Subaccount's email status.","properties":{"enabled":{"description":"Whether the Subaccount can access Webmail, POP, and\nIMAP services.\n\n* `1` — Has service access.\n* `0` — Does **not** have service access.","enum":[1,0],"example":1,"type":"integer"},"quota":{"description":"The Subaccount's email disk space quota, in megabytes (MB).\n\n* `0` — The account has an unlimited email disk space quota.","example":100,"maximum":999999,"minimum":0,"type":"integer"}},"type":"object"},"ftp":{"description":"Information about the Subaccount's FTP status.","properties":{"enabled":{"description":"Whether the Subaccount can access FTP.\n\n* `1` — Has FTP service access.\n* `0` — Does **not** have FTP service access.","enum":[1,0],"example":0,"type":"integer"},"homedir":{"description":"The Subaccount's FTP directory, relative to the cPanel account's home directory.","example":"/Subaccount","type":"string"},"quota":{"description":"The Subaccount's FTP maximum disk space quota, in\nmegabytes (MB).\n\n* `0` — The account has an unlimited disk space quota.","example":100,"minimum":0,"type":"integer"}},"type":"object"},"webdisk":{"description":"Information about the Subaccount's Web Disk status.","properties":{"enabled":{"description":"Whether the Subaccount can access Web Disk.\n\n* `1` — Has Web Disk service access.\n* `0` — Does **not** have Web Disk service access.","enum":[1,0],"example":0,"type":"integer"},"homedir":{"description":"The Subaccount's Web Disk directory, relative to the cPanel account's home directory.","example":"/username","type":"string"},"perms":{"description":"Whether the Web Disk has read or read and write\npermissions.\n\n* `ro` — Read-only permissions.\n* `rw` — Read and write permissions.","enum":["ro","rw"],"example":"rw","type":"string"},"private":{"description":"Whether the Web Disk directory permissions are public\nor private.\n\n* `1` — Private (`0700`).\n* `0` — Public (`0755`).","enum":[1,0],"example":0,"type":"integer"}},"type":"object"}},"type":"object"},"special":{"description":"Whether the account is a system-created special account that\nthe user **cannot** remove.\n\n* `1` — The user can remove the account.\n* `0` — The user **cannot** remove the account.","enum":[1,0],"example":1,"type":"integer"},"sub_account_exists":{"description":"Whether a Subaccount exists with the same username.\n\n* `1` — Exists.\n* `0` — Does **not** exist.\n* `null` — The account is **not** a Subaccount.","enum":[1,0],"example":0,"nullable":true,"type":"integer"},"synced_password":{"description":"Whether the user has synchronized the passwords for each of\nthe Subaccount's service accounts.\n\n* `1` — Synchronized.\n* `0` — **Not** synchronized.\n* `null` — The account is **not** a Subaccount.","enum":[1,0],"example":0,"nullable":true,"type":"integer"},"type":{"description":"The type of account.\n\n* `sub` — A Subaccount.\n* `hypothetical` — A hypothetical Subaccount that does **not**\nyet exist, but that the user could create as part of a merge.\n* `service` — A service account.\n* `cpanel` — A cPanel account.","enum":["sub","hypothetical","service","cpanel"],"example":"sub","type":"string"},"username":{"description":"The username for the Subaccount.\n\n**Note:**\n\nThis value does **not** include the domain name.","example":"username","format":"username","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"conflict":{"description":"Whether the system detected an account conflict.\n\n* `1` — Conflict.\n* `0` — **No** conflict.","enum":[1,0],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return Subaccounts and service accounts conflicts","tags":["UserManager","Subaccount Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  UserManager \\\n  check_account_conflicts \\\n  full_username='username@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/UserManager/check_account_conflicts?full_username=username%40example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file UserManager_check_account_conflicts.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/UserManager_check_account_conflicts.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/UserManager/,\n    q/check_account_conflicts/,\n    {\n        'full_username' => 'username@example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file UserManager_check_account_conflicts.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/UserManager_check_account_conflicts.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'UserManager',\n    'check_account_conflicts',\n    array (\n        'full_username' => 'username@example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 56"}},"/UserManager/dismiss_merge":{"get":{"description":"This function removes a service account as a link candidate to create a subaccount or\nlink to a subaccount. When you use this function, the system removes the *Link* option in\ncPanel's [*User Manager*](https://go.cpanel.net/cpaneldocsUserManager) interface (_cPanel >> Home >> Preferences >> User Manager_).\n\n**Note:**\n\nYou **must** use at least one of the following parameters:\n* `services.email.dismiss`\n* `services.ftp.dismiss`\n* `services.webdisk.dismiss`","operationId":"dismiss_merge","parameters":[{"description":"The username for the service account.\n\n**Note:**\n\nThis parameter does **not** include the domain name.","in":"query","name":"username","required":true,"schema":{"example":"example1","format":"username","maxLength":64,"type":"string"}},{"description":"The service account's associated domain.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"Whether to dismiss the merge of the email service account.\n\n* `1` - Dismiss.\n* `0` - Do **not** dismiss.","in":"query","name":"services.email.dismiss","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to dismiss the merge of the FTP service account.\n\n* `1` - Dismiss.\n* `0` - Do **not** dismiss.","in":"query","name":"services.ftp.dismiss","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to dismiss the merge of the Web Disk service account.\n\n* `1` - Dismiss.\n* `0` - Do **not** dismiss.","in":"query","name":"services.webdisk.dismiss","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"dismiss_merge","type":"string"},"module":{"description":"The name of the module called.","example":"UserManager","type":"string"},"result":{"properties":{"data":{},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove service account link request","tags":["UserManager","Subaccount Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  UserManager \\\n  dismiss_merge \\\n  username='example1' \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/UserManager/dismiss_merge?username=example1&domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file UserManager_dismiss_merge.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/UserManager_dismiss_merge.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/UserManager/,\n    q/dismiss_merge/,\n    {\n        'username' => 'example1',\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file UserManager_dismiss_merge.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/UserManager_dismiss_merge.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'UserManager',\n    'dismiss_merge',\n    array (\n        'username' => 'example1',\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/UserManager/lookup_service_account":{"get":{"description":"This function lists a service account's information.","operationId":"lookup_service_account","parameters":[{"description":"The type of system account.\n* `email`\n* `ftp`\n* `webdisk`","in":"query","name":"type","required":true,"schema":{"enum":["email","ftp","webdisk"],"example":"email","type":"string"}},{"description":"The full username for the system account.","in":"query","name":"full_username","required":true,"schema":{"example":"username@example.com","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"lookup_service_account","type":"string"},"module":{"description":"The name of the module called.","example":"UserManager","type":"string"},"result":{"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/LookupServiceAccountSubaccountBase"},{"$ref":"#/components/schemas/LookupServiceAccountSubaccountMergeCandidates"}],"properties":{"dismissed_merge_candidates":{"description":"An array of objects of service candidates that the system dismissed from merges.","items":{"$ref":"#/components/schemas/LookupServiceAccountSubaccountMergeCandidates"},"type":"array"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return service account's information","tags":["UserManager","Subaccount Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  UserManager \\\n  lookup_service_account \\\n  type='email' \\\n  full_username='username@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/UserManager/lookup_service_account?type=email&full_username=username%40example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file UserManager_lookup_service_account.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/UserManager_lookup_service_account.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/UserManager/,\n    q/lookup_service_account/,\n    {\n        'type' => 'email',\n        'full_username' => 'username@example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file UserManager_lookup_service_account.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/UserManager_lookup_service_account.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'UserManager',\n    'lookup_service_account',\n    array (\n        'type' => 'email',\n        'full_username' => 'username@example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/UserManager/edit_user":{"get":{"description":"This function edits a Subaccount.","operationId":"edit_user","parameters":[{"description":"An alternate email address for the Subaccount's user.\n\n**Note:**\n\n The cPanel account user could use this email address to contact the Subaccount user if their primary email address's domain is unavailable.","in":"query","name":"alternate_email","required":false,"schema":{"default":null,"example":"user@example.com","format":"email","nullable":true,"type":"string"}},{"description":"**Warning:**\n\n We reserved this parameter for future use. Do **not** use this parameter.\n\nThe user's Subaccount profile photo.\n\n**Note:**\n\n You **must** use the HTTPS protocol to prevent mixed content warnings when users view the photo from another HTTPS URL.","in":"query","name":"avatar_url","required":false,"schema":{"default":null,"example":"https://img.example.com/avatars/example.jpg","format":"url","nullable":true,"type":"string"}},{"description":"The Subaccount user's associated domain.\n\nA domain that the cPanel account owns.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"The Subaccount's new password.\n\n**Note:**\n\n The Subaccount uses this password for email, FTP, and Web Disk services.","in":"query","name":"password","required":false,"schema":{"example":"12345luggage","type":"string"}},{"description":"The Subaccount user's phone number.\n\n**Warning:**\n\n We reserved this parameter for future use. Do **not** use this parameter.\n\nThe number conforms to the [ITU-T](https://en.wikipedia.org/wiki/ITU-T)'s [E.164](https://en.wikipedia.org/wiki/E.164)-recommended standard for the representation of telephone numbers.","in":"query","name":"phone_number","required":false,"schema":{"default":null,"example":"+15551234567","nullable":true,"type":"string"}},{"description":"The Subaccount user's name.\n\n* A first name.\n* A last name.\n* A first name and last name.\n* An empty string.","in":"query","name":"real_name","required":false,"schema":{"default":null,"example":"John Doe","nullable":true,"type":"string"}},{"description":"Whether to grant the Subaccount email access.\n\n* `1` - Can access.\n* `0` - **Cannot** access.","in":"query","name":"services.email.enabled","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"The maximum amount of disk space, in megabytes (MB), that the subaccount's email account may use.\n\nIf you do not declare a value, the system defaults to the defined system value.\n\n**Note:**\n\n This value **cannot** be greater than the maximum email quota.\n\n* `0` or `unlimited` - The subaccount possesses unlimited disk space.","in":"query","name":"services.email.quota","required":false,"schema":{"example":500,"type":"integer"}},{"description":"Whether to grant the Subaccount FTP access.\n\n* `1` - Can access.\n* `0` - **Cannot** access.","in":"query","name":"services.ftp.enabled","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"The Subaccount's FTP home directory.\n\n**Note:**\n\n This parameter is **required** if you enable FTP access.\n\nA relative path from the cPanel account's home directory.\n\n**Note:**\n\n The specified directory **must** exist.","in":"query","name":"services.ftp.homedir","required":false,"schema":{"example":"/Subaccount","format":"path","type":"string"}},{"description":"Whether to grant the Subaccount Web Disk access.\n\n* `1` - Can access.\n* `0` - **Cannot** access.","in":"query","name":"services.webdisk.enabled","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to enable Web Disk digest authentication.\n\n**Notes:**\n\n * **Only** enable Digest Authentication for clients that require additional compatibility support on certain versions of Windows® operating systems. This compatibility support is **only** required on servers that use a self-signed certificate for the `cpsrvd` and `cpdavd` daemons.\n * We recommend that you do **not** use Digest Authentication.\n\n\n* `1` - Enabled\n* `0` - Disabled.","in":"query","name":"services.webdisk.enabledigest","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"Whether to set the Web Disk directory's permissions to public or private.\n\n* `1` - Private (`0700`).\n* `0` - Public (`0755`).","in":"query","name":"services.webdisk.private","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"The Subaccount's Web Disk home directory.\n\n**Note:**\n\n This parameter is **required** if you enable Web Disk access.\n\nA relative path from the cPanel account's home directory.","in":"query","name":"services.webdisk.homedir","required":false,"schema":{"example":"/Subaccount","format":"path","type":"string"}},{"description":"Whether to grant write permissions to the Subaccount.\n\n**Note:**\n\n The `services.webdisk.homedir` parameter determines the Subaccount's Web Disk home directory.\n\n* `ro` - Read-only permissions.\n* `rw` - Read and write permissions.","in":"query","name":"services.webdisk.perms","required":false,"schema":{"default":"rw","enum":["ro","rw"],"example":"rw","type":"string"}},{"description":"The type of account.\n\n* `sub` - A Subaccount.","in":"query","name":"type","required":false,"schema":{"default":"sub","enum":["sub"],"example":"sub","type":"string"}},{"description":"The Subaccount's username.\n\n* Length - 64 characters.\n* Characters - `a-z`, `A-Z`, `0-9`, dot (`.`), hyphen (`-`), underscore (`_`).\n\n**Note:**\n\n This value does **not** include the domain name.","in":"query","name":"username","required":true,"schema":{"example":"example","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"edit_user","type":"string"},"module":{"description":"The name of the module called.","example":"UserManager","type":"string"},"result":{"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/EditUserSubaccountBase"},{"$ref":"#/components/schemas/SubaccountMergeCandidates"}],"properties":{"dismissed_merge_candidates":{"description":"An array of objects of service candidates that the system dismissed from merges.","items":{"$ref":"#/components/schemas/SubaccountMergeCandidates"},"type":"array"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update Subaccount settings","tags":["UserManager","Subaccount Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  UserManager \\\n  edit_user \\\n  domain='example.com' \\\n  password='12345luggage' \\\n  username='example'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/UserManager/edit_user?domain=example.com&password=12345luggage&username=example"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file UserManager_edit_user.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/UserManager_edit_user.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/UserManager/,\n    q/edit_user/,\n    {\n        'domain' => 'example.com',\n        'password' => '12345luggage',\n        'username' => 'example',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file UserManager_edit_user.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/UserManager_edit_user.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'UserManager',\n    'edit_user',\n    array (\n        'domain' => 'example.com',\n        'password' => '12345luggage',\n        'username' => 'example',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/UserManager/lookup_user":{"get":{"description":"This function lists a single Subaccount's information.","operationId":"lookup_user","parameters":[{"description":"The Subaccount's unique identifier.","in":"query","name":"guid","required":true,"schema":{"example":"EXAMPLE1:EXAMPLE.COM:564CD663%3AFE50072F2620B50988EA4E5F46022546FBE6BDDE3C36C2F2534F4967C661EC37","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"lookup_user","type":"string"},"module":{"description":"The name of the module called.","example":"UserManager","type":"string"},"result":{"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/ServiceAccount"},{"properties":{"dismissed_merge_candidates":{"description":"An array of service account objects that the system dismissed from merges.","items":{"$ref":"#/components/schemas/ServiceAccount"},"type":"array"},"has_expired_invite":{"description":"Whether an expired account login invitation exists.\n* `1` - Expired account invitation exists.\n* `0` - Expired account invitation does not exist.","enum":[0,1],"example":0,"type":"integer"},"has_invite":{"description":"Whether an account login invitation exists.\n* `1` -  Account invitation exists.\n* `0` -  Account invitation does not exist.","enum":[0,1],"example":0,"type":"integer"},"invite_expiration":{"description":"When the invitation expires.","example":1591718154,"format":"unix_timestamp","nullable":true,"type":"integer"}}},{"type":"object"}]},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return Subaccount's information","tags":["UserManager","Subaccount Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  UserManager \\\n  lookup_user \\\n  guid='EXAMPLE1:EXAMPLE.COM:564CD663%3AFE50072F2620B50988EA4E5F46022546FBE6BDDE3C36C2F2534F4967C661EC37'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/UserManager/lookup_user?guid=EXAMPLE1%3aEXAMPLE.COM%3a564CD663%253AFE50072F2620B50988EA4E5F46022546FBE6BDDE3C36C2F2534F4967C661EC37"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file UserManager_lookup_user.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/UserManager_lookup_user.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/UserManager/,\n    q/lookup_user/,\n    {\n        'guid' => 'EXAMPLE1:EXAMPLE.COM:564CD663%3AFE50072F2620B50988EA4E5F46022546FBE6BDDE3C36C2F2534F4967C661EC37',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file UserManager_lookup_user.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/UserManager_lookup_user.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'UserManager',\n    'lookup_user',\n    array (\n        'guid' => 'EXAMPLE1:EXAMPLE.COM:564CD663%3AFE50072F2620B50988EA4E5F46022546FBE6BDDE3C36C2F2534F4967C661EC37',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/UserManager/unlink_service_account":{"get":{"description":"This function unlinks a service account from a subaccount.","operationId":"unlink_service_account","parameters":[{"description":"The subaccount's username.\n\n**Note:**\n\nThis value does **not** include the domain name.","in":"query","name":"username","required":true,"schema":{"example":"example","format":"username","type":"string"}},{"description":"The subaccount's associated domain.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"The service to unlink.\n\n* `email`\n* `ftp`\n* `webdisk`","in":"query","name":"service","required":true,"schema":{"enum":["email","ftp","webdisk"],"example":"ftp","type":"string"}},{"description":"Whether to dismiss the service account as a merge candidate.\n* `1` - Dismiss as merge candidate.\n* `0` - Display as merge candidate.\n\n**Note:**\n\n If any email, FTP, or Web Disk accounts use the same username, cPanel's [*User Manager*](https://go.cpanel.net/cpaneldocsUserManager) interface (*cPanel >> Home >> Preferences >> User Manager*) allows you to merge those accounts into a subaccount.","in":"query","name":"dismiss","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"unlink_service_account","type":"string"},"module":{"description":"The name of the module called.","example":"UserManager","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Unregister service account from Subaccount","tags":["UserManager","Subaccount Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  UserManager \\\n  unlink_service_account \\\n  username='example' \\\n  domain='example.com' \\\n  service='ftp'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/UserManager/unlink_service_account?username=example&domain=example.com&service=ftp"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file UserManager_unlink_service_account.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/UserManager_unlink_service_account.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/UserManager/,\n    q/unlink_service_account/,\n    {\n        'username' => 'example',\n        'domain' => 'example.com',\n        'service' => 'ftp',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file UserManager_unlink_service_account.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/UserManager_unlink_service_account.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'UserManager',\n    'unlink_service_account',\n    array (\n        'username' => 'example',\n        'domain' => 'example.com',\n        'service' => 'ftp',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 56"}},"/UserManager/merge_service_account":{"get":{"description":"This function links service accounts to subaccounts and creates a subaccount if one does not exist.\n\n**Note:**\n\nYou can only link email, FTP, or Web Disk accounts.\n\n**Important**\n\nYou must use at least **one** of the following parameters:\n\n* services.email.merge\n* services.ftp.merge\n* services.webdisk.merge\n\nTo link multiple service accounts, the service accounts **must** share the same username and domain.","operationId":"merge_service_account","parameters":[{"description":"The username for the service account that meets the account name limitations.\n\n* Length - 64 characters\n* Characters — `a-z`, `A-Z`, `0-9`, dot (`.`), hyphen (`-`), underscore (`_`).\n\n**Note:**\n\nThis value does **not** include the domain name.","in":"query","name":"username","required":true,"schema":{"example":"example","format":"username","type":"string"}},{"description":"The service account's associated domain.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"Whether to link the email account to the subaccount.\n\n* `1` - Merge.\n* `0` - Do **not** merge.","in":"query","name":"services.email.merge","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to link the FTP account to the subaccount.\n\n* `1` - Merge.\n* `0` - Do **not** merge.","in":"query","name":"services.ftp.merge","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to link the Web Disk account to the subaccount.\n\n* `1` - Merge.\n* `0` - Do **not** merge.","in":"query","name":"services.webdisk.merge","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"merge_service_account","type":"string"},"module":{"description":"The name of the module called.","example":"UserManager","type":"string"},"result":{"properties":{"data":{"properties":{"alternate_email":{"description":"An alternate email address for the subaccount's user.","example":"user@example.com","format":"email","type":"string"},"avatar_url":{"description":"The user's subaccount profile photo.","example":"https://img.example.com/avatars/example.jpg","format":"url","type":"string"},"can_delete":{"description":"Whether the cPanel account user can delete the subaccount.\n* `1` - Can delete.\n* `0` - **Cannot** delete.","enum":[0,1],"example":0,"type":"integer"},"can_set_password":{"description":"Whether the cPanel account user can change the subaccount's password.\n* `1` - Can change.\n* `0` - **Cannot** change.\n\n**Note:**\n\nThe function returns a `0` value for subaccounts that inherit their password from the cPanel account.","enum":[0,1],"example":1,"type":"integer"},"can_set_quota":{"description":"Whether the cPanel account user can change the subaccount's disk usage quota.\n* `1` - Can change.\n* `0` - **Cannot** change.","enum":[0,1],"example":0,"type":"integer"},"dismissed":{"description":"Whether the cPanel account user dismissed the merge prompt for the service account.\n\n**Note:**\n\nOnly service accounts return this value.\n* `1` - Dismissed.\n* `0` - Did **not** dismiss.","enum":[0,1],"example":1,"type":"integer"},"dismissed_merge_candidates":{"description":"An array of objects of service candidates that the system dismissed from merges.","items":{"properties":{"alternate_email":{"description":"An alternate email address for the subaccount's user.","example":"user@example.com","format":"email","type":"string"},"avatar_url":{"description":"The user's subaccount profile photo.","example":"https://img.example.com/avatars/example.jpg","format":"url","type":"string"},"can_delete":{"description":"Whether the cPanel account user can delete the subaccount.\n* `1` - Can delete.\n* `0` - **Cannot** delete.","enum":[0,1],"example":0,"type":"integer"},"can_set_password":{"description":"Whether the cPanel account user can change the subaccount's password.\n* `1` - Can change.\n* `0` - **Cannot** change.\n\n**Note:**\n\nThe function returns a `0` value for subaccounts that inherit their password from the cPanel account.","enum":[0,1],"example":1,"type":"integer"},"can_set_quota":{"description":"Whether the cPanel account user can change the subaccount's disk usage quota.\n* `1` - Can change.\n* `0` - **Cannot** change.","enum":[0,1],"example":0,"type":"integer"},"domain":{"description":"The subaccount user's associated domain that the cPanel account owns.","example":"example.com","format":"domain","type":"string"},"full_username":{"description":"The subaccount's username and domain name.","example":"user@example.com","format":"email","type":"string"},"guid":{"description":"The subaccount unique identifier. The system assigned unique value.","example":"N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4","type":"string"},"has_siblings":{"description":"Whether the service account shares a `full_username` value with another service account.\n* `1` - Shares.\n* `0` - Does **not** share.","enum":[0,1],"example":0,"type":"integer"},"issues":{"description":"Information about any issues or problems with the subaccount.","items":{"properties":{"area":{"description":"The affected section of cPanel & WHM.","example":"quota","type":"string"},"limit":{"description":"The set quota megabyte (MB) limit for the affected subaccount.","example":1500,"minimum":1,"type":"integer"},"message":{"description":"The description of the issue.","example":"Your account is over quota.","type":"string"},"service":{"description":"The affected service.\n* `email`\n* `ftp`\n* `webdisk`","enum":["email","ftp","webdisk"],"example":"email","type":"string"},"type":{"description":"The type of issue.\n\n* `error`\n* `warning`\n* `info`","enum":["error","warning","info"],"example":"info","type":"string"},"used":{"description":"The number of megabytes (MB) that the account currently uses.","example":2000,"minimum":1,"type":"integer"}},"type":"object"},"type":"array"},"parent_type":{"description":"The type of account that could own the service account.\n* `sub`          - A subaccount.\n* `hypothetical` - A hypothetical subaccount that does not yet exist, but the user could create as part of a merge.\n* `null`         - **Not** a merge candidate.","enum":["sub","hypothetical"],"example":"hypothetical","nullable":true,"type":"string"},"phone_number":{"description":"The subaccount user's phone number.","example":"+15551234567","type":"string"},"real_name":{"description":"The name of the subaccount's user.\n\n* A first name.\n* Last name.\n* First name and last name.\n* An empty string.","example":"John Doe","type":"string"},"services":{"description":"This object contains information about the subaccount's access to email, FTP, and Web Disk.","properties":{"email":{"description":"This object contains the information that indicates the subaccount's email status.","properties":{"enabled":{"description":"Whether the subaccount can access Webmail, POP, and IMAP services.\n\n* `1` - Can access.\n* `0` - **Cannot** access.","enum":[0,1],"example":1,"type":"integer"},"quota":{"description":"The maximum amount of disk space allocated to subaccount's email account. A positive integer that represents the maximum disk space that the subaccount may use, in megabytes (MB).\n\n**Note:**\n\nThis function will **not** return `0` as a value.","example":100,"type":"integer"}},"type":"object"},"ftp":{"description":"This object contains the information that indicates the subaccount's FTP status.","properties":{"enabled":{"description":"Whether the subaccount can access FTP.\n* `1` - Can access.\n* `0` - **Cannot** access.","enum":[0,1],"example":0,"type":"integer"},"homedir":{"description":"The subaccount's FTP home directory.","example":"/subaccount","format":"path","type":"string"},"quota":{"description":"The subaccount's FTP disk space quota.\n* >= `1` - Represents the maximum disk space that the subaccount may use, in megabytes (MB).\n* `0`   - Unlimited.","example":100,"maximum":999999,"minimum":0,"type":"integer"}},"type":"object"},"webdisk":{"description":"This object contains information that indicates the subaccount's Web Disk status.","properties":{"enabled":{"description":"Whether the subaccount can access Web Disk.\n* `1` - Can access.\n* `0` - **Cannot** access.","enum":[0,1],"example":0,"type":"integer"},"homedir":{"description":"The subaccount's Web Disk home directory.","example":"/bob","format":"path","type":"string"},"perms":{"description":"Whether to grant write permissions to the subaccount.\n* `ro` - Read-only permissions.\n* `rw` - Read and write permissions.","enum":["ro","rw"],"example":"rw","type":"string"},"private":{"description":"Whether to set the Web Disk directory's permissions to public or private.\n* `1` - Private (0700).\n* `0` - Public (0755).","enum":[0,1],"example":0,"type":"integer"}},"type":"object"}},"type":"object"},"special":{"description":"Whether the account is a system-created special account that the user **cannot** remove.\n* `1` - A special account.\n* `0` - **Not** a special account.","enum":[0,1],"example":1,"type":"integer"},"sub_account_exists":{"description":"Whether a subaccount exists with the same username.\n\n* `1` - Exists.\n* `0` - Does **not** exist.\n\n**Note:**\n\nThe function returns a `null` value if the account is not a service account.","enum":[0,1],"example":0,"nullable":true,"type":"integer"},"synced_password":{"description":"Whether the user has synchronized the passwords for each of the subaccount's service accounts.\n\n* `1` - Synchronized.\n* `0` - **Not** synchronized.\n\n**Note:**\n\nThe function returns a `null` value if the account is **not** a subaccount.","enum":[0,1],"example":0,"nullable":true,"type":"integer"},"type":{"description":"The type of account.\n\n* `sub` - A subaccount.\n* `hypothetical` - A hypothetical subaccount that does **not** exist, but that the user could create as part of a merge.\n* `service` - A service account.\n* `cpanel` - The cPanel account.","enum":["sub","hypothetical","service","cpanel"],"example":"sub","type":"string"},"username":{"description":"The username for the subaccount.","example":"example","format":"username","type":"string"}},"type":"object"},"type":"array"},"domain":{"description":"The subaccount user's associated domain. A domain that the cPanel account owns.","example":"example.com","format":"domain","type":"string"},"full_username":{"description":"The subaccount's username and domain name.","example":"user@example.com","format":"email","type":"string"},"guid":{"description":"The subaccount unique identifier. The system assigned unique value.","example":"N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4","type":"string"},"has_expired_invite":{"description":"Whether an expired account login invitation exists.\n* `1` - Expired account invitation exists.\n* `0` - Expired account invitation does **not** exist.","enum":[0,1],"example":0,"type":"integer"},"has_invite":{"description":"Whether an account login invitation exists.\n* `1` - Account invitation exists.\n* `0` - Account invitation does **not** exist.","enum":[0,1],"example":0,"type":"integer"},"has_siblings":{"description":"Whether the service account shares a `full_username` value with another service account.\n* `1` - Shares.\n* `0` - Does **not** share.","enum":[0,1],"example":0,"type":"integer"},"invite_expiration":{"description":"When the invitation expires.","example":1591718154,"format":"unix_timestamp","type":"integer"},"issues":{"description":"Information about any issues or problems with the subaccount.","items":{"properties":{"area":{"description":"The affected section of cPanel & WHM.","example":"quota","type":"string"},"limit":{"description":"The set quota megabyte (MB) limit for the affected subaccount.","example":1500,"minimum":1,"type":"integer"},"message":{"description":"The description of the issue.","example":"Your account is over quota.","type":"string"},"service":{"description":"The affected service.\n* `email`\n* `ftp`\n* `webdisk`","enum":["email","ftp","webdisk"],"example":"email","type":"string"},"type":{"description":"The type of issue.\n\n* `error`\n* `warning`\n* `info`","enum":["error","warning","info"],"example":"info","type":"string"},"used":{"description":"The number of megabytes (MB) that the account currently uses.","example":2000,"minimum":1,"type":"integer"}},"type":"object"},"type":"array"},"merge_candidates":{"description":"An array of objects that represents the service accounts that the system could merge for this subaccount.","items":{"properties":{"alternate_email":{"description":"An alternate email address for the subaccount's user.","example":"user@example.com","format":"email","type":"string"},"avatar_url":{"description":"The user's subaccount profile photo.","example":"https://img.example.com/avatars/example.jpg","format":"url","type":"string"},"can_delete":{"description":"Whether the cPanel account user can delete the subaccount.\n* `1` - Can delete.\n* `0` - **Cannot** delete.","enum":[0,1],"example":0,"type":"integer"},"can_set_password":{"description":"Whether the cPanel account user can change the subaccount's password.\n* `1` - Can change.\n* `0` - **Cannot** change.\n\n**Note:**\n\nThe function returns a `0` value for subaccounts that inherit their password from the cPanel account.","enum":[0,1],"example":1,"type":"integer"},"can_set_quota":{"description":"Whether the cPanel account user can change the subaccount's disk usage quota.\n* `1` - Can change.\n* `0` - **Cannot** change.","enum":[0,1],"example":0,"type":"integer"},"domain":{"description":"The subaccount user's associated domain. A domain that the cPanel account owns.","example":"example.com","format":"domain","type":"string"},"full_username":{"description":"The subaccount's username and domain name.","example":"user@example.com","format":"email","type":"string"},"guid":{"description":"The subaccount unique identifier. The system assigned unique value.","example":"N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4","type":"string"},"has_siblings":{"description":"Whether the service account shares a `full_username` value with another service account.\n* `1` - Shares.\n* `0` - Does **not** share.","enum":[0,1],"example":0,"type":"integer"},"issues":{"description":"Information about any issues or problems with the subaccount.","items":{"properties":{"area":{"description":"The affected section of cPanel & WHM.","example":"quota","type":"string"},"limit":{"description":"The set quota megabyte (MB) limit for the affected subaccount.","example":1500,"minimum":1,"type":"integer"},"message":{"description":"The description of the issue.","example":"Your account is over quota.","type":"string"},"service":{"description":"The affected service.\n* `email`\n* `ftp`\n* `webdisk`","enum":["email","ftp","webdisk"],"example":"email","type":"string"},"type":{"description":"The type of issue.\n\n* `error`\n* `warning`\n* `info`","enum":["error","warning","info"],"example":"info","type":"string"},"used":{"description":"The number of megabytes (MB) that the account currently uses.","example":2000,"minimum":1,"type":"integer"}},"type":"object"},"type":"array"},"parent_type":{"description":"The type of account that could own the service account.\n* `sub` - A subaccount.\n* `hypothetical` - A hypothetical subaccount that does **not** yet exist, but the user could create as part of a merge.\n* `null` - Not a merge candidate.","enum":["sub","hypothetical"],"example":"hypothetical","nullable":true,"type":"string"},"phone_number":{"description":"The subaccount user's phone number.","example":"+15551234567","type":"string"},"real_name":{"description":"The name of the subaccount's user.\n\n* A first name.\n* Last name.\n* First name and last name.\n* An empty string.","example":"John Doe","type":"string"},"services":{"description":"This object contains information about the subaccount's access to email, FTP, and Web Disk.","properties":{"email":{"description":"This object contains the information that indicates the subaccount's email status.","properties":{"enabled":{"description":"Whether the subaccount can access Webmail, POP, and IMAP services.\n\n* `1` - Can access.\n* `0` - **Cannot** access.","enum":[0,1],"example":1,"type":"integer"},"quota":{"description":"The maximum amount of disk space allocated to subaccount's email account. A positive integer that represents the maximum disk space that the subaccount may use, in megabytes (MB).\n\n**Note:**\n\nThis function will **not** return `0` as a value.","example":100,"type":"integer"}},"type":"object"},"ftp":{"description":"This object contains the information that indicates the subaccount's FTP status.","properties":{"enabled":{"description":"Whether the subaccount can access FTP.\n* `1` - Can access.\n* `0` - **Cannot** access.","enum":[0,1],"example":0,"type":"integer"},"homedir":{"description":"The subaccount's FTP home directory.","example":"/subaccount","format":"path","type":"string"},"quota":{"description":"The subaccount's FTP disk space quota.\n* >= `1` - Represents the maximum disk space that the subaccount may use, in megabytes (MB).\n* `0`   - Unlimited.","example":100,"maximum":999999,"minimum":0,"type":"integer"}},"type":"object"},"webdisk":{"description":"This object contains information that indicates the subaccount's Web Disk status.","properties":{"enabled":{"description":"Whether the subaccount can access Web Disk.\n* `1` - Can access.\n* `0` - **Cannot** access.","enum":[0,1],"example":0,"type":"integer"},"homedir":{"description":"The subaccount's Web Disk home directory.","example":"/bob","format":"path","type":"string"},"perms":{"description":"Whether to grant write permissions to the subaccount.\n* `ro` - Read-only permissions.\n* `rw` - Read and write permissions.","example":"rw","type":"string"},"private":{"description":"Whether to set the Web Disk directory's permissions to public or private.\n* `1` - Private (0700).\n* `0` - Public (0755).","enum":[0,1],"example":0,"type":"integer"}},"type":"object"}},"type":"object"},"special":{"description":"Whether the account is a system-created special account that the user **cannot** remove.\n* `1` - A special account.\n* `0` - **Not** a special account.","enum":[0,1],"example":1,"type":"integer"},"sub_account_exists":{"description":"Whether a subaccount exists with the same username.\n\n* `1` - Exists.\n* `0` - Does **not** exist.\n\n**Note:**\n\nThe function returns a `null` value if the account is **not** a service account.","enum":[0,1],"example":0,"nullable":true,"type":"integer"},"synced_password":{"description":"Whether the user has synchronized the passwords for each of the subaccount's service accounts.\n\n* `1` - Synchronized.\n* `0` - **Not** synchronized.\n\n**Note:**\n\nThe function returns a `null` value if the account is **not** a subaccount.","enum":[0,1],"example":0,"nullable":true,"type":"integer"},"type":{"description":"The type of account.\n\n* `sub` - A subaccount.\n* `hypothetical` - A hypothetical subaccount that does **not** exist, but that the user could create as part of a merge.\n* `service` - A service account.\n* `cpanel` - The cPanel account.","enum":["sub","hypothetical","service","cpanel"],"example":"sub","type":"string"},"username":{"description":"The username for the service account that meets the account name limitations.\n\n* Length - 64 characters\n* Characters — `a-z`, `A-Z`, `0-9`, dot (`.`), hyphen (`-`), underscore (`_`).\n\n**Note:**\n\nThis value does **not** include the domain name.","example":"example","format":"username","type":"string"}},"type":"object"},"type":"array"},"parent_type":{"description":"The type of account that could own the service account.\n* `sub` - A subaccount.\n* `hypothetical` - A hypothetical subaccount that does **not** yet exist, but the user could create as part of a merge.\n* `null` - Not a merge candidate.","enum":["sub","hypothetical"],"example":"hypothetical","nullable":true,"type":"string"},"phone_number":{"description":"The subaccount user's phone number.","example":"+15551234567","type":"string"},"real_name":{"description":"The name of the subaccount's user.\n\n* A first name.\n* Last name.\n* First name and last name.\n* An empty string.","example":"John Doe","type":"string"},"services":{"description":"This object contains information about the subaccount's access to email, FTP, and Web Disk.","properties":{"email":{"description":"This object contains the information that indicates the subaccount's email status.","properties":{"enabled":{"description":"Whether the subaccount can access Webmail, POP, and IMAP services.\n\n* `1` - Can access.\n* `0` - **Cannot** access.","enum":[0,1],"example":1,"type":"integer"},"quota":{"description":"The maximum amount of disk space allocated to subaccount's email account. A positive integer that represents the maximum disk space that the subaccount may use, in megabytes (MB).\n\n**Note:**\n\nThis function will **not** return `0` as a value.","example":100,"type":"integer"}},"type":"object"},"ftp":{"description":"This object contains the information that indicates the subaccount's FTP status.","properties":{"enabled":{"description":"Whether the subaccount can access FTP.\n* `1` - Can access.\n* `0` - **Cannot** access.","enum":[0,1],"example":0,"type":"integer"},"homedir":{"description":"The subaccount's FTP home directory.","example":"/subaccount","format":"path","type":"string"},"quota":{"description":"The subaccount's FTP disk space quota.\n* >= `1` - Represents the maximum disk space that the subaccount may use, in megabytes (MB).\n* `0`   - Unlimited.","example":100,"maximum":999999,"minimum":0,"type":"integer"}},"type":"object"},"webdisk":{"description":"This object contains information that indicates the subaccount's Web Disk status.","properties":{"enabled":{"description":"Whether the subaccount can access Web Disk.\n* `1` - Can access.\n* `0` - **Cannot** access.","enum":[0,1],"example":0,"type":"integer"},"homedir":{"description":"The subaccount's Web Disk home directory.","example":"/bob","format":"path","type":"string"},"perms":{"description":"Whether to grant write permissions to the subaccount.\n* `ro` - Read-only permissions.\n* `rw` - Read and write permissions.","example":"rw","type":"string"},"private":{"description":"Whether to set the Web Disk directory's permissions to public or private.\n* `1` - Private (0700).\n* `0` - Public (0755).","enum":[0,1],"example":0,"type":"integer"}},"type":"object"}},"type":"object"},"special":{"description":"Whether the account is a system-created special account that the user **cannot** remove.\n* `1` - A special account.\n* `0` - **Not** a special account.","enum":[0,1],"example":1,"type":"integer"},"sub_account_exists":{"description":"Whether a subaccount exists with the same username.\n\n* `1` - Exists.\n* `0` - Does **not** exist.\n\n**Note:**\n\nThe function returns a `null` value if the account is **not** a service account.","enum":[0,1],"example":0,"nullable":true,"type":"integer"},"synced_password":{"description":"Whether the user has synchronized the passwords for each of the subaccount's service accounts.\n\n* `1` - Synchronized.\n* `0` - **Not** synchronized.\n\n**Note:**\n\nThe function returns a `null` value if the account is **not** a subaccount.","enum":[0,1],"example":0,"nullable":true,"type":"integer"},"type":{"description":"The type of account.\n\n* `sub` - A subaccount.\n* `hypothetical` - A hypothetical subaccount that does **not** exist, but that the user could create as part of a merge.\n* `service` - A service account.\n* `cpanel` - The cPanel account.","example":"sub","type":"string"},"username":{"description":"The username for the subaccount.\n\nThe username for the service account that meets the account name limitations.\n\n* Length - 64 characters\n* Characters — `a-z`, `A-Z`, `0-9`, dot (`.`), hyphen (`-`), underscore (`_`).\n\n**Note:**\n\nThis value does **not** include the domain name.","example":"example","format":"username","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Register service account to Subaccount","tags":["UserManager","Subaccount Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  UserManager \\\n  merge_service_account \\\n  username='example' \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/UserManager/merge_service_account?username=example&domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file UserManager_merge_service_account.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/UserManager_merge_service_account.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/UserManager/,\n    q/merge_service_account/,\n    {\n        'username' => 'example',\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file UserManager_merge_service_account.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/UserManager_merge_service_account.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'UserManager',\n    'merge_service_account',\n    array (\n        'username' => 'example',\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/UserTasks/retrieve":{"get":{"description":"This function retrieves a cPanel account's user task queue information.\n\nEach cPanel account uses a separate user task queue in order to ensure that\nprocesses for one user do not impede another user on the server.\n\n* For example, the [*Git Version Control*](https://go.cpanel.net/GitVersionControl)\ninterface (*cPanel >> Home >> Files >> Git Version Control*) uses the user task queue\nto clone repositories (via the `VersionControl::create` function).\n* For more information, read our\n[Task Queue Monitor](https://go.cpanel.net/whmdocsTaskQueueMonitor) documentation.","operationId":"retrieve","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"retrieve","type":"string"},"module":{"description":"The name of the module called.","example":"UserTasks","type":"string"},"result":{"properties":{"data":{"description":"An array of objects containing data for a task in the user task queue.","example":[{"action":"create","args":{},"id":"00000000\\/5a9ec8dd4c345d","subsystem":"VersionControl"},{"action":"create","args":{"repository_root":"/home/user/public_html/example"},"id":"00000000/h39dnn27suc13l","subsystem":"VersionControl"}],"items":{"properties":{"action":{"description":"The task's action.\n\n* `create`\n\n**Note:**\n\n`create` is the only possible value.","enum":["create"],"example":"create","type":"string"},"args":{"description":"An object containing one or more action- and subsystem-specific\narguments, if any exist.\n\nFor example, a task that returns an `action` value of `create` and\na `subsystem` value of `VersionControl` will include the\n`repository_root` argument.","properties":{"repository_root":{"description":"The absolute path to the repostiory's `root` directory.","type":"string"}},"type":"object"},"id":{"description":"The task's ID number.","example":"00000000\\/5a9ec8dd4c345d","type":"string"},"subsystem":{"description":"The subsystem that will handle the process.\n\n* `VersionControl`\n\n**Note:**\n\n`VersionControl` is the only possible value.","enum":["VersionControl"],"example":"VersionControl","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return task queue information","tags":["UserTasks","SSE Task Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  UserTasks \\\n  retrieve\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/UserTasks/retrieve"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file UserTasks_retrieve.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/UserTasks_retrieve.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/UserTasks/,\n    q/retrieve/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file UserTasks_retrieve.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/UserTasks_retrieve.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'UserTasks',\n    'retrieve'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 72"}},"/Variables/get_server_information":{"get":{"description":"This function retrieves the configuration settings for the cPanel & WHM server on which an account exists. This is useful, for example, to verify which applications and functionality are available on the account.","operationId":"Variables-get_server_information","parameters":[{"description":"The server configuration settings to return.\n\n<details>\n<summary>Click to view information about the available server configuration settings.</summary>\n\n* `default_theme` - The cPanel interface's default theme.\n* `email_filter_storage_directory` - The location of the Exim email filter storage directory.\n* `allow_park_subdomain_on_hostname` - Whether the system allows users to park subdomains of the server's hostname.\n* `allow_remote_domains` - Whether the system allows users to create addon domains or aliases that resolve to other servers.\n* `allow_unregistered_domains` - Whether the system allows users to add domains they didn't register with a domain name registrar.\n* `apache_port` - The IP address or IP address with a firewall port number that Apache® uses to listen for requests and serve web pages over an unsecured connection.\n* `apache_ssl_port` - The port or IP address that Apache uses to listen for requests and serve web pages over a secure connection.\n* `api_shell` - Whether the user can access cPanel's [*API Shell*](https://go.cpanel.net/cpaneldocsAPIShell) interface (*cPanel >> Home >> Advanced >> API Shell*).\n* `awstats_browser_update` - Whether the user can update their [AWStats](http://awstats.sourceforge.net/) software.\n* `awstats_reverse_dns` - Whether the AWStats statistical analysis software interprets visitors' domain names as IP addresses.\n* `cpanel_root_directory` - The cPanel `root` directory.\n* `database_prefix_required` - Whether the account requires database prefixing.\n* `display_cpanel_doclinks` - Whether the system displays links to cPanel feature documentation in the cPanel interface.\n* `dnsadmin_app` - The application that processes DNS management requests.\n* `empty_trash_days` - The minimum age of files that the system will automatically purge from `.trash` folders in user home directories.\n* `enable_file_protect` - Whether [EasyApache 4's *FileProtect* option](https://go.cpanel.net/EasyApache4FileprotectOption) is enabled.\n* `file_upload_maximum_bytes` - The maximum file size, in megabytes (MB), that a user can upload to a server.\n* `file_upload_must_leave_bytes` - The minimum filesystem quota that the system requires after a file uploads to a server.\n* `file_usage` - Whether file usage information displays in the cPanel *Home* interface's statistics bar.\n* `ftp_server` - The FTP server.\n* `htaccess_check_recurse` - The maximum number of directories deep to look for `.htaccess` files when you change the PHP handler.\n* `invite_sub` - Whether cPanel account users can send invitations to new Subaccount users via cPanel's [*User Manager*](https://go.cpanel.net/cpaneldocsUserManager) interface (*cPanel >> Home >> Preferences >> User Manager*).\n* `ipv6_listen` - Whether the `cpsrvd` daemon and other cPanel & WHM services listen on IPv6.\n* `local_nameserver_type` - The DNS nameserver's type.\n* `logout_redirect_url` - The logout redirection URL.\n* `mailbox_storage_format` - The mailbox storage format for new accounts.\n* `mail_server` - The mailserver type.\n* `minimum_password_strength` - The minimum strength for cPanel account passwords. \n* `minimum_password_strength_mysql` - The minimum strength for MySQL® or MariaDB® passwords.\n* `mysql_host` - The MySQL or MariaDB hostname or IP address.\n* `mysql_version` - The MySQL or MariaDB version.\n* `php_maximum_execution_time` - The number of seconds that a PHP script can run before the system terminates it.\n* `php_post_maximum_size` - The maximum size, in megabytes (MB), of a POST request.\n* `php_system_default_version` - The system's default version of PHP.\n* `php_upload_maximum_filesize` - The maximum file size, in megabytes (MB), that a PHP script may upload.\n* `php_loader` - The PHP loaders through which the system executes internal PHP scripts.\n* `php_open_basedir_home` - Whether PHP `open_basedir` protection is enabled on the server.\n* `phpmyadmin_disable_search_info_schema` - Whether the user can search for the phpMyAdmin information schema.\n* `docroots_in_public_html_only` - Whether the system restricts users from creating addon domains and subdomains outside of their `public_html` directory.\n* `require_ssl` - Whether the system requires passwords and other sensitive information use SSL encryption.\n* `allow_reset_password` - Whether cPanel's [*Reset Password*](https://go.cpanel.net/resetsubaccountpass) feature is enabled for the account.\n* `allow_reset_password_for_subaccounts` - Whether cPanel's [*Reset Password*](https://go.cpanel.net/resetsubaccountpass) feature is enabled for subaccounts on the account.\n* `disable_analog` - Whether users can access the [*Analog Stats*](https://go.cpanel.net/cpaneldocsAnalogStats) interface (*cPanel >> Home >> Metrics >> Analog Stats*).\n* `skip_apache_clients_optimizer` - Whether the Apache Client Optimizer is enabled.\n* `disable_awstats` - Whether the [AWStats](http://awstats.sourceforge.net/) software is enabled.\n* `skip_mailbox_warnings_check` - Whether mailbox usage warnings are enabled.\n* `disable_boxtrapper` - Whether [*BoxTrapper*](https://go.cpanel.net/cpaneldocsBoxTrapper) is enabled.\n* `skip_bandwidth_limit_check` - Whether the system automatically suspends HTTP service for accounts that exceed their bandwidth limit.\n* `disable_mailman` - Whether Mailman mailing lists are enabled.\n* `disable_roundcube` - Whether [Roundcube webmail](https://roundcube.net/) is enabled.\n* `disable_spamassassin` - Whether the Apache SpamAssassin™ spam filter is enabled.\n* `disable_spambox` - Whether Apache SpamAssassin's spam box feature is enabled.\n* `disable_webalizer` - Whether the [Webalizer](https://docs.cpanel.net/cpanel/metrics/webalizer/) statistics program is enabled.\n* `ssl_default_key_type` - The default SSL/TLS encryption algorithm used by the system.\n* `use_information_schema` - Whether the system uses the MySQL® `INFORMATION_SCHEMA` view. This view includes disk usage by all MySQL tables in the disk usage totals.\n* `use_mail_for_mailman_url` - Whether the system prefixes Mailman URLs with the `mail` prefix. For example, `http://mail.domain.com/mailman`.\n* `is_mod_userdir_enabled` - Whether the [Apache `mod_userdir` Tweak](https://go.cpanel.net/whmdocsApachemod_userdirTweak) is enabled.\n* `version` - The system's Linux® kernel version.\n</details>\n\n**Note:**\n\n* If you don't use this parameter, this function returns **all** of the server's configuration settings.\n* To retrieve multiple variables, increment this parameter. For example, `name-1=variable`, `name-2=variable`, `name-3=variable`.","examples":{"multiple":{"summary":"Get multiple configuration settings.","value":"name=allow_park_subdomain_on_hostname&name=allow_remote_domains&name=allow_reset_password"},"single":{"summary":"Get a single configuration setting.","value":"allow_park_subdomain_on_hostname"}},"in":"query","name":"name","required":false,"schema":{"enum":["default_theme","email_filter_storage_directory","allow_park_subdomain_on_hostname","allow_remote_domains","allow_unregistered_domains","apache_port","apache_ssl_port","api_shell","awstats_browser_update","awstats_reverse_dns","cpanel_root_directory","database_prefix_required","display_cpanel_doclinks","dnsadmin_app","empty_trash_days","enable_file_protect","file_upload_maximum_bytes","file_upload_must_leave_bytes","file_usage","ftp_server","htaccess_check_recurse","invite_sub","ipv6_listen","local_nameserver_type","logout_redirect_url","mailbox_storage_format","mail_server","minimum_password_strength","minimum_password_strength_mysql","mysql_host","mysql_version","php_maximum_execution_time","php_post_maximum_size","php_system_default_version","php_upload_maximum_filesize","php_loader","php_open_basedir_home","phpmyadmin_disable_search_info_schema","docroots_in_public_html_only","require_ssl","allow_reset_password","allow_reset_password_for_subaccounts","disable_analog","skip_apache_clients_optimizer","disable_awstats","skip_mailbox_warnings_check","disable_boxtrapper","skip_bandwidth_limit_check","disable_mailman","disable_roundcube","disable_spamassassin","disable_spambox","disable_webalizer","ssl_default_key_type","use_information_schema","use_mail_for_mailman_url","is_mod_userdir_enabled","version"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_server_information","type":"string"},"module":{"description":"The name of the module called.","example":"Variables","type":"string"},"result":{"properties":{"data":{"properties":{"allow_park_subdomain_on_hostname":{"description":"Whether the system allows users to park subdomains of the server's hostname.\n\n* `1` - Allows.\n* `0` - Doesn't allow.","enum":[1,0],"example":0,"nullable":true,"type":"integer"},"allow_remote_domains":{"description":"Whether the system allows users to create addon domains or aliases that resolve to other servers.\n\n* `1` - Allows.\n* `0` - Doesn't allow.","enum":[1,0],"example":1,"nullable":true,"type":"integer"},"allow_reset_password":{"description":"Whether cPanel's [*Reset Password*](https://go.cpanel.net/resetsubaccountpass) feature is enabled for the account.\n\n* `1` - *Reset Password* feature enabled.\n* `0` - *Reset Password* feature not enabled.","enum":[1,0],"example":1,"nullable":true,"type":"integer"},"allow_reset_password_for_subaccounts":{"description":"Whether cPanel's [*Reset Password*](https://go.cpanel.net/resetsubaccountpass) feature is enabled for subaccounts on the account.\n\n* `1` - *Reset Password* feature enabled.\n* `0` - *Reset Password* feature not enabled.","enum":[1,0],"example":1,"nullable":true,"type":"integer"},"allow_unregistered_domains":{"description":"Whether the system allows users to add domains they didn't register with a domain name registrar.\n\n* `1` - Allows.\n* `0` - Doesn't allow.","enum":[1,0],"example":1,"nullable":true,"type":"integer"},"apache_port":{"description":"The IP address or IP address with a firewall port number that Apache uses to listen for requests and serve web pages over an unsecured connection.","example":"192.0.2.0:80","nullable":true,"type":"string"},"apache_ssl_port":{"description":"The IP address or IP address with a firewall port number that Apache uses to listen for requests and serve web pages over a secure connection.","example":"192.0.2.0:443","nullable":true,"type":"string"},"api_shell":{"description":"Whether the user can access cPanel's [*API Shell*](https://go.cpanel.net/cpaneldocsAPIShell) interface (*cPanel >> Home >> Advanced >> API Shell*).\n\n* `1` - Can access.\n* `0` - Can't access.","enum":[1,0],"example":0,"nullable":true,"type":"integer"},"awstats_browser_update":{"description":"Whether the user can update their [AWStats](http://awstats.sourceforge.net/) software.\n\n* `1` - Can update.\n* `0` - Can't update.","enum":[1,0],"example":0,"nullable":true,"type":"integer"},"awstats_reverse_dns":{"description":"Whether the AWStats statistical analysis software interprets visitors' domain names as IP addresses.\n\n* `1` - Interprets visitors' domain names as IP addresses.\n* `0` - Doesn't interpret visitors' domain names as IP addresses.","enum":[1,0],"example":0,"nullable":true,"type":"integer"},"cpanel_root_directory":{"description":"The cPanel `root` directory.","example":"/usr/local/cpanel","format":"path","nullable":true,"type":"string"},"database_prefix_required":{"description":"Whether the account requires database prefixing.\n\n* `1` - Requires database prefixing.\n* `0` - Doesn't require database prefixing.","enum":[1,0],"example":1,"nullable":true,"type":"integer"},"default_theme":{"description":"The cPanel interface's default theme.","example":"jupiter","nullable":true,"type":"string"},"disable_analog":{"description":"Whether users can access the [*Analog Stats*](https://go.cpanel.net/cpaneldocsAnalogStats) interface (*cPanel >> Home >> Metrics >> Analog Stats*).\n\n* `1` - Enabled.\n* `0` - Not enabled.","enum":[1,0],"example":0,"nullable":true,"type":"integer"},"disable_awstats":{"description":"Whether the [AWStats](http://awstats.sourceforge.net/) software is enabled.\n\n* `1` - Enabled.\n* `0` - Not enabled.","enum":[1,0],"example":0,"nullable":true,"type":"integer"},"disable_boxtrapper":{"description":"Whether [*BoxTrapper*](https://go.cpanel.net/cpaneldocsBoxTrapper) is enabled.\n\n* `1` - Enabled.\n* `0` - Not enabled.","enum":[1,0],"example":0,"nullable":true,"type":"integer"},"disable_mailman":{"description":"Whether Mailman mailing lists are enabled.\n\n* `1` - Enabled.\n* `0` - Not enabled.","enum":[1,0],"example":0,"nullable":true,"type":"integer"},"disable_roundcube":{"description":"Whether [Roundcube webmail](https://roundcube.net/) is enabled.\n\n* `1` - Enabled.\n* `0` - Not enabled.","enum":[1,0],"example":0,"nullable":true,"type":"integer"},"disable_spamassassin":{"description":"Whether the Apache SpamAssassin spam filter is enabled.\n\n* `1` - Enabled.\n* `0` - Not enabled.","enum":[1,0],"example":0,"nullable":true,"type":"integer"},"disable_spambox":{"description":"Whether Apache SpamAssassin's spam box feature is enabled.\n\n* `1` - Enabled.\n* `0` - Not enabled.","enum":[1,0],"example":0,"nullable":true,"type":"integer"},"disable_webalizer":{"description":"Whether the [Webalizer](http://www.webalizer.org/) statistics program is enabled.\n\n* `1` - Enabled.\n* `0` - Not enabled.","enum":[1,0],"example":0,"nullable":true,"type":"integer"},"display_cpanel_doclinks":{"description":"Whether the system displays links to cPanel feature documentation in the cPanel interface.\n\n* `1` - Displays documentation links.\n* `0` - Doesn't display documentation links.","enum":[1,0],"example":0,"nullable":true,"type":"integer"},"dnsadmin_app":{"description":"The application that processes DNS management requests.\n\n* The value is an application's file path, relative to the user's home directory.\n* `dnsadmin`\n* `auto-detect SSL`","example":"dnsadmin","nullable":true,"type":"string","oneOf":[{"description":"The application's file path, relative to the user's home directory.","type":"string"},{"enum":["dnsadmin","auto-detect SSL"],"type":"string"}]},"docroots_in_public_html_only":{"description":"Whether the system restricts users from creating addon domains and subdomains outside of their `public_html` directory.\n\n* `1` - Restricts users from creating addon domains and subdomains outside of their `public_html` directory.\n* `0` - Allows users to creating addon domains and subdomains outside of their `public_html` directory.","enum":[1,0],"example":1,"nullable":true,"type":"integer"},"email_filter_storage_directory":{"description":"The location of the Exim email filter storage directory.","example":"/etc/vfilters","format":"path","nullable":true,"type":"string"},"empty_trash_days":{"description":"The minimum age of files that the system will automatically purge from `.trash` folders in user home directories.","example":"disabled","nullable":true,"type":"string"},"enable_file_protect":{"description":"Whether [EasyApache 4's *FileProtect* option](https://go.cpanel.net/EasyApache4FileprotectOption) is enabled.\n\n* `1` - Enabled.\n* `0` - Not enabled.","enum":[1,0],"example":1,"nullable":true,"type":"integer"},"file_upload_maximum_bytes":{"description":"The maximum file size, in megabytes (MB), that a user can upload to a server.","example":null,"maximum":10240,"minimum":1,"nullable":true,"type":"integer"},"file_upload_must_leave_bytes":{"description":"The minimum filesystem quota that the system requires after a file uploads to a server.","example":5,"minimum":1,"nullable":true,"type":"integer"},"file_usage":{"description":"Whether file usage information displays in the cPanel *Home* interface's statistics bar.\n\n* `1` - Displays file usage information.\n* `0` - Doesn't display file usage information.","enum":[1,0],"example":0,"nullable":true,"type":"integer"},"ftp_server":{"description":"The FTP server.\n\n* `pure-ftpd` - The Pure-FTPD server.\n* `proftpd` - The ProFTPD FTP server.\n* `disabled` - FTP has been disabled on this server.","enum":["pure-ftpd","proftpd","disabled"],"example":"disabled","nullable":true,"type":"string"},"htaccess_check_recurse":{"description":"The maximum number of directories deep to look for `.htaccess` files when you change the PHP handler.","example":2,"minimum":0,"nullable":true,"type":"integer"},"invite_sub":{"description":"Whether cPanel account users can send invitations to new Subaccount users via cPanel's [*User Manager*](https://go.cpanel.net/cpaneldocsUserManager) interface (*cPanel >> Home >> Preferences >> User Manager*).\n\n* `1` - Can send invitations.\n* `0` - Can't send invitations.","enum":[1,0],"example":1,"nullable":true,"type":"integer"},"ipv6_listen":{"description":"Whether the `cpsrvd` daemon and other cPanel & WHM services listen on IPv6.\n\n* `1` - Listen on IPv6.\n* `0` - Don't listen on IPv6.","enum":[1,0],"example":0,"nullable":true,"type":"integer"},"is_mod_userdir_enabled":{"description":"Whether the [Apache `mod_userdir` Tweak](https://go.cpanel.net/whmdocsApachemod_userdirTweak) is enabled.\n\n* `1` - Enabled.\n* `0` - Not enabled.","enum":[1,0],"example":1,"nullable":true,"type":"integer"},"local_nameserver_type":{"description":"The DNS nameserver's type.\n\n* `powerdns` - The PowerDNS nameserver.\n* `bind` - The bind nameserver.\n* `disabled` - Nameserver's have been disabled on this server.","enum":["powerdns","bind","disabled"],"example":"powerdns","nullable":true,"type":"string"},"logout_redirect_url":{"description":"The logout redirection URL.","example":"https://cpanel.net","format":"url","nullable":true,"type":"string"},"mail_server":{"description":"The mailserver type.\n\n* `dovecot` - The Dovecot mailserver.\n* `disabled` - The mailserver is disabled on this system.","enum":["dovecot","disabled"],"example":"dovecot","nullable":true,"type":"string"},"mailbox_storage_format":{"description":"The mailbox storage format for new accounts.\n\n* `mdbox` - The mdbox storage format.\n* `maildir` - The maildir storage format.","enum":["mdbox","maildir"],"example":"maildir","nullable":true,"type":"string"},"minimum_password_strength":{"description":"The minimum strength for cPanel account passwords.","example":65,"maximum":100,"minimum":0,"nullable":true,"type":"integer"},"minimum_password_strength_mysql":{"description":"The minimum strength for MySQL or MariaDB passwords.","example":65,"maximum":100,"minimum":0,"nullable":true,"type":"integer"},"mysql_host":{"description":"The MySQL or MariaDB hostname or IP address.","example":"localhost","type":"string","nullable":true,"oneOf":[{"format":"domain","type":"string"},{"format":"ipv4","type":"string"}]},"mysql_version":{"description":"The MySQL or MariaDB version.","example":"5.7","nullable":true,"type":"string"},"php_loader":{"description":"The PHP loaders through which the system executes internal PHP scripts.\n\n* `ioncube` - The ionCube PHP loader.\n* `sourceguardian` - The SourceGuardian PHP loader.\n* `ioncube,sourceguardian` - Both the ionCube and SourceGuardian PHP loaders are in use.\n* An emtpy string - PHP loader is not in use.","enum":["","ioncube","sourceguardian","ioncube,sourceguardian"],"example":"ioncube","nullable":true,"type":"string"},"php_maximum_execution_time":{"description":"The number of seconds that a PHP script can run before the system terminates it.","example":90,"minimum":90,"nullable":true,"type":"integer"},"php_open_basedir_home":{"description":"Whether PHP `open_basedir` protection is enabled on the server.\n\n* `1` - Enabled.\n* `0` - Not enabled.\n\n**Important:**\n\nWe removed WHM's *PHP open_basedir Tweak* interface (*WHM >> Home >> Security Center >> PHP open_basedir Tweak*)","enum":[1,0],"example":0,"nullable":true,"type":"integer"},"php_post_maximum_size":{"description":"The maximum size, in megabytes (MB), of a POST request.","example":55,"maximum":2047,"minimum":55,"nullable":true,"type":"integer"},"php_system_default_version":{"description":"The system's default version of PHP.","example":"ea-php73","nullable":true,"type":"string"},"php_upload_maximum_filesize":{"description":"The maximum file size, in megabytes (MB), that a PHP script may upload.","example":50,"maximum":2047,"minimum":50,"nullable":true,"type":"integer"},"phpmyadmin_disable_search_info_schema":{"description":"Whether the user can search for the phpMyAdmin information schema.\n\n* `1` - Searches are enabled.\n* `0` - Searches are **not** enabled.","enum":[1,0],"example":0,"nullable":true,"type":"integer"},"require_ssl":{"description":"Whether the system requires passwords and other sensitive information use SSL encryption.\n\n* `1` - Requires SSL.\n* `0` - Doesn't require SSL.","enum":[1,0],"example":1,"nullable":true,"type":"integer"},"skip_apache_clients_optimizer":{"description":"Whether the Apache Client Optimizer is enabled.\n\n* `1` - Enabled.\n* `0` - Not enabled.","enum":[1,0],"example":0,"nullable":true,"type":"integer"},"skip_bandwidth_limit_check":{"description":"Whether the system automatically suspends HTTP service for accounts that exceed their bandwidth limit.\n\n* `1` - Suspends HTTP service.\n* `0` - Doesn't suspend HTTP service.","enum":[1,0],"example":0,"nullable":true,"type":"integer"},"skip_mailbox_warnings_check":{"description":"Whether mailbox usage warnings are enabled.\n\n* `1` - Enabled.\n* `0` - Not enabled.","enum":[1,0],"example":1,"nullable":true,"type":"integer"},"ssl_default_key_type":{"description":"The default SSL/TLS encryption algorithm used by the system.\n\n* `rsa-2048` - The rsa-2048 encryption algorithm.\n* `ecdsa-secp384r1` - The ecdsa-secp384r1 encryption algorithm.\n* `ecdsa-prime256v1` - The ecdsa-prime256v1 encryption algorithm.\n* `rsa-4096` - The rsa-4096 encryption algorithm.","enum":["rsa-2048","ecdsa-secp384r1","ecdsa-prime256v1","rsa-4096"],"example":"rsa-2048","nullable":true,"type":"string"},"use_information_schema":{"description":"Whether the system uses the MySQL `INFORMATION_SCHEMA` view. This view includes disk usage by all MySQL tables in the disk usage totals.\n\n* `1` - Uses MySQL's `INFORMATION_SCHEMA` view.\n* `0` - Doesn't use MySQL's `INFORMATION_SCHEMA` view.","enum":[1,0],"example":1,"nullable":true,"type":"integer"},"use_mail_for_mailman_url":{"description":"Whether the system prefixes Mailman URLs with mail. For example, `http://mail.domain.com/mailman`.\n\n* `1` - Prefixes Mailman URLs with the `mail.` prefix.\n* `0` - Doesn't prefix Mailman URLs with the `mail.` prefix.","enum":[1,0],"example":0,"nullable":true,"type":"integer"},"version":{"description":"The system's Linux Kernel version.","example":"3.4","nullable":true,"type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return server's configuration settings","tags":["cPanel Server Information","Variables"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Variables \\\n  get_server_information\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Variables/get_server_information"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Variables_get_server_information.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Variables_get_server_information.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Variables/,\n    q/get_server_information/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Variables_get_server_information.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Variables_get_server_information.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Variables',\n    'get_server_information'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 86"}},"/UserManager/list_users":{"get":{"description":"This function lists the cPanel account's Subaccounts.","operationId":"UserManager-list_users","parameters":[{"description":"Whether to return Subaccounts with the same name under the merge_candidates array.\n* `1` - Do **not** return.\n* `0` - Return.","in":"query","name":"flat","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_users","type":"string"},"module":{"description":"The name of the module called.","example":"UserManager","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"alternate_email":{"description":"An alternate email address for the subaccount's user.","example":"user@example.com","format":"email","type":"string"},"avatar_url":{"description":"The user's subaccount profile photo.","example":"https://img.example.com/avatars/example.jpg","format":"url","type":"string"},"can_delete":{"description":"Whether the cPanel account user can delete the subaccount.\n* `1` - Can delete.\n* `0` - **Cannot** delete.","enum":[0,1],"example":0,"type":"integer"},"can_set_password":{"description":"Whether the cPanel account user can change the subaccount's password.\n* `1` - Can change.\n* `0` - **Cannot** change.\n\n**Note:**\n\n  The function returns a `0` value for subaccounts that inherit their password from the cPanel account.","enum":[0,1],"example":1,"type":"integer"},"can_set_quota":{"description":"Whether the cPanel account user can change the subaccount's disk usage quota.\n* `1` - Can change.\n* `0` - **Cannot** change.","enum":[0,1],"example":0,"type":"integer"},"dismissed":{"description":"Whether the cPanel account user dismissed the merge prompt for the service account.\n* `1` - Dismissed.\n* `0` - Did **not** dismiss.\n\n**Note:**\n\n **Only** service accounts return this value.","enum":[0,1],"example":1,"type":"integer"},"dismissed_merge_candidates":{"description":"An array of objects containing information about service candidates that the system dismissed from merges.","example":[],"items":{"type":"string"},"type":"array"},"domain":{"description":"The subaccount user's associated domain.","example":"example.com","format":"domain","type":"string"},"full_username":{"description":"The subaccount's username and domain name.","example":"user@example.com","type":"string"},"guid":{"description":"The subaccount unique identifier.","example":"N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4","type":"string"},"has_expired_invite":{"description":"Whether an expired account login invitation exists.\n* `1` - Expired account invitation exists.\n* `0` - Expired account invitation does **not** exist.","enum":[0,1],"example":0,"type":"integer"},"has_invite":{"description":"Whether an account login invitation exists.\n* `1` - Account invitation exists.\n* `0` - Account invitation does **not** exist.","enum":[0,1],"example":0,"type":"integer"},"has_siblings":{"description":"Whether the service account shares a full_username value with another service account.\n* `1` - Shares.\n* `0` - Does **not** share.","enum":[0,1],"example":0,"type":"integer"},"invite_expiration":{"description":"When the invitation expires.","example":1591718154,"format":"unix_timestamp","type":"integer"},"issues":{"description":"Information about any issues or problems with the subaccount.","items":{"properties":{"area":{"description":"The affected section of cPanel & WHM.","example":"quota","type":"string"},"limit":{"description":"The set quota megabyte (MB) limit for the affected subaccount.","example":1500,"format":"megabytes","minimum":1,"type":"integer"},"message":{"description":"The description of the issue.","example":"Your account is over quota.","type":"string"},"service":{"description":"The affected service.","enum":["email","ftp","webdisk"],"example":"email","type":"string"},"type":{"description":"The type of issue.","enum":["error","warning","info"],"example":"info","type":"string"},"used":{"description":"The number of megabytes (MB) that the account currently uses.","example":2000,"format":"megabytes","type":"integer"}},"type":"object"},"type":"array"},"merge_candidates":{"description":"An array of objects that represents the service accounts that the system could merge for this subaccount.","example":[],"items":{"type":"string"},"type":"array"},"parent_type":{"description":"The type of account that could own the service account.\n* `sub` - A subaccount.\n* `hypothetical` - A hypothetical subaccount that does **not** yet exist, but the user could create as part of a merge.\n* `null` - **Not** a merge candidate.","enum":["sub","hypothetical"],"example":"hypothetical","nullable":true,"type":"string"},"phone_number":{"description":"The subaccount user's phone number. A valid phone number that conforms to [ITU-T](https://en.wikipedia.org/wiki/ITU-T)'s [E.164](https://en.wikipedia.org/wiki/E.164) -recommended standard for the representation of telephone numbers.","example":"+15551234567","type":"string"},"real_name":{"description":"The name of the subaccount's user.","example":"John Doe","type":"string"},"services":{"description":"An object containing information about the subaccount's access to email, FTP, and Web Disk.","properties":{"email":{"description":"An object containing the information that indicates the subaccount's email status.","properties":{"enabled":{"description":"Whether the subaccount can access Webmail, POP, and IMAP services.\n* `1` - Can access.\n* `0` - **Cannot** access.","enum":[0,1],"example":1,"type":"integer"},"quota":{"description":"The maximum amount of disk space allocated to subaccount's email account.","example":100,"format":"megabytes","minimum":1,"type":"integer"}},"type":"object"},"ftp":{"description":"An object containing the information that indicates the subaccount's FTP status.","properties":{"enabled":{"description":"Whether the subaccount can access FTP.\n* `1` - Can access.\n* `0` - **Cannot** access.","enum":[0,1],"example":0,"type":"integer"},"homedir":{"description":"The subaccount's FTP home directory relative to the cPanel account's home.","example":"/subaccount","format":"path","type":"string"},"quota":{"description":"The subaccount's FTP disk space quota.\n* `0` - Unlimited.","example":100,"format":"megabytes","maximum":999999,"minimum":0,"type":"integer"}},"type":"object"},"special":{"description":"Whether the account is a system-created special account that the user cannot remove.\n* `1` - A special account.\n* `0` - **Not** a special account.","enum":[0,1],"example":1,"type":"integer"},"webdisk":{"description":"An object containing information that indicates the subaccount's Web Disk status.","properties":{"enabled":{"description":"Whether the subaccount can access Web Disk.\n* `1` - Can access.\n* `0` - **Cannot** access.","enum":[0,1],"example":0,"type":"integer"},"homedir":{"description":"The subaccount's Web Disk home directory relative to the cPanel account's home directory.","example":"/bob","format":"path","type":"string"},"perms":{"description":"Whether to grant write permissions to the subaccount.\n* `ro` - Read-only permissions.\n* `rw` - Read and write permissions.","enum":["ro","rw"],"example":"rw","type":"string"},"private":{"description":"Whether to set the Web Disk directory's permissions to public or private.\n* `1` - Private (0700).\n* `0` - Public (0755).","enum":[0,1],"example":0,"type":"integer"}},"type":"object"}},"type":"object"},"special":{"description":"Whether the account is a system-created special account that the user **cannot** remove.\n* `1` — A special account.\n* `0` — **Not** a special account.","enum":[0,1],"example":0,"type":"integer"},"sub_account_exists":{"description":"Whether a subaccount exists with the same username.\n* `1` - Exists.\n* `0` - Does **not** exist.\n\n**Note:**\n\nThe function returns a `null` value if the account is **not** a service account.","enum":[0,1],"example":0,"nullable":true,"type":"integer"},"synced_password":{"description":"Whether the user has synchronized the passwords for each of the subaccount's service accounts.\n* `1` - Synchronized.\n* `0` - Not synchronized.\n\n**Note:**\n\nThe function returns a `null` value if the account is **not** a subaccount.","enum":[0,1],"example":0,"nullable":true,"type":"integer"},"type":{"description":"The type of account.\n* `sub` - A subaccount.\n* `hypothetical` - A hypothetical subaccount that does not exist, but that the user could create as part of a merge.\n* `service` - A service account.\n* `cpanel` - The cPanel account.","enum":["sub","hypothetical","service","cpanel"],"example":"sub","type":"string"},"username":{"description":"The username for the subaccount. A username that meets the subaccount name limitations.\n- Length  64 characters.\n- Characters  a-z, A-Z, 0-9, dot (.), hyphen (-), underscore (_).\n\n**Note:**\n\nThis value does **not** include the domain name.","example":"example","maxLength":64,"minLength":1,"pattern":"^[\\w\\.]{1,64}$","type":"string"}},"type":"object"},"properties":{},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel account's Subaccounts","tags":["UserManager","Subaccount Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  UserManager \\\n  list_users\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/UserManager/list_users"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file UserManager_list_users.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/UserManager_list_users.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/UserManager/,\n    q/list_users/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file UserManager_list_users.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/UserManager_list_users.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'UserManager',\n    'list_users'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/Variables/get_session_information":{"get":{"description":"This function retrieves a web server's hostname.","operationId":"get_session_information","parameters":[{"description":"The web server environment variable to retrieve. You can **only**\nretrieve the web server's hostname.\n\n* `host` is the only possible value.","in":"query","name":"name","required":false,"schema":{"default":"host","enum":["host"],"example":"host","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_session_information","type":"string"},"module":{"description":"The name of the module called.","example":"Variables","type":"string"},"result":{"properties":{"data":{"properties":{"host":{"description":"The web server's hostname.","example":"example.com","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return web server's hostname","tags":["Variables","Login Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Variables \\\n  get_session_information\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Variables/get_session_information"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Variables_get_session_information.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Variables_get_session_information.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Variables/,\n    q/get_session_information/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Variables_get_session_information.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Variables_get_session_information.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Variables',\n    'get_session_information'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 86"}},"/VersionControl/create":{"get":{"description":"This function creates a new Git™ repository on a cPanel account.\n\n* For more information about support for version control in cPanel & WHM, read our\n[Git Version Control](https://go.cpanel.net/GitVersionControl) and\n[Guide to Git](https://go.cpanel.net/GitDeployment) documentation.\n* For a list of configuration changes, repository restrictions, and troubleshooting steps,\nread our [Guide to Git - For System Administrators](https://go.cpanel.net/GuidetoGitForSystemAdministrators) documentation.\n\n**Important:**\n\nThe system logs errors for this function in the `~/.cpanel/logs/vc_TIMESTAMP_git_create.log`\nfile, where `TIMESTAMP` represents the time of the error in Unix epoch time.","operationId":"VersionControl::create","parameters":[{"description":"The repository type.\n\n* `git` — A [Git](https://git-scm.com/) repository.\n\n**Note:**\n\n`git` is the only possible value.","in":"query","name":"type","required":true,"schema":{"enum":["git"],"example":"git","type":"string"}},{"description":"The new repository's display name.","in":"query","name":"name","required":true,"schema":{"example":"example","type":"string"}},{"description":"The absolute path to the directory in which to store the repository, relative to the\nuser's `home` directory.\n\n**Note:**\n\n* If the directory does **not** exist, the system will create it.\n* If the specified directory already contains a repository, the system will\nautomatically add it to the list of cPanel-managed repositories.\n* This feature enforces several restrictions on repository paths. For more information,\nread our [Guide to Git - For System Administrators](https://go.cpanel.net/GuidetoGitForSystemAdministrators) documentation.","in":"query","name":"repository_root","required":true,"schema":{"example":"/home/user/public_html/example","format":"path","type":"string"}},{"content":{"application/json":{"schema":{"example":{"remote_name":"origin","url":"ssh://clone.domain.com/cloneme"},"properties":{"remote_name":{"default":"origin","description":"The source repository's name.","type":"string"},"url":{"description":"The source repository's clone URL.","type":"string"}},"required":["url"]}}},"description":"A JSON-formatted object containing information about the source repository that the\nsystem will clone.\n\n**Note:**\n\nIf you do **not** include source repository data, the function creates an empty repository.","in":"query","name":"source_repository","required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"create","type":"string"},"module":{"description":"The name of the module called.","example":"VersionControl","type":"string"},"result":{"properties":{"data":{"properties":{"available_branches":{"description":"An list of available branches for the cloned or existing repository, if any exist.","example":["master","olive"],"items":{"type":"string"},"type":"array"},"branch":{"description":"The repository's current branch.\n\n* `null` — The system has **not** finished the clone process for\nthe repository, or no local branches exist.","example":"master","nullable":true,"type":"string"},"clone_urls":{"description":"An object containing URLs to use to clone the repository.","properties":{"read_only":{"description":"A list of clone URLs with read-only permissions. The function\nreturns a blank array if the account does **not** include the\n*Shell Access* setting.\n\n**Important:**\n\nIf the server uses a [nonstandard SSH port](https://go.cpanel.net/firewall),\nthe system returns a clone URL that includes the port number.","items":{"example":"https://user@example.com/home/user/example","format":"url","type":"string"},"type":"array"},"read_write":{"description":"A list of of clone URLs with read-write permissions. The function\nreturns a blank array if the account does **not** include the\n*Shell Access* setting.\n\n**Important:**\n\nIf the server uses a [nonstandard SSH port](https://go.cpanel.net/firewall),\nthe system returns a clone URL that includes the port number.","items":{"example":"ssh://user@example.com/home/user/example","type":"string"},"type":"array"}},"type":"object"},"last_update":{"description":"Information about the most-recent (HEAD) commit for the current branch.\n\n**Note:**\n\n* The system may require a large amount of time to clone large\nrepositories. Until this process finishes, HEAD information is unavailable.\n* `null` is the only possible value.","enum":[null]},"name":{"description":"The repository's display name.","example":"example","type":"string"},"repository_root":{"description":"The absolute path of the directory that contains the repository in the user's `home` directory.","example":"/home/user/public_html/example","format":"path","type":"string"},"source_repository":{"description":"A object containing information about a cloned repository's source\nrepository.\n\n**Note:**\n\nThe function **only** returns this object if it will clone a\nrepository.","properties":{"remote_name":{"description":"The source repository's name.","example":"remote","type":"string"},"url":{"description":"The source repository's clone URL.","example":"http://user@domain.com/home/user/domain","format":"url","type":"string"}},"type":"object"},"tasks":{"description":"An array of objects containing information about the\n[Task Queue](https://go.cpanel.net/whmdocsTaskQueueMonitor)\nsystem's process that will clone the repository.\n\n**Note:**\n\nThe function **only** returns this value if it will clone a\nrepository.","items":{"properties":{"action":{"description":"The task's action.\n\n* `create`\n\n**Note:**\n\n`create` is the only possible value.","enum":["create"],"example":"create","type":"string"},"args":{"description":"A list of arguments for the\n[Task Queue](https://go.cpanel.net/whmdocsTaskQueueMonitor)\nsystem's process.","properties":{"log_file":{"description":"The absolute path to the process's log file.\n\n**Note:**\n\nThe function **only** returns this value if the process\ngenerated a log file.","example":"/home/username/.cpanel/logs/vc_1234567890.123456_git_deploy.log","type":"string"},"repository_root":{"description":"The absolute path to the repository's directory within the user's `home` directory.","example":"/home/user/example","format":"path","type":"string"}},"type":"object"},"id":{"description":"The [Task Queue](https://go.cpanel.net/whmdocsTaskQueueMonitor)\nsystem's task ID number.","example":"00000000/5a9ec8dd4c345d","type":"string"},"sse_url":{"description":"The SSE interface to track the progress of the process.","example":"/sse/UserTasks/B3A27B96-51F7-11E8-92E3-CC90C4F823F0","type":"string"},"subsystem":{"description":"The [Task Queue](https://go.cpanel.net/whmdocsTaskQueueMonitor)\nsubsystem that will handle the task.\n\n* `VersionControl`\n\n**Note:**\n\n`VersionControl` is the only possible value.","enum":["VersionControl"],"example":"VersionControl","type":"string"}},"type":"object"},"type":"array"},"type":{"description":"The repository type.\n\n* `git` — A Git repostiory.\n\n**Note:**\n\n`git` is the only possible value.","example":"git","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create Git repository","tags":["VersionControl","Repository Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  VersionControl \\\n  create \\\n  type='git' \\\n  name='example' \\\n  repository_root='/home/user/public_html/example'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/VersionControl/create?type=git&name=example&repository_root=%2fhome%2fuser%2fpublic_html%2fexample"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file VersionControl_create.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/VersionControl_create.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/VersionControl/,\n    q/create/,\n    {\n        'type' => 'git',\n        'name' => 'example',\n        'repository_root' => '/home/user/public_html/example',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file VersionControl_create.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/VersionControl_create.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'VersionControl',\n    'create',\n    array (\n        'type' => 'git',\n        'name' => 'example',\n        'repository_root' => '/home/user/public_html/example',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 72"}},"/Variables/get_user_information":{"get":{"description":"This function retrieves the user's account configuration settings.","operationId":"Variables-get_user_information","parameters":[{"description":"The user configuration variables to retrieve. If you don't use this parameter, this function returns **all** of the user's configuration data.\n\n**Note:**\n\nTo retrieve multiple account configuration settings for a user, increment the parameter name. For example: `name-0`, `name-1`, and `name-2`.","examples":{"multiple":{"summary":"Get multiple account configuration settings.","value":"name-1=mailbox_format&name-2=home&name-3=shell"},"single":{"summary":"Get a single account configuration setting.","value":"mailbox_format"}},"in":"query","name":"name","required":false,"schema":{"example":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_user_information","type":"string"},"module":{"description":"The name of the module called.","example":"Variables","type":"string"},"result":{"properties":{"data":{"properties":{"backup_enabled":{"description":"Whether the user has backups enabled.\n* `1` - Backups enabled.\n* `0` - Backups not enabled.","enum":[0,1],"example":1,"type":"integer"},"bandwidth_limit":{"description":"The account's bandwidth limit.\n* `0` - unlimited\n* A maximum amount of bandwidth, in bytes.","example":0,"minimum":0,"type":"integer"},"cgi_enabled":{"description":"Whether CGI is enabled.\n* `1` - Enabled.\n* `0` - Not enabled.","enum":[0,1],"example":1,"type":"integer"},"contact_email":{"description":"The account's contact email address.","example":"user@example.com","format":"email","type":"string"},"contact_email_2":{"description":"The account's alternate contact email address, if one exists.","example":"user2@example.com","format":"email","type":"string"},"cpanel_root_directory":{"description":"The `root` directory.","example":"/usr/local/cpanel","format":"path","type":"string"},"created":{"description":"The account's creation date in [Unix time](http://en.wikipedia.org/wiki/Unix_time) format.","example":1432220941,"format":"unix_timestamp","type":"integer"},"created_in_version":{"description":"The version of cPanel used during account creation.","example":"11.94.0.0","format":"cPanel version","type":"string"},"database_owner":{"description":"The owner of the account's databases.\n* `root`\n* A reseller account's username.\n* The account's username.","example":"root","format":"username","type":"string"},"dead_domains":{"description":"The account's inactive domains.","items":{"example":"example.example.com","format":"domain","type":"string"},"type":"array"},"demo_mode":{"description":"Whether demo mode is enabled.\n* `1` - Enabled.\n* `0` - Not enabled.","enum":[0,1],"example":1,"type":"integer"},"disk_block_limit":{"description":"The number of disk blocks for the account.\n* `0` - unlimited\n* A maximum amount of disk blocks, in kilobytes.","example":100000000,"minimum":0,"type":"integer"},"dkim_enabled":{"description":"Whether DomainKeys Identified Mail (DKIM) is enabled.\n* `1` - Enabled.\n* `0` - Not enabled.","enum":[0,1],"example":1,"type":"integer"},"domain":{"description":"The account's main domain.","example":"example.com","format":"domain","type":"string"},"domains":{"description":"list of the account's domains and subdomains.","items":{"example":"example.com","format":"domain","type":"string"},"type":"array"},"feature":{"description":"The available features on the account that exist in the `/var/cpanel/users/user` file`, where user represents the cPanel user.\n\n**Note:**\n\nThis object returns any custom features that the hosting provider adds to the `/var/cpanel/users/user` file.","example":{"custom_feature":1},"properties":{"additionalProperties":{"description":"Whether the feature is enabled.\n* `1` - Enabled.\n* `0` - Disabled.\n\n**Note:**\n\nThe feature's name is the return name.","enum":[0,1],"example":1,"type":"integer","x-additionalPropertiesName":"feature"}},"type":"object"},"feature_list":{"description":"The account's [feature list](https://go.cpanel.net/whmdocs84FeatureManager) name.","example":"feature_list","type":"string"},"gid":{"description":"The account's group ID.","example":5678,"type":"integer"},"home":{"description":"The user's home directory.","example":"/home/user","format":"path","type":"string"},"home_directory_links":{"description":"Any symlinks to the cPanel account's home directory. An array of one or more home directory symlinks.","items":{"example":"symlink"},"type":"array"},"ip":{"description":"The account's IPv4 address.","example":"192.0.2.0","format":"ipv4","type":"string"},"lang":{"description":"The account's language.","example":"english","type":"string"},"last_modified":{"description":"The most recent modification time of the `/var/cpanel/users/user` file in [Unix time format](https://en.wikipedia.org/wiki/Unix_time).\n\n**Note:**\n\n`user` represents the cPanel user.","example":1416586493,"format":"unix_timestamp","type":"integer"},"legacy_backup_enabled":{"description":"Whether legacy backups are enabled.\n* `1` - Enabled.\n* `0` - Disabled.","enum":[0,1],"example":1,"type":"integer"},"locale":{"description":"The account's default locale, a two-letter [ISO-3166 code](http://www.iso.org/iso/country_codes.htm).","example":"en","format":"ISO-3166-1 (alpha-2)","type":"string"},"mailbox_format":{"description":"The storage format that the account's mailboxes use.\n* `maildir`\n* `mbox`","enum":["maildir","mbox"],"example":"maildir","type":"string"},"maximum_addon_domains":{"description":"The account's maximum number of addon domains.\n* `unlimited`\n* An integer that represents a number of addon domains.","example":"unlimited","oneOf":[{"enum":["unlimited"],"type":"string"},{"minimum":0,"type":"integer"}]},"maximum_databases":{"description":"The account's maximum number of SQL databases.\n* `unlimited`\n* An integer that represents a number of SQL databases.","example":"unlimited","oneOf":[{"enum":["unlimited"],"type":"string"},{"minimum":0,"type":"integer"}]},"maximum_defer_fail_percentage":{"description":"The [percentage of failed or deferred email messages](https://go.cpanel.net/howtopreventspam) that the account can send per hour before outgoing mail is rate-limited.\n* `unlimited`\n* An integer value.","example":"unlimited","oneOf":[{"enum":["unlimited"],"type":"string"},{"minimum":0,"type":"integer"}]},"maximum_email_account_disk_quota":{"description":"The maximum size, that the account can define when it creates an email account.\n* `unlimited`\n* An integer value, in Megabytes (MB).","example":"unlimited","oneOf":[{"enum":["unlimited"],"type":"string"},{"minimum":0,"type":"integer"}]},"maximum_emails_per_hour":{"description":"The maximum number of emails that the account can send in one hour.\n* A positive integer.\n* `0` or `unlimited` - The account can send an unlimited number of emails.","example":"unlimited","oneOf":[{"enum":["unlimited"],"type":"string"},{"minimum":0,"type":"integer"}]},"maximum_ftp_accounts":{"description":"The account's maximum number of FTP accounts.\n* `unlimited`\n* An integer that represents a number of FTP accounts.","example":"unlimited","oneOf":[{"enum":["unlimited"],"type":"string"},{"minimum":0,"type":"integer"}]},"maximum_mail_accounts":{"description":"The maximum number of email accounts for the account.\n* `unlimited`\n* An integer that represents a number of email accounts.","example":"0","oneOf":[{"enum":["unlimited"],"type":"string"},{"minimum":0,"type":"integer"}]},"maximum_mailing_lists":{"description":"The account's maximum number of mailing lists.\n* `unlimited`\n* An integer that represents a number of mailing lists.","example":"unlimited","oneOf":[{"enum":["unlimited"],"type":"string"},{"minimum":0,"type":"integer"}]},"maximum_parked_domains":{"description":"The account's maximum number of aliases.\n* `unlimited`\n* An integer that represents a number of aliases.","example":"unlimited","oneOf":[{"enum":["unlimited"],"type":"string"},{"minimum":0,"type":"integer"}]},"maximum_passenger_apps":{"description":"The account's maximum number of Ruby applications.\n  * `unlimited`\n  * An integer that represents a number of applications.","example":"unlimited","oneOf":[{"enum":["unlimited"],"type":"string"},{"minimum":0,"type":"integer"}]},"maximum_subdomains":{"description":"The account's maximum number of subdomains.\n* `unlimited`\n* An integer that represents a number of subdomains.","example":"unlimited","oneOf":[{"enum":["unlimited"],"type":"string"},{"minimum":0,"type":"integer"}]},"mxcheck":{"description":"Domains and their mail exchanger (MX) type.","example":{"example.com":"local","example2.com":"remote"},"properties":{"additionalProperties":{"description":"The domain's MX type.\n\n* `local` - Accept mail locally for the domain.\n* `remote` - Do not accept mail locally for the domain.\n* `secondary` - Accept mail until a higher priority mail server is available.\n\n**Note:**\n\nThe return's name is the domain name.","enum":["local","remote","secondary"],"example":"local","type":"string","x-additionalPropertiesName":"domain"}},"type":"object"},"notify_account_authn_link":{"description":"Whether the systems sends a notification when someone links the account to an external authentication account.\n* `1` - Notifies.\n* `0` - Doesn't notify.","enum":[0,1],"example":1,"type":"integer"},"notify_account_authn_link_notification_disabled":{"description":"Whether the systems sends a notification when someone disables notifications for external authentication account links.\n* `1` - Notifies.\n* `0` - Doesn't notify.","enum":[0,1],"example":1,"type":"integer"},"notify_account_login":{"description":"Whether the system sends a notification when someone logs in to the account.\n* `1` - Notifies.\n* `0` - Doesn't notify.","enum":[0,1],"example":1,"type":"integer"},"notify_account_login_for_known_netblock":{"description":"Whether the system sends a notification when a user on a known netblock logs in to the account.\n* `1` - Notifies.\n* `0` - Doesn't notify.","enum":[0,1],"example":1,"type":"integer"},"notify_account_login_notification_disabled":{"description":"Whether the system sends a notification when someone disables notifications for account logins.\n* `1` - Notifies.\n* `0` - Doesn't notify.","enum":[0,1],"example":1,"type":"integer"},"notify_autossl_expiry":{"description":"Whether the system sends a notification when an AutoSSL certificate expires.\n* `1` - Notifies.\n* `0` - Doesn't notify","enum":[0,1],"example":1,"type":"integer"},"notify_autossl_expiry_coverage":{"description":"Whether the system sends a notification when AutoSSL cannot renew a certificate because domains that fail Domain Control Validation (DCV) exist on the current certificate.\n* `1` - Notifies.\n* `0` - Doesn't notify.","enum":[0,1],"example":1,"type":"integer"},"notify_autossl_renewal_coverage":{"description":"Whether the system sends a notification when AutoSSL renews a certificate.\n* `1` - Notifies.\n* `0` - Doesn't notify.","enum":[0,1],"example":1,"type":"integer"},"notify_autossl_renewal_coverage_reduced":{"description":"Whether the system sends a notification when AutoSSL renews a certificate, but the new certificate lacks at least one domain that the previous certificate secured.\n* `1` - Notifies.\n* `0` - Doesn't notify.","enum":[0,1],"example":1,"type":"integer"},"notify_autossl_renewal_uncovered_domains":{"description":"Whether the system sends a notification when AutoSSL renews a certificate, but the new certificate lacks at least one domain that the previous certificate secured.\n* `1` - Notifies.\n* `0` - Doesn't notify.","enum":[0,1],"example":1,"type":"integer"},"notify_bandwidth_limit":{"description":"Whether the systems sends a notification when the account reaches its bandwidth quota.\n* `1` - Notifies.\n* `0` - Doesn't notify.","enum":[0,1],"example":1,"type":"integer"},"notify_contact_address_change":{"description":"Whether the systems sends a notification when someone changes the contact address for the account.\n* `1` - Notifies.\n* `0` - Doesn't notify.","enum":[0,1],"example":1,"type":"integer"},"notify_contact_address_change_notification_disabled":{"description":"Whether the systems sends a notification when someone disables the notification for contact address changes.\n* `1` - Notifies.\n* `0` - Doesn't notify.","enum":[0,1],"example":1,"type":"integer"},"notify_disk_limit":{"description":"Whether the systems sends a notification when the account reaches its disk usage limit.\n* `1` - Notifies.\n* `0` - Doesn't notify.","enum":[0,1],"example":1,"type":"integer"},"notify_password_change":{"description":"Whether the systems sends a notification when someone changes the account's password.\n* `1` - Notifies.\n* `0` - Doesn't notify.","enum":[0,1],"example":1,"type":"integer"},"notify_password_change_notification_disabled":{"description":"Whether the systems sends a notification when someone disables notifications for password changes.\n* `1` - Notifies.\n* `0` - Doesn't notify.","enum":[0,1],"example":1,"type":"integer"},"notify_ssl_expiry":{"description":"Whether the systems sends a notification when an SSL certificate on the account expires.\n* `1` - Notifies.\n* `0` - Doesn't notify.","enum":[0,1],"example":1,"type":"integer"},"notify_twofactorauth_change":{"description":"Whether the systems sends a notification when the account's Two-Factor Authentication (2FA) credentials change.\n* `1` - Notifies.\n* `0` - Doesn't notify.","enum":[0,1],"example":1,"type":"integer"},"notify_twofactorauth_change_notification_disabled":{"description":"Whether the systems sends a notification when someone disables notifications for 2FA.\n* `1` - Notifies.\n* `0` - Doesn't notify.","enum":[0,1],"example":1,"type":"integer"},"owner":{"description":"The account's owner.\n* `root`\n* A reseller account's username.\n* The account's username.","example":"root","format":"username","type":"string"},"package_extensions":{"description":"The account's package extensions.","example":["ext1","ext2","ext3"],"items":{"type":"string"},"type":"array"},"plan":{"description":"The account's hosting package.","example":"packagename","type":"string"},"pushbullet_access_token":{"description":"The account's Pushbullet access token.","example":"1234567890","type":"string"},"shell":{"description":"The account's shell.","example":"/bin/bash","format":"path","type":"string"},"spf_enabled":{"description":"Whether Sender Policy Framework (SPF) is enabled.\n* `1` - Enabled.\n* `0` - Not enabled.","enum":[0,1],"example":1,"type":"integer"},"ssl_default_key_type":{"description":"The type of key to generate for the user’s TLS certificates and CSRs.\n\n* `system` — The system’s `ssl_default_key_type` value in the [`cpanel.config` file](https://go.cpanel.net/ThecpanelconfigFile).\n* `rsa-2048` — 2,048-bit RSA.\n* `rsa-4096` — 4,096-bit RSA.\n* `ecdsa-prime256v1` — ECDSA prime256v1 (“P-256”).\n* `ecdsa-secp384r1` — ECDSA secp384r1 (“P-384”).","enum":["system","rsa-2048","rsa-4096","ecdsa-prime256v1","ecdsa-secp384r1"],"example":"rsa-2048","type":"string"},"theme":{"description":"The account's current theme.","example":"jupiter","type":"string"},"uid":{"description":"The account's user ID on the system.","example":1234,"type":"integer"},"user":{"description":"An existing account's username.","example":"username","type":"string"},"utf8_mailbox":{"description":"Whether UTF-8-encoded mailbox names are enabled for the cPanel account.\n* `1` - Enabled.\n* `0` - Not enabled.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1`  Success\n* `0`  Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel account's configuration settings","tags":["Variables","Account Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Variables \\\n  get_user_information\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Variables/get_user_information"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Variables_get_user_information.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Variables_get_user_information.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Variables/,\n    q/get_user_information/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Variables_get_user_information.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Variables_get_user_information.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Variables',\n    'get_user_information'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 86"}},"/DNSSEC/set_nsec3":{"get":{"description":"This function configures the domain to use [Next Secure Record 3](https://tools.ietf.org/html/rfc4470) (NSEC3) semantics.\n\n**Important:**\n\n  When you disable the [DNS role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"set_nsec3","parameters":[{"description":"The domain on which to enable NSEC3 semantics.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"Whether the system will create records for all delegations.\n\n* `1` - Create records for all delegations.\n* `0` - Create records **only** for secure delegations.\n\n**Note:**\n\n  **Only** select `1` if you **must** create records for all delegations.","in":"query","name":"nsec3_opt_out","required":true,"schema":{"enum":[0,1],"example":0,"type":"integer"}},{"description":"The number of times that the system re-executes the first resource record hash operation.","in":"query","name":"nsec3_iterations","required":true,"schema":{"example":7,"maximum":500,"minimum":1,"type":"integer"}},{"description":"Whether NSEC3 will operate in Narrow mode or Inclusive mode. In Narrow mode, PowerDNS sends out white lies about the next secure record. Rather than query the resource record in the database, PowerDNS sends the hash plus 1 as the next secure record.\n* `1` - Narrow mode. * `0` - Inclusive mode.","in":"query","name":"nsec3_narrow","required":true,"schema":{"enum":[0,1],"example":1,"type":"integer"}},{"description":"The salt value that PowerDNS uses in the hashes. For more information about the salt value, read the [RFC 5155 documentation](https://tools.ietf.org/html/rfc5155).","in":"query","name":"nsec3_salt","required":true,"schema":{"example":"1A2B3C4D5E6F","format":"hex","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_nsec3","type":"string"},"module":{"description":"The name of the module called.","example":"DNSSEC","type":"string"},"result":{"properties":{"data":{"properties":{"enabled":{"additionalProperties":{"description":"Whether the system enabled NSEC3 on the domain.\n\n  * `1` - Enabled.\n  * `0` - The system failed to enable NSEC3.","enum":[0,1],"type":"integer"},"description":"Contains the domains for which the system enabled NSEC3.\n\n**Note:**\n\nThis return's name is the `domain` parameter's value.","example":{"example1.com":1},"type":"object"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update domain to use NSEC3","tags":["DNSSEC","DNS Security"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DNSSEC \\\n  set_nsec3 \\\n  domain='example.com' \\\n  nsec3_opt_out='0' \\\n  nsec3_iterations='7' \\\n  nsec3_narrow='1' \\\n  nsec3_salt='1A2B3C4D5E6F'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DNSSEC/set_nsec3?domain=example.com&nsec3_opt_out=0&nsec3_iterations=7&nsec3_narrow=1&nsec3_salt=1A2B3C4D5E6F"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DNSSEC_set_nsec3.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DNSSEC_set_nsec3.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DNSSEC/,\n    q/set_nsec3/,\n    {\n        'domain' => 'example.com',\n        'nsec3_opt_out' => '0',\n        'nsec3_iterations' => '7',\n        'nsec3_narrow' => '1',\n        'nsec3_salt' => '1A2B3C4D5E6F',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DNSSEC_set_nsec3.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DNSSEC_set_nsec3.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DNSSEC',\n    'set_nsec3',\n    array (\n        'domain' => 'example.com',\n        'nsec3_opt_out' => '0',\n        'nsec3_iterations' => '7',\n        'nsec3_narrow' => '1',\n        'nsec3_salt' => '1A2B3C4D5E6F',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 60"}},"/VersionControl/update":{"get":{"description":"This function modifies a Git™ repository's basic settings. For more information about support\nfor version control in cPanel & WHM, read our\n[Git Version Control](https://go.cpanel.net/GitVersionControl)\nand [Guide to Git](https://go.cpanel.net/GitDeployment) documentation.\n\n**Note:**\n\n* This function **only** pulls changes from the remote repository if you specify a `branch` value.\n* You **cannot** modify the `type`, `repository_root`, or `url` values for existing repositories.\n* You **must** include the `repository_root` parameter in order to identify the repository to\nupdate.\n* All other input parameters are **optional**. Use them to assign the **new** values to the\naccount. If you do not include a parameter or specify its existing value, no change will occur.","operationId":"VersionControl::update","parameters":[{"description":"The absolute directory path that contains the repository to update.","in":"query","name":"repository_root","required":true,"schema":{"example":"/home/user/public_html/example","format":"path","type":"string"}},{"description":"The repository's new display name.\n\nIf you do not specify a value, the function does **not** update this parameter.","in":"query","name":"name","required":false,"schema":{"example":"example","type":"string"}},{"description":"The new branch to use.\n\nIf you do not specify a value, the function does **not** update this parameter.\n\n**Remember:**\n\nThis function **only** pulls changes from the remote repository if you specify\nthis value.","in":"query","name":"branch","required":false,"schema":{"example":"master","type":"string"}},{"content":{"application/json":{"schema":{"example":{"remote_name":"origin"},"properties":{"remote_name":{"description":"The source repository's name. If you do not specify a value, the function does **not** update this parameter.","type":"string"}},"type":"object"}}},"description":"A JSON-encoded object containing information about the source repository.\n\nIf you do not specify a value, the function does **not** update this parameter.\n\n**Important:**\n\n* You **cannot** modify the source repository's URL.\n* You **must** JSON-encode the contents of this object.","in":"query","name":"source_repository","required":false}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"update","type":"string"},"module":{"description":"The name of the module called.","example":"VersionControl","type":"string"},"result":{"properties":{"data":{"example":{"available_branches":["master"],"branch":"master","clone_urls":{"read_only":["https://user@example.com/home/user/example"],"read_write":["ssh://user@example.com/home/user/example"]},"deployable":1,"last_deployment":{"deployment_date":1569844800,"repository_state":{"author":"User Name <user.name@example.com>","date":1569844800,"identifier":"2fd4e1c67a2d28fced849ee1bb76e7391b93eb121","message":"I'm committing some particularly cromulent code."}},"last_update":{"author":"Jane Doe <jane.doe@example.com>","date":1569844800,"identifier":"2fd4e1c67a2d28fced849ee1bb76e7391b93eb12","message":"I'm committing some particularly cromulent code."},"name":"example","repository_root":"/home/user/example","tasks":[{"action":"create","args":{"repository_root":"/home/user/example"},"id":"00000000/5a9ec8dd4c345d","subsystem":"VersionControl"}],"type":"git"},"properties":{"available_branches":{"description":"A list of local and remote branches available for the cloned or\nexisting repository.\n\n* An empty array, if no branches exist.\n* `null` — The repository is a bare repository.","items":{"nullable":true,"type":"string"},"type":"array"},"branch":{"description":"The repository's current branch.\n\n* `null` — The system has not finished the clone process for the\nrepository, no local branches exist, or the repository is a bare\nrepository.","nullable":true,"type":"string"},"clone_urls":{"description":"An object containing the URLs to use to clone the repository.\n\nThe function returns an empty object if the account does **not**\ninclude the *Shell Access* setting.\n\n**Important:**\n\nIf the server uses a nonstandard SSH port, the system returns a\nclone URL that includes the port number. ","properties":{"read_only":{"description":"A list of clone URLs with read-only permissions.\n\nThis function returns an empty list if the account does\n**not** include the *Shell Access* setting.\n\n**Important:**\n\nIf the server uses a nonstandard SSH port, the system returns a\nclone URL that includes the port number.","items":{"format":"url","type":"string"},"type":"array"},"read_write":{"description":"A list of clone URLs with read-write permissions.\n\nThis function returns an empty list if the account does\n**not** include the *Shell Access* setting.\n\n**Important:**\n\nIf the server uses a nonstandard SSH port, the system returns a\nclone URL that includes the port number.","items":{"type":"string"},"type":"array"}},"type":"object"},"deployable":{"description":"Whether the system could deploy the repository.\n\n* `1` — Can deploy.\n* `0` — Cannot deploy.","enum":[1,0],"type":"integer"},"last_deployment":{"description":"An object containing information about the commit that the system\nmost recently deployed.\n\n**Note:**\n\nIf no deployment information exists, the function returns a `null` value.","nullable":true,"properties":{"deployment_date":{"description":"The timestamp for the most recent deployment.","format":"unix_timestamp","type":"integer"},"repository_state":{"description":"A object containing information about the state of the repository at the time of the most recent deployment.","properties":{"author":{"description":"The author's name and email address for the commit that the system most recently deployed.","type":"string"},"date":{"description":"The timestamp for the commit that the system most recently deployed.","format":"unix_timestamp","type":"integer"},"identifier":{"description":"The identifier (SHA-1 value) for the commit that the system most recently deployed.","type":"string"},"message":{"description":"The commit message for the commit that the system most recently deployed.","type":"string"}},"type":"object"}},"type":"object"},"last_update":{"description":"An object containing information about the most recent (HEAD) commit for\nthe current branch.\n\n**Note:**\n\nThis object's information resembles the output of the `git log -1`\ncommand.\n\n**Important:**\n\n* If the repository does **not** include any commits, the function\nreturns a `null` value instead of an object.\n* The system may require a large amount of time to clone larger repositories.\nUntil this process finishes, HEAD information is unavailable.","nullable":true,"properties":{"author":{"description":"The most recent commit's author name and email address.","type":"string"},"date":{"description":"The timestamp for the most recent commit.","format":"unix_timestamp","type":"integer"},"identifier":{"description":"The identifier (SHA-1 value) for the most recent commit.","type":"string"},"message":{"description":"The commit message.","type":"string"}},"type":"object"},"name":{"description":"The repository's display name.","type":"string"},"repository_root":{"description":"The directory path that exists in the user's `home` directory containing the repository.","type":"string"},"source_repository":{"description":"An object containing information about the source repository.\n\n**Note:**\n\nThe function **only** returns this object if you cloned a source\nrepository.","properties":{"remote_name":{"description":"The source repository's name.","type":"string"},"url":{"description":"The source repository's clone URL.","type":"string"}},"type":"object"},"tasks":{"description":"An array of objects containing information about the\n[Task Queue](https://go.cpanel.net/whmdocsTaskQueueMonitor)\nsystem's process that will clone the repository.\n\n**Note:**\n\nThe function **only** returns this value if the clone process is\nnot finished.","items":{"properties":{"action":{"description":"The task's action.\n\n* `create` — Create the repository.\n* `deploy` — Deploy the repository.","enum":["create","deploy"],"type":"string"},"args":{"description":"An object containing arguments for the Task Queue system's process.","properties":{"log_file":{"description":"The absolute path to the process log file in the user's\n`home` directory.\n\n**Note:**\n\nThe function **only** returns this value if the process\ngenerated a log file.","type":"string"},"repository_root":{"description":"The repository's absolute directory path in the user's `home` directory.","type":"string"}},"type":"object"},"id":{"description":"The Task Queue system's task ID number.","type":"string"},"subsystem":{"description":"The Task Queue subsystem that will handle the task.\n\n* `VersionControl`\n\n**Note:**\n\n* `VersionControl` is the only possible value.","enum":["VersionControl"],"type":"string"}},"type":"object"},"type":"array"},"type":{"description":"The repository type.\n\n* `git` — A [Git](https://git-scm.com/) repository.\n\n**Note:**\n\n* `git` is the only possible value.","enum":["git"],"type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update Git repository settings","tags":["VersionControl","Repository Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  VersionControl \\\n  update \\\n  repository_root='/home/user/public_html/example'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/VersionControl/update?repository_root=%2fhome%2fuser%2fpublic_html%2fexample"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file VersionControl_update.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/VersionControl_update.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/VersionControl/,\n    q/update/,\n    {\n        'repository_root' => '/home/user/public_html/example',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file VersionControl_update.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/VersionControl_update.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'VersionControl',\n    'update',\n    array (\n        'repository_root' => '/home/user/public_html/example',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 72"}},"/DNS/is_alias_available":{"get":{"description":"This function returns whether `ALIAS` and `ANAME` records are available and the value of the running PowerDNS (PDNS) `resolver` setting, if any exists.\nFor more information, read our [`ALIAS` documentation](https://go.cpanel.net/dns-alias-record).","operationId":"DNS::is_alias_available","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"is_alias_available","type":"string"},"module":{"description":"The name of the module called.","example":"DNS","type":"string"},"result":{"properties":{"data":{"properties":{"alias":{"description":"Whether `ALIAS` records are available.\n\n* `1` - Available.\n* `0` - Not available.\n\nWhen `ALIAS` records are enabled, they may work in API calls that accept `A` and `AAAA` records. However, the `ALIAS` record must use a fully qualified domain name (FQDN) rather than an IP address.","enum":[1,0],"example":1,"type":"integer"},"aname":{"description":"Whether `ANAME` records are available.\n\n* `1` - Available.\n* `0` - Not available.\n\n**NOTE:**\n\nThe `aname` value is always set to false (i.e. Not available). The `ANAME` record is currently not supported. It is included for completeness and future proofing.","enum":[1,0],"example":0,"type":"integer"},"resolver":{"description":"The value (if any) of the running PDNS’s `resolver` setting.","example":"8.8.8.8","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return `ALIAS` DNS record availability & resolver","tags":["DNS","DNS Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty --user=username DNS is_alias_available\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DNS/is_alias_available"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DNS_is_alias_available.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DNS_is_alias_available.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(DNS => 'is_alias_available');\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DNS_is_alias_available.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DNS_is_alias_available.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DNS',\n    'is_alias_available'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 122"}},"/VersionControlDeployment/create":{"get":{"description":"This function deploys the changes from a cPanel-managed repository.\n\n**Important:**\n\nThe system logs messages for this function in the `~/.cpanel/logs/vc_TIMESTAMP_git_deploy.log` file, where TIMESTAMP represents the time in Unix epoch time. The system pulls changes with the `--ff-only` option and will only succeed if the branch's HEAD commit is up-to-date or Git can fast forward it. For more information about our suggested deployment configuration and how users can set it up, read our [Guide to Git™ - Deployment](https://go.cpanel.net/GitDeployment) documentation. Before deployment, repositories must meet the following requirements:\n  * A valid checked-in `.cpanel.yml` file in the top-level directory.\n  * One or more local or remote branches.\n  * A clean working tree.\n\nIf a repository does **not** meet these requirements, the system will **not** display deployment information. Also, it will disable deployment functionality. For more information, read our [Guide to Git™ - Deployment](https://go.cpanel.net/GitDeployment) documentation.","operationId":"VersionControlDeployment::create","parameters":[{"description":"The repository's directory.","in":"query","name":"repository_root","required":true,"schema":{"example":"/home/user/public_html/example","format":"path","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"create","type":"string"},"module":{"description":"The name of the module called.","example":"VersionControlDeployment","type":"string"},"result":{"properties":{"data":{"properties":{"deploy_id":{"description":"The deployment ID number.","example":"12","type":"string"},"log_path":{"description":"The absolute path to the task's log file vc_TIMESTAMP_git_deploy.log, where TIMESTAMP represents the time in Unix epoch time.","example":"/home/user/.cpanel/logs/vc_1525289545.785367_git_deploy.log","format":"path","type":"string"},"repository_root":{"description":"The repository's directory.","example":"/home/username/example","format":"path","type":"string"},"sse_url":{"description":"The SSE interface to track the progress of the deployment process.","example":"/sse/UserTasks/B3A27B96-51F7-11E8-92E3-CC90C4F823F0","format":"url-path","type":"string"},"task_id":{"description":"The Task Queue system's task ID number.","example":"00000000/5a9ec8dd4c345d","type":"string"},"timestamps":{"description":"A hash of timestamps for the deployment process.","format":"object","properties":{"queued":{"description":"The time at which the deployment process. entered the task queue.","example":"1525289545.16293","type":"string"}},"type":"object"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create Git deployment task","tags":["VersionControlDeployment","Deployment Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  VersionControlDeployment \\\n  create \\\n  repository_root='/home/user/public_html/example'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/VersionControlDeployment/create?repository_root=%2fhome%2fuser%2fpublic_html%2fexample"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file VersionControlDeployment_create.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/VersionControlDeployment_create.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/VersionControlDeployment/,\n    q/create/,\n    {\n        'repository_root' => '/home/user/public_html/example',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file VersionControlDeployment_create.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/VersionControlDeployment_create.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'VersionControlDeployment',\n    'create',\n    array (\n        'repository_root' => '/home/user/public_html/example',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 74"}},"/VersionControl/delete":{"get":{"description":"This function deletes a cPanel account's Git™ repository. For more information about\nsupport for version control in cPanel & WHM, read our\n[Git Version Control](https://go.cpanel.net/GitVersionControl) and\n[Guide to Git](https://go.cpanel.net/GitDeployment) documentation.\n\n**Warning:**\n\n* When you call this function, the system **permanently deletes** the entire contents\nof the specified directory. You **cannot** recover this data after deletion.\n* You **cannot** use this function to delete any repositories that do not appear in\nthe cache of repositories (for example, repositories that contain invalid characters or\nexist within cPanel-controlled directories).","operationId":"VersionControl::delete","parameters":[{"description":"The absolute directory path in the user's `home` directory containing the repository to delete.","in":"query","name":"repository_root","required":true,"schema":{"example":"/home/user/example","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"delete","type":"string"},"module":{"description":"The name of the module called.","example":"VersionControl","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete Git repository","tags":["VersionControl","Repository Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  VersionControl \\\n  delete \\\n  repository_root='/home/user/example'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/VersionControl/delete?repository_root=%2fhome%2fuser%2fexample"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file VersionControl_delete.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/VersionControl_delete.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/VersionControl/,\n    q/delete/,\n    {\n        'repository_root' => '/home/user/example',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file VersionControl_delete.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/VersionControl_delete.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'VersionControl',\n    'delete',\n    array (\n        'repository_root' => '/home/user/example',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 72"}},"/VersionControlDeployment/delete":{"get":{"description":"This function deletes a deployment task. For more information, read our [Guide to Git - Deployment](https://go.cpanel.net/GitDeployment) documentation.","operationId":"delete","parameters":[{"description":"The [Task Queue system's](https://go.cpanel.net/whmdocsTaskQueueMonitor) task ID number.","in":"query","name":"deploy_id","required":true,"schema":{"example":"13","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"delete","type":"string"},"module":{"description":"The name of the module called.","example":"VersionControlDeployment","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete Git deployment task","tags":["VersionControlDeployment","Deployment Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  VersionControlDeployment \\\n  delete \\\n  deploy_id='13'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/VersionControlDeployment/delete?deploy_id=13"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file VersionControlDeployment_delete.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/VersionControlDeployment_delete.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/VersionControlDeployment/,\n    q/delete/,\n    {\n        'deploy_id' => '13',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file VersionControlDeployment_delete.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/VersionControlDeployment_delete.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'VersionControlDeployment',\n    'delete',\n    array (\n        'deploy_id' => '13',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 74"}},"/WebDisk/delete_user":{"get":{"description":"This function deletes a Web Disk account.\n\n**Important:**\n\nWhen you disable the [Web Disk role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"WebDisk::delete_user","parameters":[{"description":"The Web Disk account username.","in":"query","name":"user","required":true,"schema":{"example":"example1@example.com","format":"email","type":"string"}},{"description":"Whether to recursively delete the Web Disk account's folder and all of its contents.\n\n* `1` - Delete the folder for the Web Disk account\n* `0` - Do **not** delete the folder for the Web Disk account.","in":"query","name":"destroy","required":true,"schema":{"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"delete_user","type":"string"},"module":{"description":"The name of the module called.","example":"WebDisk","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete Web Disk account","tags":["WebDisk","WebDisk Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  WebDisk \\\n  delete_user \\\n  user='example1@example.com' \\\n  destroy='1'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/WebDisk/delete_user?user=example1%40example.com&destroy=1"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file WebDisk_delete_user.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/WebDisk_delete_user.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/WebDisk/,\n    q/delete_user/,\n    {\n        'user' => 'example1@example.com',\n        'destroy' => '1',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file WebDisk_delete_user.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/WebDisk_delete_user.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'WebDisk',\n    'delete_user',\n    array (\n        'user' => 'example1@example.com',\n        'destroy' => '1',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/VersionControlDeployment/retrieve":{"get":{"description":"This function retrieves the status of deployment tasks. Before deployment, repositories must meet the following requirements:\n  * A valid checked-in `.cpanel.yml` file in the top-level directory.\n  * One or more local or remote branches.\n  * A clean working tree.\n\nIf a repository does **not** meet these requirements, the system will **not** display deployment information. Also, it will disable deployment functionality. For more information, read our [Guide to Git™ - Deployment](https://go.cpanel.net/GitDeployment) documentation.\n\n**Important:**\n\nThe system logs messages for this function in the `~/.cpanel/logs/vc_TIMESTAMP_git_deploy.log` file, where `TIMESTAMP` represents the time in Unix epoch time.","operationId":"VersionControlDeployment::retrieve","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"retrieve","type":"string"},"module":{"description":"The name of the module called.","example":"VersionControlDeployment","type":"string"},"result":{"properties":{"data":{"description":"An array of objects containing deployment task data.","items":{"properties":{"deploy_id":{"description":"The deployment ID number.","example":13,"type":"integer"},"log_path":{"description":"The absolute path to the task's log file.","example":"/home/user/.cpanel/logs/vc_1525289448.759720_git_deploy.log","format":"path","type":"string"},"repository_root":{"description":"The aboslute path to the cPanel-managed repository directory.","example":"/home/username/example","format":"path","type":"string"},"repository_state":{"description":"An object containing information about the repository's state at the time of deployment.","properties":{"author":{"description":"The most-recent commit's author's name and email address as they exist in the user's Git configuration files.","example":"Jane Doe <jane.doe@example.com>","type":"string"},"branch":{"description":"The repository's current branch.","example":"master","type":"string"},"date":{"description":"The timestamp for the most-recent commit, in Unix time format.","example":1410277881,"format":"unix_timestamp","type":"integer"},"identifier":{"description":"The identifier (SHA-1 value) for the most-recent commit.","example":"2fd4e1c67a2d28fced849ee1bb76e7391b93eb12","type":"string"},"message":{"description":"The commit message.","example":"This is a commit.","type":"string"}},"type":"object"},"sse_url":{"description":"The SSE interface to track the progress of the deployment process.","example":"/sse/UserTasks/B3A27B96-51F7-11E8-92E3-CC90C4F823F0","format":"url-path","type":"string"},"task_id":{"description":"The [Task Queue](https://go.cpanel.net/whmdocsTaskQueueMonitor) system's task ID number.","example":"00000000/5aea11e886a5d8","type":"string"},"timestamps":{"description":"An object containing timestamps for the deployment process.","properties":{"active":{"description":"The time at which the system started the deployment process, in Unix time format.","example":"1525289448.83553","type":"string"},"canceled":{"description":"The time at which the system cancelled the deployment process, in Unix time format.\n\n**Note:**\n\n* The function only returns this value if the system cancelled the deployment process.\n* The system logs messages for this function in the `~/.cpanel/logs/vc_TIMESTAMP_git_deploy.log` file, where `TIMESTAMP` represents the Unix timestamp.","example":"1525289448.83553","type":"string"},"failed":{"description":"The time at which the deployment process failed, in Unix time format.\n\n**Note:**\n\n* The function only returns this value if the deployment process failed.\n* The system logs messages for this function in the `~/.cpanel/logs/vc_TIMESTAMP_git_deploy.log` file, where `TIMESTAMP` represents the Unix timestamp.","example":"1525289448.83553","type":"string"},"queued":{"description":"The time at which the deployment process entered the task queue, in Unix time format.","example":"1525289448.83553","type":"string"},"succeeded":{"description":"The time at which the deployment process finished successfully, in Unix time format.\n\n**Note:**\n\n The function only returns this value if the deployment process succeeded.","example":"1525289448.83553","type":"string"}},"type":"object"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return Git deployment task status","tags":["VersionControlDeployment","Deployment Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  VersionControlDeployment \\\n  retrieve\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/VersionControlDeployment/retrieve"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file VersionControlDeployment_retrieve.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/VersionControlDeployment_retrieve.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/VersionControlDeployment/,\n    q/retrieve/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file VersionControlDeployment_retrieve.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/VersionControlDeployment_retrieve.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'VersionControlDeployment',\n    'retrieve'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 74"}},"/WebDisk/set_password":{"get":{"description":"This function changes the Web Disk account's password.\n\n**Important:**\n\nWhen you disable the [Web Disk role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"WebDisk::set_password","parameters":[{"description":"The Web Disk account username.","in":"query","name":"user","required":true,"schema":{"example":"example1@example.com","format":"email","type":"string"}},{"description":"The Web Disk account's password.","in":"query","name":"password","required":true,"schema":{"example":"123456luggage","type":"string"}},{"description":"Whether to enable Digest Authentication.\n\n* `1` - Enable Digest Authentication.\n* `0` - Disable Digest Authentication.","in":"query","name":"enabledigest","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_password","type":"string"},"module":{"description":"The name of the module called.","example":"WebDisk","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update Web Disk account password","tags":["WebDisk","WebDisk Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  WebDisk \\\n  set_password \\\n  user='example1@example.com' \\\n  password='123456luggage'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/WebDisk/set_password?user=example1%40example.com&password=123456luggage"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file WebDisk_set_password.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/WebDisk_set_password.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/WebDisk/,\n    q/set_password/,\n    {\n        'user' => 'example1@example.com',\n        'password' => '123456luggage',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file WebDisk_set_password.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/WebDisk_set_password.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'WebDisk',\n    'set_password',\n    array (\n        'user' => 'example1@example.com',\n        'password' => '123456luggage',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/WebDisk/set_homedir":{"get":{"description":"This function changes the home directory for a Web Disk account.\n\n**Important:**\n\nWhen you disable the [Web Disk role](https://go.cpanel.net/serveroles), the system **disables** this function.","operationId":"WebDisk::set_homedir","parameters":[{"description":"The Web Disk account username.","in":"query","name":"user","required":true,"schema":{"example":"example1@example.com","format":"email","type":"string"}},{"description":"The Web Disk account's home directory.","in":"query","name":"homedir","required":true,"schema":{"example":"example1/","format":"path","type":"string"}},{"description":"Whether to set the Web Disk directory's permissions to public or private.\n\n* `1` - Private (`0700`)\n* `0` - Public (`0755`)","in":"query","name":"private","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_homedir","type":"string"},"module":{"description":"The name of the module called.","example":"WebDisk","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update Web Disk home directory location","tags":["WebDisk","WebDisk Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  WebDisk \\\n  set_homedir \\\n  user='example1@example.com' \\\n  homedir='example1/'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/WebDisk/set_homedir?user=example1%40example.com&homedir=example1%2f"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file WebDisk_set_homedir.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/WebDisk_set_homedir.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/WebDisk/,\n    q/set_homedir/,\n    {\n        'user' => 'example1@example.com',\n        'homedir' => 'example1/',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file WebDisk_set_homedir.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/WebDisk_set_homedir.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'WebDisk',\n    'set_homedir',\n    array (\n        'user' => 'example1@example.com',\n        'homedir' => 'example1/',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/WebDisk/set_permissions":{"get":{"description":"This function changes the Web Disk home directory's permissions.\n\n**Important:**\n\nWhen you disable the [Web Disk role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"set_permissions","parameters":[{"description":"The Web Disk account's username.","in":"query","name":"user","required":true,"schema":{"example":"example1@example.com","format":"email","type":"string"}},{"description":"The Web Disk account's home directory file permissions.\n\n* `ro` — Read-only permissions.\n* `rw` — Read and write permissions.","in":"query","name":"perms","required":true,"schema":{"enum":["ro","rw"],"example":"rw","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_permissions","type":"string"},"module":{"description":"The name of the module called.","example":"WebDisk","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update Web Disk home directory permissions","tags":["WebDisk","WebDisk Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  WebDisk \\\n  set_permissions \\\n  user='example1@example.com' \\\n  perms='rw'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/WebDisk/set_permissions?user=example1%40example.com&perms=rw"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file WebDisk_set_permissions.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/WebDisk_set_permissions.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/WebDisk/,\n    q/set_permissions/,\n    {\n        'user' => 'example1@example.com',\n        'perms' => 'rw',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file WebDisk_set_permissions.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/WebDisk_set_permissions.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'WebDisk',\n    'set_permissions',\n    array (\n        'user' => 'example1@example.com',\n        'perms' => 'rw',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/WebVhosts/list_domains":{"get":{"description":"This function lists virtual host names for each domain.","operationId":"WebVhosts::list_domains","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_domains","type":"string"},"module":{"description":"The name of the module called.","example":"WebVhosts","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"domain":{"description":"The domain name.","example":"example.com","format":"domain","type":"string"},"proxy_subdomains":{"description":"An array of service subdomains (proxy subdomains) listed for the domain.\n\n**Note:**\n\nThis only returns values when `vhost_is_ssl` equals `1`.","example":["cpanel","webmail","autodiscover","whm","webdisk"],"items":{"type":"string"},"nullable":true,"type":"array"},"vhost_is_ssl":{"description":"Whether an SSL certificate secures the domain.\n* `1` - Secured.\n* `0` - **Not** secured.","enum":[0,1],"example":1,"type":"integer"},"vhost_name":{"description":"The name of the virtual host.","example":"hostname.example.com","format":"domain","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return virtual host names for domains","tags":["WebVhosts","Virtual Host Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  WebVhosts \\\n  list_domains\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/WebVhosts/list_domains"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file WebVhosts_list_domains.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/WebVhosts_list_domains.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/WebVhosts/,\n    q/list_domains/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file WebVhosts_list_domains.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/WebVhosts_list_domains.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'WebVhosts',\n    'list_domains'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 56"}},"/DNSSEC/activate_zone_key":{"get":{"description":"This function activates a DNSSEC security key.\n\n**Important:**\n\nWhen you disable the [DNS role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"activate_zone_key","parameters":[{"description":"The security key's domain.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"The security key's ID.","in":"query","name":"key_id","required":true,"schema":{"example":1,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"activate_zone_key","type":"string"},"module":{"description":"The name of the module called.","example":"DNSSEC","type":"string"},"result":{"properties":{"data":{"example":{"domain":"example.com","key_id":"1","success":1},"properties":{"domain":{"description":"The domain for which the system activated a security key.","example":"example.com","format":"domain","type":"string"},"error":{"description":"An error message that describes why the system could not activate the security key.\n\n**Note:**\n\nThe function **only** displays this return when the `success` return is a `0` value.","example":"Error: Invalid key_id or domain specified: No such key present for domain.","type":"string"},"key_id":{"description":"The security key's ID.","example":"1","type":"string"},"success":{"description":"Whether the system activated the security key.\n* `1` - Activated.\n* `0` - The system failed to activate the security key. ","enum":[1,0],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable DNSSEC security key","tags":["DNSSEC","DNS Security"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DNSSEC \\\n  activate_zone_key \\\n  domain='example.com' \\\n  key_id='1'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DNSSEC/activate_zone_key?domain=example.com&key_id=1"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DNSSEC_activate_zone_key.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DNSSEC_activate_zone_key.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DNSSEC/,\n    q/activate_zone_key/,\n    {\n        'domain' => 'example.com',\n        'key_id' => '1',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DNSSEC_activate_zone_key.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DNSSEC_activate_zone_key.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DNSSEC',\n    'activate_zone_key',\n    array (\n        'domain' => 'example.com',\n        'key_id' => '1',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 84"}},"/WebVhosts/list_ssl_capable_domains":{"get":{"description":"This function lists every domain for which you may purchase an SSL certificate. The possible domains for the Secure Sockets Layer (SSL) certificate include applicable [service subdomains.](https://go.cpanel.net/ServiceProxySubdomains)","operationId":"list_ssl_capable_domains","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_ssl_capable_domains","type":"string"},"module":{"description":"The name of the module called.","example":"WebVhosts","type":"string"},"result":{"properties":{"data":{"description":"An array of objects containing data for a domain.","items":{"properties":{"domain":{"description":"A valid domain name on the virtual host.","example":"example.com","format":"domain","type":"string"},"is_proxy":{"description":"Whether the system automatically created the service subdomain or a user manually created the domain.\n* `1` - The system automatically created the service subdomain.\n* `0` - A user manually created the domain.\n\n**Note:**\n\nIf a user manually creates a subdomain that matches a preassigned subdomain (for example, cpanel or whm), then the function returns `0`.","enum":[0,1],"example":1,"type":"integer"},"vhost_name":{"description":"The name of the virtual host or website.","example":"hostname.example.com","format":"domain","type":"string"}},"type":"object"},"properties":{},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return domains that allow SSL certificate purchase","tags":["WebVhosts","Virtual Host Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  WebVhosts \\\n  list_ssl_capable_domains\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/WebVhosts/list_ssl_capable_domains"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file WebVhosts_list_ssl_capable_domains.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/WebVhosts_list_ssl_capable_domains.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/WebVhosts/,\n    q/list_ssl_capable_domains/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file WebVhosts_list_ssl_capable_domains.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/WebVhosts_list_ssl_capable_domains.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'WebVhosts',\n    'list_ssl_capable_domains'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 64"}},"/WordPressBackup/cancel":{"get":{"description":"This function cancels a WordPress® site backup.\n\n**Note:**\n\n  You **must** install the [WordPress Manager](https://go.cpanel.net/wordpressmanager) cPanel plugin to access this API function.","operationId":"cancel","parameters":[{"description":"The WordPress site's URL without the protocol prefix.","example":"example.com","in":"query","name":"site","required":true,"schema":{"anyOf":[{"example":"example.com","format":"domain"},{"example":"example.com/wordpress","format":"url-path"}],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"cancel","type":"string"},"module":{"description":"The name of the module called.","example":"WordPressBackup","type":"string"},"result":{"properties":{"data":{"properties":{"ok":{"description":"Whether the system cancelled an active backup.\n* `1` — Backup cancelled.\n* `0` — Could not cancel the backup or no active backup in progress.","enum":[0,1],"example":0,"type":"integer"},"site":{"description":"The site's URL without the protocol prefix.","oneOf":[{"example":"example.com","format":"domain"},{"example":"example.com/wordpress","format":"url-path"}],"type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Stop WordPress site backup","tags":["WordPressBackup","WordPress Manager Backups"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  WordPressBackup \\\n  cancel \\\n  site='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/WordPressBackup/cancel?site=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file WordPressBackup_cancel.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/WordPressBackup_cancel.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/WordPressBackup/,\n    q/cancel/,\n    {\n        'site' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file WordPressBackup_cancel.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/WordPressBackup_cancel.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'WordPressBackup',\n    'cancel',\n    array (\n        'site' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"WordPress Manager 3.0"}},"/WordPressBackup/any_running":{"get":{"description":"This function checks for any active WordPress® site backups on the cPanel account.\n\n**Note:**\n\nYou **must** install the [WordPress Manager](https://go.cpanel.net/wordpressmanager) cPanel plugin to access this API function.","operationId":"any_running","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"any_running","type":"string"},"module":{"description":"The name of the module called.","example":"WordPressBackup","type":"string"},"result":{"properties":{"data":{"properties":{"any_running":{"description":"Whether any backups are in progess.\n* `1` - Backups are in progress.\n* `0` - No backups are in progress.","enum":[0,1],"example":0,"type":"integer"},"sites":{"description":"An array that contains each site with a backup in progress. The function only populates this array if it is actively processing a backup.","items":{"properties":{"id":{"description":"The WordPress site's unique ID.\n\n**Note:**\n\n`null` is the only possible value. We have not implemented this return.","example":"null","nullable":true,"type":"string"},"site":{"description":"The WordPress site's URL. The URL does not contain a protocol prefix.","example":"example.com","type":"string"},"type":{"description":"The type of process that is active.\n\n**Note:**\n\n`backup` is the only possible value.","example":"backup","type":"string"}},"type":"object"},"type":"array"},"sse_url":{"description":"The SSE service URL that the system uses to monitor the backup progress. The SSE service URL does not contain a protocol, hostname, or port.","example":"/sse/WordPressBackup","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* 1 - Success.\n* 0 - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return all WordPress sites' backup status","tags":["WordPressBackup","WordPress Manager Backups"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  WordPressBackup \\\n  any_running\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/WordPressBackup/any_running"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file WordPressBackup_any_running.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/WordPressBackup_any_running.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/WordPressBackup/,\n    q/any_running/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file WordPressBackup_any_running.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/WordPressBackup_any_running.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'WordPressBackup',\n    'any_running'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"WordPress Manager 3.0"}},"/WordPressBackup/cleanup":{"get":{"description":"This function releases any system resources from a previous WordPress® site backup.\n\n**Note:**\n\nYou **must** install the [WordPress Manager](https://go.cpanel.net/wordpressmanager) cPanel plugin to access this API function.","operationId":"cleanup","parameters":[{"description":"The WordPress site's URL **without** the protocol prefix.","in":"query","name":"site","required":true,"schema":{"example":"example.com/wordpress","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"cleanup","type":"string"},"module":{"description":"The name of the module called.","example":"WordPressBackup","type":"string"},"result":{"properties":{"data":{"nullable":true,"properties":{"ok":{"description":"Whether the system released the system resources.\n* `1` - Resources released.\n* `0` - Backup in progress.","enum":[0,1],"example":1,"type":"integer"},"site":{"description":"The site's URL **without** the protocol prefix.","example":"example.com","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete WordPress backup temporary files","tags":["WordPressBackup","WordPress Manager Backups"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  WordPressBackup \\\n  cleanup \\\n  site='example.com/wordpress'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/WordPressBackup/cleanup?site=example.com%2fwordpress"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file WordPressBackup_cleanup.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/WordPressBackup_cleanup.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/WordPressBackup/,\n    q/cleanup/,\n    {\n        'site' => 'example.com/wordpress',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file WordPressBackup_cleanup.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/WordPressBackup_cleanup.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'WordPressBackup',\n    'cleanup',\n    array (\n        'site' => 'example.com/wordpress',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"WordPress Manager 3.0"}},"/WordPressBackup/get_available_backups":{"get":{"description":"This function retrieves a list of available WordPress® site backups of a single site.\n\n**Note:**\n\nYou **must** install the [WordPress Manager](https://go.cpanel.net/wordpressmanager) cPanel plugin to access this API function.","operationId":"get_available_backups","parameters":[{"description":"The WordPress site's URL **without** the protocol prefix.","in":"query","name":"site","required":true,"schema":{"example":"example.com/wordpress","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_available_backups","type":"string"},"module":{"description":"The name of the module called.","example":"WordPressBackup","type":"string"},"result":{"properties":{"data":{"properties":{"available":{"description":"An array of objects containing a list of the WordPress site's backups.","items":{"properties":{"date":{"description":"The date and time the system created the backup.","example":1539267197000,"format":"unix_timestamp","type":"integer"},"file":{"description":"The backup's file name with the `tar.zip` extension.","example":"example.com__2018-10-10T10:53:31-0500.tar.gz","type":"string"},"path":{"description":"The absolute path to the backup file.","example":"/home/example/wordpress-backups/example.com__2018-10-10T10:53:31-0500.tar.gz","type":"string"},"site":{"description":"The site's URL **without** the protocol prefix.","example":"example.com","type":"string"}},"type":"object"},"nullable":true,"type":"array"},"dir":{"description":"The absolute path to the backup directory.","example":"/home/example/wordpress-backups","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return WordPress site backups","tags":["WordPressBackup","WordPress Manager Backups"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  WordPressBackup \\\n  get_available_backups \\\n  site='example.com/wordpress'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/WordPressBackup/get_available_backups?site=example.com%2fwordpress"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file WordPressBackup_get_available_backups.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/WordPressBackup_get_available_backups.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/WordPressBackup/,\n    q/get_available_backups/,\n    {\n        'site' => 'example.com/wordpress',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file WordPressBackup_get_available_backups.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/WordPressBackup_get_available_backups.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'WordPressBackup',\n    'get_available_backups',\n    array (\n        'site' => 'example.com/wordpress',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"WordPress Manager 3.0"}},"/WordPressBackup/is_running":{"get":{"description":"This function checks for an active WordPress® site backup.\n\n**Note:**\n\nYou **must** install the [WordPress Manager](https://go.cpanel.net/wordpressmanager) cPanel plugin to access this API function.","operationId":"is_running","parameters":[{"description":"The WordPress site's URL **without** `http://`.","in":"query","name":"site","required":true,"schema":{"example":"example.com\n\nexample.com/wordpress","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"is_running","type":"string"},"module":{"description":"The name of the module called.","example":"WordPressBackup","type":"string"},"result":{"properties":{"data":{"properties":{"action_id":{"description":"The unique ID of the backup process.","example":"example.com__2018-10-10T10:53:31-0500","nullable":true,"type":"string"},"is_running":{"description":"Whether a backup is active.\n* `1` - Backup in progress.\n* `0` - No backup in progress.","enum":[0,1],"example":0,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return WordPress site backup status","tags":["WordPressBackup","WordPress Manager Backups"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  WordPressBackup \\\n  is_running \\\n  site='example.com\n\nexample.com/wordpress'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/WordPressBackup/is_running?site=example.com%0a%0aexample.com%2fwordpress"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file WordPressBackup_is_running.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/WordPressBackup_is_running.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/WordPressBackup/,\n    q/is_running/,\n    {\n        'site' => 'example.com\n\nexample.com/wordpress',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file WordPressBackup_is_running.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/WordPressBackup_is_running.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'WordPressBackup',\n    'is_running',\n    array (\n        'site' => 'example.com\n\nexample.com/wordpress',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"WordPress Manager 3.0"}},"/WordPressBackup/start":{"get":{"description":"This function starts a single WordPress® site backup.\n\n**Note:**\n\nYou **must** install the [WordPress Manager](https://go.cpanel.net/wordpressmanager) cPanel plugin to access this API function.","operationId":"start","parameters":[{"description":"The WordPress site's URL without the protocol prefix.","example":"example.com","in":"query","name":"site","required":true,"schema":{"anyOf":[{"example":"example.com/wordpress","format":"url-path"},{"example":"example.com","format":"domain"}],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"start","type":"string"},"module":{"description":"The name of the module called.","example":"WordPressBackup","type":"string"},"result":{"properties":{"data":{"properties":{"backup_id":{"description":"The unique ID of the backup process.","example":"example.com__2018-10-10T10:53:31-0500","type":"string"},"site":{"description":"The WordPress site's URL without the protocol prefix.","oneOf":[{"example":"example.com","format":"domain"},{"example":"example.com/wordpress","format":"url-path"}],"type":"string"},"sse_url":{"description":"The SSE path **without** the protocol, hostname, or port that the system uses to monitor the backup progress.","example":"/sse/WordPressBackup","format":"url-path","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Backup WordPress site","tags":["WordPressBackup","WordPress Manager Backups"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  WordPressBackup \\\n  start \\\n  site='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/WordPressBackup/start?site=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file WordPressBackup_start.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/WordPressBackup_start.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/WordPressBackup/,\n    q/start/,\n    {\n        'site' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file WordPressBackup_start.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/WordPressBackup_start.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'WordPressBackup',\n    'start',\n    array (\n        'site' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"WordPress Manager 3.0"}},"/WordPressInstanceManager/change_admin_password":{"get":{"description":"This function updates a WordPress® cPAddon instance's administrator password.\n\n**Note:**\n\n  You **must** install the [WordPress Manager](https://go.cpanel.net/wordpressmanager) cPanel plugin to access this API function.","operationId":"change_admin_password","parameters":[{"description":"The cPAddon instance's unique ID.\n\n**Note:**\n\n You can retrieve an instance ID with the `get_instances` function.","in":"query","name":"id","required":true,"schema":{"example":"cPanel__Blogs__WordPressX.0.1491917088","type":"string"}},{"description":"The cPAddon instance's new administrator password.","in":"query","name":"password","required":true,"schema":{"example":"luggage12345","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"change_admin_password","type":"string"},"module":{"description":"The name of the module called.","example":"WordPressInstanceManager","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update WordPress site admin password","tags":["WordPressInstanceManager","WordPress Manager Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  WordPressInstanceManager \\\n  change_admin_password \\\n  id='cPanel__Blogs__WordPressX.0.1491917088' \\\n  password='luggage12345'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/WordPressInstanceManager/change_admin_password?id=cPanel__Blogs__WordPressX.0.1491917088&password=luggage12345"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file WordPressInstanceManager_change_admin_password.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/WordPressInstanceManager_change_admin_password.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/WordPressInstanceManager/,\n    q/change_admin_password/,\n    {\n        'id' => 'cPanel__Blogs__WordPressX.0.1491917088',\n        'password' => 'luggage12345',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file WordPressInstanceManager_change_admin_password.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/WordPressInstanceManager_change_admin_password.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'WordPressInstanceManager',\n    'change_admin_password',\n    array (\n        'id' => 'cPanel__Blogs__WordPressX.0.1491917088',\n        'password' => 'luggage12345',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"WordPress Instance Manager 1.0"}},"/WordPressInstanceManager/cleanup_scan":{"get":{"description":"This function cleans up the scan log file after you complete a scan with the WordPressInstanceManager::start_scan function. To read more information about the complete scan process, read our UAPI Functions - WordPressInstanceManager::start_scan documentation.\n\n**Note:**\n\n  You **must** install the [WordPress Manager](https://go.cpanel.net/wordpressmanager) cPanel plugin to access this API function.","operationId":"cleanup_scan","parameters":[{"description":"The scan’s unique ID.","in":"query","name":"guid","required":true,"schema":{"example":"B3A27B96-51F7-11E8-92E3-CC90C4F823F0","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"cleanup_scan","type":"string"},"module":{"description":"The name of the module called.","example":"WordPressInstanceManager","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove scan log after completed scan","tags":["WordPressInstanceManager","WordPress Manager Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  WordPressInstanceManager \\\n  cleanup_scan \\\n  guid='B3A27B96-51F7-11E8-92E3-CC90C4F823F0'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/WordPressInstanceManager/cleanup_scan?guid=B3A27B96-51F7-11E8-92E3-CC90C4F823F0"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file WordPressInstanceManager_cleanup_scan.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/WordPressInstanceManager_cleanup_scan.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/WordPressInstanceManager/,\n    q/cleanup_scan/,\n    {\n        'guid' => 'B3A27B96-51F7-11E8-92E3-CC90C4F823F0',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file WordPressInstanceManager_cleanup_scan.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/WordPressInstanceManager_cleanup_scan.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'WordPressInstanceManager',\n    'cleanup_scan',\n    array (\n        'guid' => 'B3A27B96-51F7-11E8-92E3-CC90C4F823F0',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"WordPress Instance Manager 2.0"}},"/WordPressInstanceManager/configure_autoupdate":{"get":{"description":"This function configures a WordPress cPAddon instance's automatic updates settings. If you enable automatic updates for a legacy WordPress cPAddon instance, the function will convert it to use the RPM-based WordPress cPAddon.\n\n**Important:**\n\n  This function changes the instance's automatic update setting in the `wp-config.php` file. Before you run this function, you should verify that a filter does **not** exist for the automatic update settings. Use the `get_instance_by_id` function and view the `autoupdate.core.has_filter` return to determine if a filter exists.\n\n**Note:**\n\n  You **must** install the [WordPress Manager](https://go.cpanel.net/wordpressmanager) cPanel plugin to access this API function.","operationId":"configure_autoupdate","parameters":[{"description":"The cPAddon instance's unique ID.\n\n**Note:**\n\n You can retrieve an instance ID with the `get_instances` function.","in":"query","name":"id","required":true,"schema":{"example":"cPanel__Blogs__WordPressX.0.1491917088","type":"string"}},{"description":"Whether to enable automatic updates for major releases.\n* `1` - Enable.\n* `0` - Disable.","in":"query","name":"autoupdate.core.major","required":true,"schema":{"enum":[0,1],"example":0,"type":"integer"}},{"description":"Whether to enable automatic updates for minor releases.\n* `1` - Enable.\n* `0` - Disable.","in":"query","name":"autoupdate.core.minor","required":true,"schema":{"enum":[0,1],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"configure_autoupdate","type":"string"},"module":{"description":"The name of the module called.","example":"WordPressInstanceManager","type":"string"},"result":{"properties":{"data":{"properties":{"after":{"description":"An object that contains the instance's information after conversion.","properties":{"addon_config":{"description":"The WordPress instance's configuration file location.","example":"/home/example/.cpaddons/cPanel::Blogs::WordPressX.0.yaml","format":"path","type":"string"},"addon_name":{"description":"The converted instance's cPAddon name.\n\n**Note:**\n\n`cPanel::Blogs::WordPressX` is the only possible value.","enum":["cPanel::Blogs::WordPressX"],"example":"cPanel::Blogs::WordPressX","type":"string"},"addon_type":{"description":"The converted instance's cPAddon type.\n\n**Note:**\n\n`modern` is the only possible value.","enum":["modern"],"example":"modern","type":"string"},"admin_url":{"description":"The converted instance's administrator login URL.","example":"example.com/wordpress-41/wp-login.php","format":"url-path","type":"string"},"admin_username":{"description":"The instance's administrator username.","example":"wpadmin","type":"string"},"available_version":{"description":"The latest WordPress version.","example":"4.9.1","type":"string"},"current_version":{"description":"The WordPress instance's installed version.","example":"4.9.1","type":"string"},"db_name":{"description":"The converted instance's database name.","example":"example_wp1","type":"string"},"db_prefix":{"description":"The converted instance's database prefix.","example":"example","type":"string"},"db_server":{"description":"The converted instance's database server network path.","example":"localhost","type":"string"},"db_type":{"description":"The converted instance's database type.","example":"mysql","type":"string"},"db_username":{"description":"The converted instance's database username.","example":"example_wp1","type":"string"},"domain":{"description":"The converted instance's domain name.","example":"example.com","format":"domain","type":"string"},"full_path":{"description":"The instance's full installation path.","example":"/home/example/public_html/wordpress-41","format":"path","type":"string"},"homedir":{"description":"The cPanel account's home directory.","example":"/home/example","format":"path","type":"string"},"id":{"description":"The converted instance's unique ID.","example":"cPanel__Blogs__WordPress.1.1509732223","type":"string"},"initial_install_version":{"description":"The instance's original installation version.","example":"4.1","type":"string"},"migrated_from":{"description":"The instance's original installation cPAddon name.","example":"cPanel::Blogs::WordPress","type":"string"},"migrated_on":{"description":"The time the system converted the instance.","example":1513965986,"format":"unix_timestamp","type":"integer"},"rel_path":{"description":"The relative file path to the converted instance's document root.","example":"wordpress-41","format":"path","type":"string"},"site_url":{"description":"The converted instance's URL.","example":"example.com/wordpress-41","format":"url-path","type":"string"}},"type":"object"},"before":{"description":"A object that contains the instance's information before conversion.","properties":{"addon_config":{"description":"The WordPress instance's configuration file location.","example":"/home/example/.cpaddons/cPanel::Blogs::WordPressX.0.yaml","format":"path","type":"string"},"addon_name":{"description":"The instance's cPAddon name.","example":"cPanel::Blogs::WordPress","type":"string"},"addon_type":{"description":"The instance's cPAddon type.\n\n**Note:**\n\n`legacy` is this only possible value.","enum":["legacy"],"example":"legacy","type":"string"},"admin_url":{"description":"The instance's administrator login URL.","example":"example.com/wordpress-41/wp-login.php","format":"url-path","type":"string"},"admin_username":{"description":"The instance's administrator username.","example":"wpadmin","type":"string"},"available_version":{"description":"The latest WordPress version.","example":"4.9.1","type":"string"},"current_version":{"description":"The WordPress instance's installed version.","example":"4.9.1","type":"string"},"db_name":{"description":"The instance's database name.","example":"example_wp1","type":"string"},"db_prefix":{"description":"The instance's database prefix.","example":"example","type":"string"},"db_server":{"description":"The instance's database server network path.","example":"localhost","type":"string"},"db_type":{"description":"The instance's database type.","example":"mysql","type":"string"},"db_username":{"description":"The instance's database username.","example":"example_wp1","type":"string"},"domain":{"description":"The instance's domain name.","example":"example.com","format":"domain","type":"string"},"full_path":{"description":"The instance's full installation path.","example":"/home/example/public_html/wordpress-41","format":"path","type":"string"},"homedir":{"description":"The cPanel account's home directory.","example":"/home/example","format":"path","type":"string"},"id":{"description":"The instance's unique ID.","example":"cPanel__Blogs__WordPress.1.1509732223","type":"string"},"initial_install_version":{"description":"The instance's original installation version.","example":"4.1","type":"string"},"rel_path":{"description":"The relative file path to the instance's document root.","example":"wordpress-41","format":"path","type":"string"},"site_url":{"description":"The instance's URL.","example":"example.com/wordpress-41","format":"url-path","type":"string"}},"type":"object"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update WordPress site automatic update settings","tags":["WordPressInstanceManager","WordPress Manager Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  WordPressInstanceManager \\\n  configure_autoupdate \\\n  id='cPanel__Blogs__WordPressX.0.1491917088' \\\n  autoupdate.core.major='0' \\\n  autoupdate.core.minor='0'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/WordPressInstanceManager/configure_autoupdate?id=cPanel__Blogs__WordPressX.0.1491917088&autoupdate.core.major=0&autoupdate.core.minor=0"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file WordPressInstanceManager_configure_autoupdate.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/WordPressInstanceManager_configure_autoupdate.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/WordPressInstanceManager/,\n    q/configure_autoupdate/,\n    {\n        'id' => 'cPanel__Blogs__WordPressX.0.1491917088',\n        'autoupdate.core.major' => '0',\n        'autoupdate.core.minor' => '0',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file WordPressInstanceManager_configure_autoupdate.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/WordPressInstanceManager_configure_autoupdate.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'WordPressInstanceManager',\n    'configure_autoupdate',\n    array (\n        'id' => 'cPanel__Blogs__WordPressX.0.1491917088',\n        'autoupdate.core.major' => '0',\n        'autoupdate.core.minor' => '0',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"WordPress Instance Manager 1.1"}},"/WordPressInstanceManager/get_api_version":{"get":{"description":"This function retrieves the WordPress Manager plugin's version.\n\n**Note:**\n\n  You **must** install the [WordPress Manager](https://go.cpanel.net/wordpressmanager) cPanel plugin to access this API function.","operationId":"get_api_version","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_api_version","type":"string"},"module":{"description":"The name of the module called.","example":"WordPressInstanceManager","type":"string"},"result":{"properties":{"data":{"properties":{"version":{"description":"The WordPress Manager plugin’s version.","example":"1.0.1-0","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return WordPress Manager plugin version","tags":["WordPressInstanceManager","WordPress Manager Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  WordPressInstanceManager \\\n  get_api_version\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/WordPressInstanceManager/get_api_version"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file WordPressInstanceManager_get_api_version.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/WordPressInstanceManager_get_api_version.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/WordPressInstanceManager/,\n    q/get_api_version/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file WordPressInstanceManager_get_api_version.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/WordPressInstanceManager_get_api_version.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'WordPressInstanceManager',\n    'get_api_version'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"WordPress Instance Manager 1.1"}},"/WordPressInstanceManager/get_instances":{"get":{"description":"This function lists an account's WordPress® instances.\n\n**Note:**\n\n* You **must** install the [WordPress Manager](https://go.cpanel.net/wordpressmanager) cPanel plugin to access this API function.\n* This function retrieves data that the system stored during the WordPress installation. That data may not reflect the most recent user changes.","operationId":"get_instances","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_instances","type":"string"},"module":{"description":"The name of the module called.","example":"WordPressInstanceManager","type":"string"},"result":{"properties":{"data":{"properties":{"errors":{"description":"This array contains the errors that the system experienced while it retrieved the instances.","items":{"type":"string"},"type":"array"},"instances":{"description":"This array of objects contains the WordPress instance information.","items":{"properties":{"addon_config":{"description":"The WordPress instance's configuration file location.","example":"/home/example/.cpaddons/cPanel::Blogs::WordPressX.0.yaml","format":"path","type":"string"},"addon_name":{"description":"The WordPress cPAddon that installed the instance.\n* `cPanel::Blogs::WordPress`\n* `cPanel::Blogs::WordPressX`\n* `cPanel::Blogs::WordPressUnmanaged`","enum":["cPanel::Blogs::WordPress","cPanel::Blogs::WordPressX","cPanel::Blogs::WordPressUnmanaged"],"example":"cPanel::Blogs::WordPressX","type":"string"},"addon_type":{"description":"The WordPress instance's installation method.\n* `modern` — Installed by RPM-managed WordPress cPAddon.\n* `legacy` — Installed by legacy cPAddon.\n* `unmanaged` — Installed by third-party tool or the WordPress installer.","enum":["modern","legacy","unmanaged"],"example":"modern","type":"string"},"admin_url":{"description":"The URL to the instance's administration interface.","example":"example.com/wp-login.php","format":"url-path","type":"string"},"admin_username":{"description":"The administrator username the installer created at the time of installation.","example":"admin","type":"string"},"available_version":{"description":"This return is unused.","example":null,"nullable":true,"type":"string"},"created_on":{"description":"The WordPress instance's installation date.","example":1528208546,"format":"unix_timestamp","type":"integer"},"current_version":{"description":"This return is unused.","example":null,"nullable":true,"type":"string"},"db_name":{"description":"The WordPress instance's database name.","example":"example_wp","type":"string"},"db_prefix":{"description":"The WordPress instance's database prefix.","example":"wp","type":"string"},"db_server":{"description":"The WordPress instance's database server hostname.","example":"localhost","type":"string"},"db_type":{"description":"The WordPress instance's database type.\n\n**Note**\n`mysql` is the only possible value.","enum":["mysql"],"example":"mysql","type":"string"},"db_username":{"description":"The WordPress instance's database username.","example":"example_wp","type":"string"},"domain":{"description":"The WordPress instance's domain.","example":"example.com","format":"domain","type":"string"},"full_path":{"description":"The WordPress instance's full installation path.","example":"/home/example/public_html","format":"path","type":"string"},"homedir":{"description":"The cPanel account's home directory.","example":"/home/example","format":"path","type":"string"},"id":{"description":"The WordPress instance's unique identifier.","example":"cPanel__Blogs__WordPressX.0.1528208546","type":"string"},"import_guid":{"description":"The imported WordPress instance's unique identifier.","example":"8AF1767E-68CD-11E8-90D1-96B06D626D05","type":"string"},"imported_on":{"description":"The WordPress instance's import date.","example":1528209264,"format":"unix_timestamp","type":"integer"},"initial_install_version":{"description":"The WordPress instance's version number at installation.","example":"4.9.6","type":"string"},"migrated_from":{"description":"The cPAddon that the system migrated the instance from.","example":"cPanel::Blogs::WordPress","type":"string"},"migrated_on":{"description":"The timestamp when the system migrated the instance from legacy to modern WordPress cPAddon.","example":1528209264,"format":"unix_timestamp","type":"integer"},"recent":{"description":"Whether the system added the WordPress instance in the last 24 hours.\n* `1` — Added recently.\n* `0` — Added previously.","enum":[0,1],"example":1,"type":"integer"},"rel_path":{"description":"The WordPress instance's installation path.\n\n**Note**\nThis function returns an empty value if the relative path is the document root.","example":" ","format":"path","type":"string"},"site_url":{"description":"The WordPress instance's home page URL.","example":"example.com","format":"url-path","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` — Success.\n- `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return WordPress sites","tags":["WordPressInstanceManager","WordPress Manager Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  WordPressInstanceManager \\\n  get_instances\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/WordPressInstanceManager/get_instances"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file WordPressInstanceManager_get_instances.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/WordPressInstanceManager_get_instances.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/WordPressInstanceManager/,\n    q/get_instances/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file WordPressInstanceManager_get_instances.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/WordPressInstanceManager_get_instances.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'WordPressInstanceManager',\n    'get_instances'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"WordPress Instance Manager 1.0"}},"/WordPressInstanceManager/get_latest_wordpress_version_from_wordpress_org":{"get":{"description":"This function returns the available WordPress® updates from wordpress.org.\n\n**Note:**\n\n  You **must** install the [WordPress Manager](https://go.cpanel.net/wordpressmanager) cPanel plugin to access this API function.","operationId":"get_latest_wordpress_version_from_wordpress_org","parameters":[{"description":"Whether to force a reload from the remote API. Otherwise, the\nfunction returns information stored in local cache.\n* `1` — Force reload\n* `0` — Read local cashe.","in":"query","name":"force","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"The length of time in seconds to cache the database between requests to wordpress.org.","in":"query","name":"cache_time","required":false,"schema":{"default":86400,"example":3600,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_latest_wordpress_version_from_wordpress_org","type":"string"},"module":{"description":"The name of the module called.","example":"WordPressInstanceManager","type":"string"},"result":{"properties":{"data":{"properties":{"offers":{"description":"This array contains the returned value from [wordpress.org's](https://wordpress.org/) Version Check API.\n\n**Note:**\n\n For additional information about the returned values, read [WordPress's Version Check API](https://codex.wordpress.org/WordPress.org_API) documentation.","items":{"properties":{"current":{},"download":{},"locale":{},"mysql_version":{},"new_bundled":{},"packages":{"properties":{"full":{},"new_bundled":{},"no_content":{},"partial":{},"rollback":{}},"type":"object"},"partial_version":{},"php_version":{},"response":{},"version":{}},"type":"object"},"type":"array"},"translations":{"items":{"type":"string"},"type":"array"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return latest wordpress.org updates","tags":["WordPressInstanceManager","WordPress Manager Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  WordPressInstanceManager \\\n  get_latest_wordpress_version_from_wordpress_org\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/WordPressInstanceManager/get_latest_wordpress_version_from_wordpress_org"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file WordPressInstanceManager_get_latest_wordpress_version_from_wordpress_org.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/WordPressInstanceManager_get_latest_wordpress_version_from_wordpress_org.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/WordPressInstanceManager/,\n    q/get_latest_wordpress_version_from_wordpress_org/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file WordPressInstanceManager_get_latest_wordpress_version_from_wordpress_org.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/WordPressInstanceManager_get_latest_wordpress_version_from_wordpress_org.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'WordPressInstanceManager',\n    'get_latest_wordpress_version_from_wordpress_org'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"Word Press Instance Manager 1.0"}},"/WordPressInstanceManager/get_instance_by_id":{"get":{"description":"This function retrieves a WordPress® instance's configuration.\n\n**Note:**\n\n* You **must** install the [WordPress Manager](https://go.cpanel.net/wordpressmanager) cPanel plugin to access this API function.\n* This function retrieves some data that the system stored during the WordPress installation. That data may not reflect the most recent user changes.","operationId":"get_instance_by_id","parameters":[{"description":"The WordPress instance's unique ID.\n\n**Note:**\n\n You can retrieve an instance ID with the `get_instances` function.","in":"query","name":"id","required":true,"schema":{"example":"cPanel__Blogs__WordPressX.0.1528208546","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_instance_by_id","type":"string"},"module":{"description":"The name of the module called.","example":"WordPressInstanceManager","type":"string"},"result":{"properties":{"data":{"properties":{"addon_config":{"description":"The WordPress instance's configureation absolute file path location.","example":"/home/example/.cpaddons/cPanel::Blogs::WordPressX.0.yaml","format":"path","type":"string"},"addon_name":{"description":"The WordPress cPAddon used to install the instance.\n* `cPanel::Blogs::WordPress`\n* `cPanel::Blogs::WordPressX`\n* `cPanel::Blogs::WordPressUnmanaged`","enum":["cPanel::Blogs::WordPress","cPanel::Blogs::WordPressX","cPanel::Blogs::WordPressUnmanaged"],"example":"cPanel::Blogs::WordPressX","type":"string"},"addon_type":{"description":"The WordPress instance's installation method.\n* `modern` — Installed by RPM-managed WordPress cPAddon.\n* `legacy` — Installed by legacy cPAddon.\n* `unmanaged` — Installed by third-party tool or the WordPress installer.","enum":["modern","legacy","unmanaged"],"example":"modern","type":"string"},"admin_url":{"description":"The URL to the instance's administration interface.","example":"example.com/wp-login.php","format":"url-path","type":"string"},"admin_username":{"description":"The administrator username configured at the time of installation.","example":"admin","type":"string"},"admins":{"description":"A list of the WordPress instance's administrators.","items":{"properties":{"ID":{"description":"The user's automatically generated identifier.","example":1,"minimum":1,"type":"integer"},"display_name":{"description":"The user's display name.","example":"admin","type":"string"},"user_email":{"description":"The user's email address.","example":"admin@example.com","format":"email","type":"string"},"user_login":{"description":"The user's login name.","example":"admin","type":"string"},"user_nicename":{"description":"The user's simplified username, which you can use as an HTML ID or similar.","example":"admin","type":"string"},"user_status":{"description":"The user's verified status.\n* `1` — Verified.\n* `0` — Unverified.","enum":[0,1],"example":0,"type":"integer"}},"type":"object"},"type":"array"},"autoupdate":{"description":"Whether the user enabled automatic updates.\n* `true` — Enabled.\n* `false` — Disabled.","example":true,"type":"boolean"},"autoupdate.core.has_filter":{"description":"Whether one of more filters modify the core autoupdate settings.\n* `true` — Filter(s) applied.\n* `false` — No filters applied.\n\n**Note**\n\nTypically, plugins apply filters to the autoupdate settings.","example":false,"type":"boolean"},"autoupdate.core.major":{"description":"Whether the user enabled automatic updates for major releases.\n* `true` — Enabled.\n* `false` — Disabled.","example":false,"type":"boolean"},"autoupdate.core.minor":{"description":"Whether the user enabled automatic updates for minor releases.\n* `true` — Enabled.\n* `false` — Disabled.","example":true,"type":"boolean"},"available_version":{"description":"The lastest WordPress instance's version.","example":"4.9.6","type":"string"},"created_on":{"description":"The WordPress instance's installation date.","example":1528208546,"format":"unix_timestamp","type":"integer"},"current_version":{"description":"The WordPress instance's version.","example":"4.9.5","type":"string"},"db_name":{"description":"A database name.","example":"example_wp2","type":"string"},"db_prefix":{"description":"A database table prefix.","example":"wp","type":"string"},"db_server":{"description":"The WordPress instance's database server hostname.","example":"localhost","type":"string"},"db_type":{"description":"The WordPress instance's database type.","enum":["mysql"],"example":"mysql","type":"string"},"db_username":{"description":"The WordPress instance's database username.","example":"example_wp","type":"string"},"domain":{"description":"The WordPress instance's installation domain.","example":"example.com","format":"domain","type":"string"},"full_path":{"description":"The WordPress instance's full installation absolute filepath.","example":"/home/example/public_html","format":"path","type":"string"},"homedir":{"description":"The cPanel account's home directory.","example":"/home/example","format":"path","type":"string"},"id":{"description":"The WordPress instance's unique identifier.","example":"cPanel__Blogs__WordPressX.0.1528208546","type":"string"},"initial_install_version":{"description":"The WordPress instance's version at installation.","example":"4.7.2","type":"string"},"recent":{"description":"Whether the system added the WordPress instance in the last 24 hours.\n* `1` — Added recently.\n* `0` — Added previously.","enum":[0,1],"example":1,"type":"integer"},"rel_path":{"description":"The WordPress instance's installation path, relative to the damin's document root.\n\n**Note:**\n\nThis function returns an empty value if the relative path is the document root.","example":" ","format":"path","type":"string"},"site_url":{"description":"The WordPress instance's home page URL.","example":"example.com/wordpress","format":"url-path","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` — Success.\n- `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return WordPress site settings","tags":["WordPressInstanceManager","WordPress Manager Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  WordPressInstanceManager \\\n  get_instance_by_id \\\n  id='cPanel__Blogs__WordPressX.0.1528208546'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/WordPressInstanceManager/get_instance_by_id?id=cPanel__Blogs__WordPressX.0.1528208546"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file WordPressInstanceManager_get_instance_by_id.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/WordPressInstanceManager_get_instance_by_id.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/WordPressInstanceManager/,\n    q/get_instance_by_id/,\n    {\n        'id' => 'cPanel__Blogs__WordPressX.0.1528208546',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file WordPressInstanceManager_get_instance_by_id.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/WordPressInstanceManager_get_instance_by_id.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'WordPressInstanceManager',\n    'get_instance_by_id',\n    array (\n        'id' => 'cPanel__Blogs__WordPressX.0.1528208546',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"WordPress Instance Manager 1.0"}},"/WordPressInstanceManager/get_scan_results":{"get":{"description":"This function checks the status of a completed scan and reports the results. To find more information about the scan process, read our UAPI documentation for `WordPressInstanceManager::start_scan`.\n\n**Note:**\n\n  You **must** install the [WordPress Manager](https://go.cpanel.net/wordpressmanager) cPanel plugin to access this API function.","operationId":"get_scan_results","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_scan_results","type":"string"},"module":{"description":"The name of the module called.","example":"WordPressInstanceManager","type":"string"},"result":{"properties":{"data":{"properties":{"instances":{"description":"An array of objects that contains the WordPress instance information.","items":{"properties":{"addon_config":{"description":"The WordPress instance's configuration file location.","example":"/home/example/.cpaddons/cPanel::Blogs::WordPressX.0.yaml","type":"string"},"addon_name":{"description":"The WordPress cPAddon that installed the instance.\n* `cPanel::Blogs::WordPress`\n* `cPanel::Blogs::WordPressX`\n* `cPanel::Blogs::WordPressUnmanaged`","enum":["cPanel::Blogs::WordPress","cPanel::Blogs::WordPressX","cPanel::Blogs::WordPressUnmanaged"],"example":"cPanel::Blogs::WordPressX","type":"string"},"addon_type":{"description":"The WordPress instance's installation method.\n* `modern` — Installed by RPM-managed WordPress cPAddon.\n* `legacy` — Installed by legacy cPAddon.\n* `unmanaged` — Installed by third-party tool or the WordPress installer.","enum":["modern","legacy","unmanaged"],"example":"modern","type":"string"},"admin_url":{"description":"The URL to the instance's administration interface.","example":"example.com/wp-login.php","format":"url-path","type":"string"},"admin_username":{"description":"The administrator username the installer created at the time of installation.","example":"admin","type":"string"},"available_version":{"description":"The latest Wordpress's version.","example":"4.9.5","type":"string"},"current_version":{"description":"The WordPress instance's installed version.","example":"4.9.5","type":"string"},"db_name":{"description":"The WordPress instance's database name.","example":"example_wp","type":"string"},"db_prefix":{"description":"The WordPress instance's database prefix.","example":"wp","type":"string"},"db_server":{"description":"The WordPress instance's database server hostname.","example":"localhost","type":"string"},"db_type":{"description":"The WordPress instance's database type.\n* `mysql`\n* `postgres`","enum":["mysql","postgres"],"example":"mysql","type":"string"},"db_username":{"description":"The WordPress instance's database username.","example":"example_wp","type":"string"},"domain":{"description":"The WordPress instance's domain.","example":"example.com","format":"domain","type":"string"},"full_path":{"description":"The WordPress instance's full installation path.","example":"/home/example/public_html","format":"path","type":"string"},"homedir":{"description":"The cPanel account's home directory.","example":"/home/example","format":"path","type":"string"},"id":{"description":"The WordPress instance's unique identifier.","example":"cPanel__Blogs__WordPressX.0.1528208546","type":"string"},"initial_install_version":{"description":"The WordPress instance's version number at installation.","example":"4.9.6","type":"string"},"rel_path":{"description":"The WordPress instance's installation path relative to the domain's document root.","example":"public_html","format":"path","type":"string"},"site_url":{"description":"The WordPress instance's home page URL.","example":"example.com","format":"url-path","type":"string"}},"type":"object"},"type":"array"},"is_running":{"description":"Whether the system detects an active scan.\n\n* `1` - A scan is active.\n* `0` - No scans are active.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return WordPress site scan results","tags":["WordPressInstanceManager","WordPress Manager Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  WordPressInstanceManager \\\n  get_scan_results\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/WordPressInstanceManager/get_scan_results"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file WordPressInstanceManager_get_scan_results.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/WordPressInstanceManager_get_scan_results.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/WordPressInstanceManager/,\n    q/get_scan_results/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file WordPressInstanceManager_get_scan_results.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/WordPressInstanceManager_get_scan_results.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'WordPressInstanceManager',\n    'get_scan_results'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"WordPress Instance Manager 2.0"}},"/WordPressInstanceManager/is_installable_addon_available":{"get":{"description":"This function verifies that the RPM-based WordPress® cPAddon exists on the system.\n\n**Note:**\n\n  You must install the WordPress Manager cPanel plugin to access this API function.","operationId":"is_installable_addon_available","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"is_installable_addon_available","type":"string"},"module":{"description":"The name of the module called.","example":"WordPressInstanceManager","type":"string"},"result":{"properties":{"data":{"description":"Whether the RPM-based WordPress cPAddon exists on the server.\n* `1` - Exists.\n* `0` - Does **not** exist.","enum":[0,1],"example":1,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Verify WordPress cPAddon availability","tags":["WordPressInstanceManager","WordPress Manager Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  WordPressInstanceManager \\\n  is_installable_addon_available\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/WordPressInstanceManager/is_installable_addon_available"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file WordPressInstanceManager_is_installable_addon_available.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/WordPressInstanceManager_is_installable_addon_available.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/WordPressInstanceManager/,\n    q/is_installable_addon_available/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file WordPressInstanceManager_is_installable_addon_available.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/WordPressInstanceManager_is_installable_addon_available.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'WordPressInstanceManager',\n    'is_installable_addon_available'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"WordPress Instance Manager 1.1.1"}},"/WordPressInstanceManager/start_scan":{"get":{"description":"This function scans for WordPress® instances installed on a cPanel account. The system will populate cPanel's WordPress Manager interface with any newly discovered instances.\n\n**Note:**\n\nYou **must** install the [WordPress Manager](https://go.cpanel.net/wordpressmanager) cPanel plugin to access this API function.\n\n### Server Sent Events (SSE)\n\nThis function uses the following SSE events:\n\n* `register` — The scan operation discovered a WordPress instance and registered it. The data is a\nJSON-encoded object containing the attributes of the instance, with the same format used in the\nUAPI `get_instances` and UAPI `get_instance_by_id` functions.\n* `found` — The scan operation found a WordPress instance. If the WordPress instance is newly\ndiscovered, the system will also generate a `register` event for the instance. The data is a\nJSON-encoded object containing the following:\n  * `path` — The absolute file path to the instance.\n* `done` — The scan is finished. The data is a JSON-encoded object that contains:\n  * `found` — An array of strings that represents the absolute path to the discovered instances and\n  any instances that the system already registered.\n  * `converted` — An array of converted instances that the system returns in the same format\n  provided in the UAPI `get_instances` and UAPI `get_instance_by_id` functions.\n* `terminated` — The system or user terminated the scan.\t\n* `timedout` — The scan timed out before it completed.\n* `register-failed` — The system failed to build the instance registry.\tThe data is a JSON-encoded\nstring that contains the error message.\n* `register-load-failed` — The system could not load the registry after building the instance\nregistry. The data is a JSON-encoded string that contains the error message.\n\nFor more information about server sent events, read Mozilla's [Using server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events) documentation.","operationId":"WordPressInstanceManager-start_scan","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"start_scan","type":"string"},"module":{"description":"The name of the module called.","example":"WordPressInstanceManager","type":"string"},"result":{"properties":{"data":{"properties":{"guid":{"description":"The unique identifier for the scan. A valid string.","example":"B3A27B96-51F7-11E8-92E3-CC90C4F823F0","type":"string"},"log":{"description":"The absolute path to the log file for the scan.","example":"/home/example/.cpanel/plugins/wordpress/scans/B3A27B96-51F7-11E8-92E3-CC90C4F823F0","format":"path","type":"string"},"sse_url":{"description":"The SSE interface that other applications can use to track the progress of the scan.\n\n**Note:**\n\nFor more information about the SSE interface, read the [Server Sent Events](#server-sent-events-sse) section.","example":"/sse/WordPressScan/B3A27B96-51F7-11E8-92E3-CC90C4F823F0","format":"url-path","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` - Success\n- `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Start WordPress sites scan","tags":["WordPressInstanceManager","WordPress Manager Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  WordPressInstanceManager \\\n  start_scan\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/WordPressInstanceManager/start_scan"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file WordPressInstanceManager_start_scan.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/WordPressInstanceManager_start_scan.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/WordPressInstanceManager/,\n    q/start_scan/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file WordPressInstanceManager_start_scan.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/WordPressInstanceManager_start_scan.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'WordPressInstanceManager',\n    'start_scan'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"WordPress Instance Manager 2.0"}},"/WordPressInstanceManager/cancel_scan":{"get":{"description":"This function cancels a scan that you start with the `WordPressInstanceManager::start_scan` function.\n\n**Note:**\n\n  You **must** install the [WordPress Manager](https://go.cpanel.net/wordpressmanager) cPanel plugin to access this API function.","operationId":"cancel_scan","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"cancel_scan","type":"string"},"module":{"description":"The name of the module called.","example":"WordPressInstanceManager","type":"string"},"result":{"properties":{"data":{"description":"Whether the system cancelled the scan.\n\n* `1` - Cancelled.\n* `0` - **Not** cancelled.","enum":[0,1],"example":0,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Stop WordPress site scan","tags":["WordPressInstanceManager","WordPress Manager Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  WordPressInstanceManager \\\n  cancel_scan\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/WordPressInstanceManager/cancel_scan"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file WordPressInstanceManager_cancel_scan.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/WordPressInstanceManager_cancel_scan.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/WordPressInstanceManager/,\n    q/cancel_scan/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file WordPressInstanceManager_cancel_scan.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/WordPressInstanceManager_cancel_scan.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'WordPressInstanceManager',\n    'cancel_scan'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"WordPress Instance Manager 2.0"}},"/WordPressRestore/start":{"get":{"description":"This function starts a single WordPress® site backup restoration.\n\n**Note:**\n\nYou **must** install the [WordPress Manager](https://go.cpanel.net/wordpressmanager) cPanel plugin to access this API function.","operationId":"WordPressRestore-start","parameters":[{"description":"The WordPress site's URL to restore.","examples":{"single-domain":{"summary":"Just a domain.","value":"example.com"},"single-path":{"summary":"Domain with path.","value":"example.com/wordpress"}},"in":"query","name":"site","required":true,"schema":{"type":"string"}},{"description":"The file path to the backup archive.","in":"query","name":"backup_path","required":true,"schema":{"example":"/home/example/wordpress-backups/example.com__2018-11-13T11:11:31-0600.tar.gz","format":"path","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"start","type":"string"},"module":{"description":"The name of the module called.","example":"WordPressRestore","type":"string"},"result":{"properties":{"data":{"properties":{"restore_id":{"description":"The unique identifier for the restoration operation. The name of the backup file without the file extension.","example":"example.com__2018-11-15T08:03:22-0600","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Restore WordPress site","tags":["WordPressRestore","WordPress Manager Backups"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  WordPressRestore \\\n  start \\\n  site='example.com' \\\n  backup_path='/home/example/wordpress-backups/example.com__2018-11-13T11:11:31-0600.tar.gz'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/WordPressRestore/start?site=example.com&backup_path=%2fhome%2fexample%2fwordpress-backups%2fexample.com__2018-11-13T11%3a11%3a31-0600.tar.gz"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file WordPressRestore_start.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/WordPressRestore_start.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/WordPressRestore/,\n    q/start/,\n    {\n        'site' => 'example.com',\n        'backup_path' => '/home/example/wordpress-backups/example.com__2018-11-13T11:11:31-0600.tar.gz',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file WordPressRestore_start.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/WordPressRestore_start.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'WordPressRestore',\n    'start',\n    array (\n        'site' => 'example.com',\n        'backup_path' => '/home/example/wordpress-backups/example.com__2018-11-13T11:11:31-0600.tar.gz',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"WordPress Manager 3.0"}},"/WordPressRestore/any_running":{"get":{"description":"This function returns whether a WordPress® site backup restoration is in progress.\n\n**Note:**\n\n* You **must** install the [WordPress Manager](https://go.cpanel.net/wordpressmanager) cPanel plugin to access this API function.\n* The output of this function changes, depending on the state of the backup restoration.","operationId":"WordPressRestore::any_running","parameters":[],"responses":{"200":{"content":{"application/json":{"examples":{"InProgress":{"summary":"Example output of a backup restore in progress.","value":{"data":{"any_running":1,"sites":[{"id":null,"site":"example.com","type":"restore"}]},"errors":null,"messages":null,"metadata":{},"status":1,"warnings":null}},"NotInProgress":{"summary":"Example output of a backup restore not in progress.","value":{"data":{"any_running":0,"last_outcome":{"error":"","have_outcome":1,"site":"example.com","status":"success"},"sites":[]},"errors":null,"messages":null,"metadata":{},"status":1,"warnings":null}}},"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"any_running","type":"string"},"module":{"description":"The name of the module called.","example":"WordPressRestore","type":"string"},"result":{"properties":{"data":{"properties":{"items":{"oneOf":[{"$ref":"#/components/schemas/RestoreInProgress"},{"$ref":"#/components/schemas/RestoreNotInProgress"}]}}},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success.\n- 0 - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return WordPress site restore status","tags":["WordPressRestore","WordPress Manager Backups"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  WordPressRestore \\\n  any_running\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/WordPressRestore/any_running"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file WordPressRestore_any_running.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/WordPressRestore_any_running.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/WordPressRestore/,\n    q/any_running/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file WordPressRestore_any_running.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/WordPressRestore_any_running.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'WordPressRestore',\n    'any_running'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"WordPress Manager 3.0"}},"/WordPressRestore/cleanup":{"get":{"description":"This function cleans up any temporary system resources after a WordPress® site backup restoration.\n\n**Note:**\n\nYou **must** install the [WordPress Manager](https://go.cpanel.net/wordpressmanager) cPanel plugin to access this API function.","operationId":"WordPressRestore-cleanup","parameters":[{"description":"The WordPress site's URL **without** the protocol prefix.","examples":{"single-domain":{"summary":"Just a domain.","value":"example.com"},"single-path":{"summary":"Domain with path.","value":"example.com/wordpress"}},"in":"query","name":"site","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"cleanup","type":"string"},"module":{"description":"The name of the module called.","example":"WordPressRestore","type":"string"},"result":{"properties":{"data":{"description":"Whether the system cleaned up the temporary system resources.\n* `1` - Successful.\n* `0` - Unsuccessful.","enum":[0,1],"example":1,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete restored WordPress site's temporary files","tags":["WordPressRestore","WordPress Manager Backups"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  WordPressRestore \\\n  cleanup \\\n  site='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/WordPressRestore/cleanup?site=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file WordPressRestore_cleanup.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/WordPressRestore_cleanup.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/WordPressRestore/,\n    q/cleanup/,\n    {\n        'site' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file WordPressRestore_cleanup.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/WordPressRestore_cleanup.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'WordPressRestore',\n    'cleanup',\n    array (\n        'site' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"WordPress Manager 3.0"}},"/cPAddons/get_available_addons":{"get":{"description":"This function lists an account's available cPAddons.","operationId":"get_available_addons","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_available_addons","type":"string"},"module":{"description":"The name of the module called.","example":"cPAddons","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"description":{"description":"The cPAddon's name.","example":"WordPress (cPanel)","type":"string"},"module":{"description":"The module's name.","example":"cPanel::Blogs::WordPress","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* 1 — Success.\n* 0 — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return available cPAddons","tags":["cPAddons","cPanel Addons (cPAddons)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  cPAddons \\\n  get_available_addons\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/cPAddons/get_available_addons"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file cPAddons_get_available_addons.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/cPAddons_get_available_addons.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/cPAddons/,\n    q/get_available_addons/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file cPAddons_get_available_addons.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/cPAddons_get_available_addons.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'cPAddons',\n    'get_available_addons'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.52"}},"/cPAddons/get_instance_settings":{"get":{"description":"This function lists a cPAddons instance's settings.","operationId":"get_instance_settings","parameters":[{"description":"The unique identifier of the cPAddon.\n\n**Note:**\n\nTo find this identifier, run the `list_addon_instances` function.","in":"query","name":"unique_id","required":true,"schema":{"example":"cPanel::Blogs::WordPressX.0.1486754861","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_instance_settings","type":"string"},"module":{"description":"The name of the module called.","example":"cPAddons","type":"string"},"result":{"properties":{"data":{"properties":{"addon":{"description":"The name of the cPAddon in double colon-delimited form.","example":"cPanel::Blogs::WordPressX","type":"string"},"admin_user":{"description":"The administrative user for the cPAddon instance.","type":"string"},"autoupdate":{"description":"Whether the system processes automatic updates for the cPAddon instance.\n* `1` - Automatic updates enabled.\n* `0` - Automatic updates disabled.","enum":[0,1],"example":0,"type":"integer"},"db_name":{"description":"The cPAddon instance's database name.","example":"example_wp","type":"string"},"db_type":{"description":"The cPAddon instance's database type.","enum":["mysql","postgre"],"example":"mysql","type":"string"},"db_user":{"description":"The cPAddon instance's database user.","example":"example_wp","type":"string"},"domain":{"description":"The domain on which the instance is installed.","example":"example.com","format":"domain","type":"string"},"installdir":{"description":"The full path of the directory in which the system deployed the cPAddon.","example":"/home/example/public_html/wordpress","type":"string"},"url_to_install":{"description":"The URL to access the cPAddon instance.","example":"http://example.com/wordpress/","format":"url","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return deployed cPAddons instance's settings","tags":["cPAddons","cPanel Addons (cPAddons)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  cPAddons \\\n  get_instance_settings \\\n  unique_id='cPanel::Blogs::WordPressX.0.1486754861'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/cPAddons/get_instance_settings?unique_id=cPanel%3a%3aBlogs%3a%3aWordPressX.0.1486754861"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file cPAddons_get_instance_settings.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/cPAddons_get_instance_settings.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/cPAddons/,\n    q/get_instance_settings/,\n    {\n        'unique_id' => 'cPanel::Blogs::WordPressX.0.1486754861',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file cPAddons_get_instance_settings.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/cPAddons_get_instance_settings.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'cPAddons',\n    'get_instance_settings',\n    array (\n        'unique_id' => 'cPanel::Blogs::WordPressX.0.1486754861',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 64"}},"/cPAddons/list_addon_instances":{"get":{"description":"This function lists an account's deployed cPAddons instances.","operationId":"list_addon_instances","parameters":[{"description":"The cPAddon for which to return the instances data.","in":"query","name":"addon","required":false,"schema":{"example":"cPanel::Blogs::WordPressX","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_addon_instances","type":"string"},"module":{"description":"The name of the module called.","example":"cPAddons","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"addon":{"description":"The name of the cPAddon in double colon-delimited form.","example":"cPanel::Blogs::WordPressX","type":"string"},"domain":{"description":"The domain on which the instance is installed.","example":"example.com","type":"string"},"installdir":{"description":"The full path of the directory in which the system deployed the cPAddon.","example":"/home/example/public_html/wordpress","type":"string"},"instance":{"description":"The name of the instance and the number suffix.","example":"cPanel::Blogs::WordPressX.0","type":"string"},"unique_id":{"description":"The unique identifier for the cPAddon.\n\n**Note:**\n\n This identifier will not change when you change the cPAddon's settings. However, if a new instance reuses a cPaddon's instance name, the system updates the unique identifier. You can use this identifier to select a specific instance to modify. A unique identifier.","example":"cPanel::Blogs::WordPressX.0.1486754861","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return deployed cPAddons instances","tags":["cPAddons","cPanel Addons (cPAddons)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  cPAddons \\\n  list_addon_instances\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/cPAddons/list_addon_instances"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file cPAddons_list_addon_instances.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/cPAddons_list_addon_instances.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/cPAddons/,\n    q/list_addon_instances/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file cPAddons_list_addon_instances.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/cPAddons_list_addon_instances.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'cPAddons',\n    'list_addon_instances'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 64"}},"/DynamicDNS/list":{"get":{"description":"This function lists the user’s Dynamic DNS (DDNS) domains.\n\n**Important:**\n\nWhen you disable the [_DNS_ role](https://go.cpanel.net/serverroles), the system disables this function.","operationId":"dynamicdns-list","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list","type":"string"},"module":{"description":"The name of the module called.","example":"DynamicDNS","type":"string"},"result":{"properties":{"data":{"description":"The user’s DDNS domains.","items":{"properties":{"created_time":{"description":"The DDNS domain’s creation time.","format":"unix_timestamp","type":"integer"},"description":{"description":"A user-editable string that describes the DDNS domain.","example":"My home network","type":"string"},"domain":{"description":"The domain.","example":"home.example.com","format":"domain","type":"string"},"id":{"description":"The domain’s DDNS ID.\n\n**Note:**\n\nThis ID goes into the URL that the client uses to\n[update the domain’s IP address\nresolution](https://go.cpanel.net/cpaneldocsdynamicdns).","example":"gziugyxxjwnamqtwysgmvrurplmafxpj","type":"string"},"last_run_times":{"description":"The most recent times when the web call ran.\n\n**Note:**\n\nThis list changes every time the web call runs,\neven if the domain’s IP address resolution does\n**not** change.","items":{"format":"unix_timestamp","type":"integer"},"type":"array"},"last_update_time":{"description":"The most recent update time for the\nDDNS domain.\n\n**Note:**\n\nThis value changes **only** when\nthe domain’s IP address resolution changes.","format":"unix_timestamp","nullable":true,"type":"integer"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return Dynamic DNS domains","tags":["DynamicDNS","Dynamic DNS"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DynamicDNS \\\n  list\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DynamicDNS/list"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DynamicDNS_list.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DynamicDNS_list.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DynamicDNS/,\n    q/list/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DynamicDNS_list.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DynamicDNS_list.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DynamicDNS',\n    'list'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":82}},"/NginxCaching/enable_cache":{"get":{"description":"This function enables the user's NGINX cache.\n\n**Note:**\n\n  - You can **only** use this function if you installed the `ea-nginx` package.","operationId":"enable_cache","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"enable_cache","type":"string"},"module":{"description":"The name of the module called.","example":"NginxCaching","type":"string"},"result":{"properties":{"data":{"properties":{}},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable the user's NGINX cache","tags":["NginxCaching"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  NginxCaching \\\n  enable_cache\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/NginxCaching/enable_cache"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file NginxCaching_enable_cache.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/NginxCaching_enable_cache.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/NginxCaching/,\n    q/enable_cache/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file NginxCaching_enable_cache.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/NginxCaching_enable_cache.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'NginxCaching',\n    'enable_cache'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 100"}},"/Themes/list":{"get":{"description":"This function lists available themes.\n\n**Note:**\n\n  The `/usr/local/cpanel/scripts/modify_accounts` script allows you to modify the style and theme for many or all accounts on the server. For more information, read our [The modify_accounts Script](https://go.cpanel.net/modifyaccounts) documentation.","operationId":"Themes::list","parameters":[{"description":"Whether to list the account's mail themes.\n* `1` — List mail themes.\n* `0` — Do **not** list mail themes.","in":"query","name":"show_mail_themes","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list","type":"string"},"module":{"description":"The name of the module called.","example":"Themes","type":"string"},"result":{"properties":{"data":{"description":"An array that contains the account's themes.","items":{"example":"jupiter","type":"string"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return available themes","tags":["Themes","Theme Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Themes \\\n  list\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Themes/list"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Themes_list.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Themes_list.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Themes/,\n    q/list/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Themes_list.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Themes_list.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Themes',\n    'list'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/WebmailApps/list_webmail_apps":{"get":{"description":"This function lists the account's available webmail clients.\n\n**Important:**\n\nWhen you disable the [Receive Mail role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function. ","operationId":"list_webmail_apps","parameters":[{"description":"The webmail theme.","in":"query","name":"theme","required":false,"schema":{"default":"the server's default theme","example":"jupiter","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_webmail_apps","type":"string"},"module":{"description":"The name of the module called.","example":"WebmailApps","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"displayname":{"description":"The webmail client name, as it will display in the interface.","example":"Roundcube","type":"string"},"icon":{"description":"An icon file's path, relative to the `/usr/local/cpanel/base/frontend` directory.","example":"/webmail/jupiter/images/roundcube_logo.png","type":"string"},"id":{"description":"The webmail client's ID.","example":"roundcube","type":"string"},"url":{"description":"The webmail client's URL.","example":"/cpsess##########/3rdparty/roundcube/index.php","format":"url-path","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return available webmail clients","tags":["WebmailApps","Webmail Applications"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  WebmailApps \\\n  list_webmail_apps\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/WebmailApps/list_webmail_apps"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file WebmailApps_list_webmail_apps.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/WebmailApps_list_webmail_apps.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/WebmailApps/,\n    q/list_webmail_apps/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file WebmailApps_list_webmail_apps.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/WebmailApps_list_webmail_apps.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'WebmailApps',\n    'list_webmail_apps'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.48"}},"/WordPressSite/create":{"get":{"description":"This function installs a WordPress site for cPanel user's primary domain.","operationId":"WordPressSite::create","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"create","type":"string"},"module":{"description":"The name of the module called.","example":"WordPressSite","type":"string"},"result":{"properties":{"data":{},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Install WordPress site","tags":["WordPressSite","Site Installation"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  WordPressSite \\\n  create\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/WordPressSite/create"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file WordPressSite_create.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/WordPressSite_create.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/WordPressSite/,\n    q/create/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file WordPressSite_create.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/WordPressSite_create.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'WordPressSite',\n    'create'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/delete_pop":{"get":{"description":"This function deletes an email address.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"delete_pop","parameters":[{"description":"The email account username or address.\n* A valid email account username. For example, `user` if the email address is `user@example.com`.\n* A valid email address.","example":"user@domain.com","in":"query","name":"email","required":true,"schema":{"anyOf":[{"example":"user@domain.com","format":"email","type":"string"},{"example":"user","type":"string"}]}},{"description":"Whether to remove the mail account's home mail directory. If you do not specify a value, the function removes the mail account's home directory.\n* `passwd` — Preserve the mail account's home directory.\n* Any other value — Remove the mail account's home directory.","in":"query","name":"flags","required":false,"schema":{"example":"passwd","type":"string"}},{"description":"The email account's domain. For example, `example.com` if the email address is `user@example.com`.","in":"query","name":"domain","required":false,"schema":{"default":"The cPanel account's main domain.","example":"example.com","format":"domain","type":"string"}},{"description":"Whether to modify the mail account's quota file.\n* `1` — Do **not** modify.\n* `0` — Modify.","in":"query","name":"skip_quota","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"delete_pop","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete email address","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  delete_pop \\\n  email='user@domain.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/delete_pop?email=user%40domain.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_delete_pop.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_delete_pop.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/delete_pop/,\n    {\n        'email' => 'user@domain.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_delete_pop.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_delete_pop.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'delete_pop',\n    array (\n        'email' => 'user@domain.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Team/password_reset_request":{"get":{"description":"This function enables a team user to reset the password by sending a password reset request link.","operationId":"password_reset_request","parameters":[{"description":"The username of the team user.","in":"query","name":"user","required":true,"schema":{"example":"teamuser","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"password_reset_request","type":"string"},"module":{"description":"The name of the module called.","example":"Team","type":"string"},"result":{"properties":{"data":{"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Sends a password reset request link to team user.","tags":["Team Users"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Team \\\n  password_reset_request \\\n  user='teamuser'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Team/password_reset_request?user=teamuser"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Team_password_reset_request.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Team_password_reset_request.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Team/,\n    q/password_reset_request/,\n    {\n        'user' => 'teamuser',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Team_password_reset_request.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Team_password_reset_request.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Team',\n    'password_reset_request',\n    array (\n        'user' => 'teamuser',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":108}},"/DNS/lookup":{"get":{"description":"This function returns DNS zone information about a domain.","operationId":"dns-lookup","parameters":[{"description":"A fully qualified domain name.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"lookup","type":"string"},"module":{"description":"The name of the module called.","example":"DNS","type":"string"},"result":{"properties":{"data":{"description":"Contains each response item.","example":["example.com has address 93.184.216.34","example.com has IPv6 address 2606:2800:220:1:248:1893:25c8:1946","example.com mail is handled by 0 ."],"items":{"type":"string"},"nullable":true,"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return domain's DNS information","tags":["DNS","DNS Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DNS \\\n  lookup \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DNS/lookup?domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DNS_lookup.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DNS_lookup.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DNS/,\n    q/lookup/,\n    {\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DNS_lookup.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DNS_lookup.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DNS',\n    'lookup',\n    array (\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":90}},"/Team/set_contact_email":{"get":{"description":"This function sets or changes primary and secondary email addresses.","operationId":"set_team_user_contact_email","parameters":[{"description":"The username of the team user.","in":"query","name":"user","required":true,"schema":{"example":"teamUser","type":"string"}},{"description":"The primary contact email address to set for the team user.","in":"query","name":"email1","required":false,"schema":{"example":"email1@example.com","type":"string"}},{"description":"The secondary contact email address to set for the team user.","in":"query","name":"email2","required":false,"schema":{"example":"email2@example.com","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_contact_email","type":"string"},"module":{"description":"The name of the module called.","example":"Team","type":"string"},"result":{"properties":{"data":{"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Set a contact email address for a team user","tags":["Team Users"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Team \\\n  set_contact_email \\\n  user='teamUser'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Team/set_contact_email?user=teamUser"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account, where theme-name represents\n# jupiter.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Team_set_contact_email.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Team_set_contact_email.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Team/,\n    q/set_contact_email/,\n    {\n        'user' => 'teamUser',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account, where theme-name represents\n// jupiter.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Team_set_contact_email.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Team_set_contact_email.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Team',\n    'set_contact_email',\n    array (\n        'user' => 'teamUser',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}\n"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":110}},"/Branding/get_applications":{"get":{"description":"This function retrieves an application's information from a specific theme's `dynamicui.conf` file.","operationId":"get_applications","parameters":[{"description":"A comma-separated list of an application feature names. If you do not specify this parameter,\nthe output will include all of the applications that the `dynamicui.conf` file contains.\n\n**Note:**\n\n* This value must match an application's `feature` value in the `dynamicui.conf` file.\n* For more information, read our [Guide to cPanel Interface Customization - Appkeys](https://go.cpanel.net/appkey) documentation.","in":"query","name":"app_keys","required":false,"schema":{"example":"addon_domains,ftp_accounts,anonymous_ftp","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_applications","type":"string"},"module":{"description":"The name of the module called.","example":"Branding","type":"string"},"result":{"properties":{"data":{"additionalProperties":{"description":"The feature's details. The function returns an object for each\napplication feature.\n\n**Note:***\n\nThe property name corresponds to the name(s) specified\nin the `app_keys` parameter.","properties":{"feature":{"description":"The feature name. The item will **only** display if the cPanel user has access to this feature.","example":"addondomains","type":"string"},"file":{"description":"The application's icon's filename.","example":"addon_domains","type":"string"},"group":{"description":"The item's group.","example":"advanced","type":"string"},"height":{"description":"The application's icon's height, in pixels.","example":48,"minimum":1,"type":"integer"},"if":{"description":"Conditional arguments that determine whether to display the item, if any exist.\n\nFor example, `$isreseller` indicates that the item **only** displays for reseller\naccounts.\n\nFor more information, read our\n[Guide to cPanel Variables](https://go.cpanel.net/guidetovariables)\ndocumentation.","example":"$is_reseller","type":"string"},"imgtype":{"description":"The item's image type.\n\n* `icon` is the only possible value.","enum":["icon"],"example":"icon","type":"string"},"implements":{"description":"The `implements` value for the application. This corresponds to the `implements` field in the `dynamicui.conf` file.","example":"Domains_AddonDomains","type":"string"},"itemdesc":{"description":"The application's display name. value.","example":"Addon Domain","type":"string"},"itemorder":{"description":"The application's order in the `dynamicui.conf`\nfile, representing the application's display order in\ncPanel's *Home* interface.\n\nFor example, the first item on the cPanel *Home* interface\nhas an `itemorder` value of `1`.","example":4,"minimum":1,"type":"integer"},"searchtext":{"description":"A space-separated list of search terms. The item will display when users enter these search terms in the *Quick Find* textbox.","example":"Domains Addon domain","type":"string"},"subtype":{"description":"The item's subtype.\n\n* `img` is the only possible value.","enum":["img"],"example":"img","type":"string"},"touch":{"description":"Conditional arguments that determine whether to display the item, if the touch file exists.","example":"ftp","type":"string"},"type":{"description":"The application's type.\n\n* `image` is the only possible value.","enum":["image"],"example":"image","type":"string"},"url":{"description":"The location to which the application's icon links.","example":"addon/index.html","format":"url-path","type":"string"},"width":{"description":"The application's icon's width.","example":48,"minimum":1,"type":"integer"}},"type":"object"},"example":{"addon_domains":{"acontent":"","base64_png_image":"","feature":"addondomains","file":"addon_domains","group":"domains","height":"48","if":"$HASROLE{'WebServer'}","imgtype":"icon","implements":"Domains_AddonDomains","itemdesc":"Addon Domains","itemorder":"3","key":"addon_domains","onclick":"","plainitemdesc":"Addon Domains","searchtext":"Domains Addon domain Addon Domains","subtype":"img","target":"","type":"image","url":"addon/index.html","width":"48"},"anonymous_ftp":{"acontent":"","base64_png_image":"","feature":"ftpaccts","file":"anonymous_ftp","group":"files","height":"48","if":"$SERVICEPROVIDED{'ftp'} && $hasanonftp","imgtype":"icon","itemdesc":"Anonymous FTP","itemorder":"8","key":"anonymous_ftp","onclick":"","plainitemdesc":"Anonymous FTP","searchtext":"Anonymous FTP anonymousftp","subtype":"img","target":"","touch":"ftp","type":"image","url":"ftp/anonymous.html","width":"48"},"ftp_accounts":{"acontent":"","base64_png_image":"","feature":"ftpaccts","file":"ftp_accounts","group":"files","height":"48","if":"$SERVICEPROVIDED{'ftp'}","imgtype":"icon","itemdesc":"FTP Accounts","itemorder":"6","key":"ftp_accounts","onclick":"","plainitemdesc":"FTP Accounts","searchtext":"FTP Accounts ftp create","subtype":"img","target":"","touch":"ftp","type":"image","url":"ftp/accounts.html","width":"48"}}},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return multiple apps' info from dynamicui.conf","tags":["Branding","Application Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Branding \\\n  get_applications\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Branding/get_applications"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Branding_get_applications.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Branding_get_applications.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Branding/,\n    q/get_applications/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Branding_get_applications.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Branding_get_applications.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Branding',\n    'get_applications'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.52"}},"/Branding/get_available_applications":{"get":{"description":"This function retrieves information about the groups and applications in the authenticated user's cPanel interface.","operationId":"get_available_applications","parameters":[{"description":"A pipe-separated list of group names denoting the order in which to sort the\ngroups. If you do not supply a value, the function does not sort the groups.\n\n**Note:**\n\n`arglist` is an alias for this parameter.","in":"query","name":"nvarglist","required":false,"schema":{"example":"pref|software|domains","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_available_applications","type":"string"},"module":{"description":"The name of the module called.","example":"Branding","type":"string"},"result":{"properties":{"data":{"properties":{"default_group_order":{"additionalProperties":{"description":"The group's default position.\n\n**Note:**\n\nThe property name is the group ID.","type":"integer"},"description":"An object that defines the default order of applications in cPanel.","example":{"advanced":7,"databases":2,"domains":3,"email":4,"files":1,"metrics":5,"preferences":8,"sample_apps":9,"security":6,"software":6},"type":"object"},"grouporder":{"description":"A list of group IDs, in the order in which the groups appear.","example":["files","databases","domains","email","metrics","security","software","advanced","preferences","pref"],"items":{"type":"string"},"type":"array"},"groups":{"description":"Information about each group in the cPanel interface.","items":{"properties":{"desc":{"description":"The group's description.","example":"Files","type":"string"},"group":{"description":"The group's ID.","example":"files","type":"string"},"items":{"description":"The groups and their application details.","items":{"example":{"acontent":"target=\"file_manager\"","base64_png_image":"","feature":"filemanager","file":"file_manager","group":"files","height":"48","if":"$HASROLE{'FileStorage'}","imgtype":"icon","implements":"FileManager_Home","itemdesc":"File Manager","itemorder":"1","key":"file_manager","onclick":"","plainitemdesc":"File Manager","searchtext":"File Manager file-manager","subtype":"img","target":"file_manager","type":"image","url":"filemanager/index.html","width":"48"},"properties":{"acontent":{"description":"The content of a tag in the application's link.","example":"file_manager","type":"string"},"base64_png_image":{"description":"The application's icon in Base64 format.","format":"base64 image","type":"string"},"feature":{"description":"A feature name. The icon **only** displays if the cPanel user can access this feature.","example":"addondomains","type":"string"},"file":{"description":"The application's icon's filename.","example":"addon_domains","type":"string"},"group":{"description":"The item's group.","example":"advanced","type":"string"},"height":{"description":"The application icon height, in pixels.","example":"48","type":"string"},"if":{"description":"An expression containing cPanel variables that determine whether\nto display the item. The function **only** returns this value if\nany variables exist.\n\nFor example, `$isreseller` indicates that the item **only**\ndisplays for reseller accounts.\n\nFor more information, read our\n[Guide to cPanel Variables documentation](https://go.cpanel.net/guidetovariables).","example":"$isreseller","type":"string"},"imgtype":{"description":"The item's image type.\n\n`icon` is the only possible value.","enum":["icon"],"example":"icon","type":"string"},"implements":{"description":"The `implements` name of the application. WHM API 1's `create_user_session` and `get_users_links` functions use this value.","example":"Domains_AddonDomains","type":"string"},"itemdesc":{"description":"The application's display name.","example":"Addon Domain","type":"string"},"itemorder":{"description":"The application's order in the `dynamicui.conf` file. This value represents the application's display order in cPanel's *Home* interface.","example":"4","type":"string"},"module":{"description":"The Perl module that the application requires.","example":"My::Module","type":"string"},"onclick":{"description":"JavaScript function that the browser calls before or instead of URL navigation.","example":"function","type":"string"},"searchtext":{"description":"One or more space-separated search terms.  The icon will display when users enter these search terms in the *Quick Find* text box in the cPanel interface.","example":"Domains Addon domain","type":"string"},"subtype":{"description":"The item's subtype.\n\n`img` is the only possible value.","enum":["img"],"example":"img","type":"string"},"target":{"description":"The target of the application's link.","example":"file_manager","type":"string"},"touch":{"description":"Conditional arguments that determine whether to display the item, if a specified touch file exists.","example":"ftp","type":"string"},"type":{"description":"The application's type.\n\n`image` is the only possible value.","enum":["image"],"example":"image","type":"string"},"url":{"description":"The path to which the application's icon links.","example":"addon/index.html","format":"url-path","type":"string"},"width":{"description":"The application's icon's width, in pixels.","example":"48","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"},"implements":{"additionalProperties":{"description":"The application and its Appkey value.\n\n**Note:**\n\nThis return's name is the application's name, in its `implements` value format.","type":"string"},"description":"An object mapping the `implements` names to Appkey values for applications in cPanel.\n\nFor example, use this mapping to determine that the `implements`\nvalue `SSL_TLS_Status` maps to the Appkey value `tls_status`.\n\n**Note:**\n\n* The Appkey for an application can be found in the `key` attribute elsewhere in the API response.\n* The `implements` for an application can be found in the `implements` attribute elsewhere in the API response.\n* For more information about Appkey values, read our [Guide to cPanel Interface Customization - Appkeys](https://go.cpanel.net/paper-lantern-theme-guide-to-cpanel-interface-customization-appkeys) documentation.","example":{"API_Tokens_Manager":"api_tokens","Backups_Home":"backup","Calendar_Configure":"calendar_and_contacts","ContactInfo_Change":"contact_information","Cron_Home":"cron_jobs","Database_MySQL":"mysql_databases","Database_phpMyAdmin":"php_my_admin","Domains_AddonDomains":"addon_domains","Domains_SubDomains":"subdomains","Email_AccountLevelFiltering":"global_email_filters","Email_Accounts":"email_accounts","Email_Authentication":"email_deliverability","Email_AutoResponders":"autoresponders","Email_BoxTrapper":"boxtrapper","Email_DefaultAddress":"default_address","Email_DeliveryReport":"track_delivery","Email_Disk_Usage":"email_disk_usage","Email_Forwarders":"forwarders","Email_MailingLists":"mailing_lists","Email_Routing":"email_routing","Email_SpamFilter":"apache_spam_assassin","Email_UserLevelFiltering":"email_filters","FileManager_Home":"file_manager","Locale_Change":"change_language","Password_Change":"change_password","SSL_TLS_Manager":"ssl_tls","SSL_TLS_Status":"tls_status","Site_Software":"site_software","Stats_AWStats":"awstats"},"type":"object"},"index":{"additionalProperties":{"description":"The order in which the application appears in the cPanel interface:\n* The first integer represents the group in which the application appears, starting at `0`.\n* The second integer represents the order in which the application appears in the group, starting at `0`.\n\n**Note:**\n\nThe array's name is the application's name.","items":{"type":"integer"},"type":"array"},"description":"The applications and the order in which they appear in the cPanel interface.","example":{"addon_domains":[2,2],"address_importer":[3,10],"aliases":[2,4],"analog_stats":[4,5],"apache_handlers":[7,5],"apache_spam_assassin":[3,11],"api_tokens":[5,3],"autoresponders":[3,3],"awstats":[4,4],"backup":[0,5],"backup_wizard":[0,6],"bandwidth":[4,2],"boxtrapper":[3,13],"calendar_and_contacts":[3,14],"change_language":[8,1],"change_password":[8,0],"change_style":[8,2],"contact_information":[8,3],"cron_jobs":[7,1],"default_address":[3,4],"directory_privacy":[0,2],"disk_usage":[0,3],"domains":[2,1],"email_accounts":[3,0],"email_deliverability":[3,9],"email_disk_usage":[3,15],"email_filters":[3,8],"email_routing":[3,2],"encryption":[3,12],"error_pages":[7,4],"errors":[4,1],"file_manager":[0,0],"forwarders":[3,1],"global_email_filters":[3,7],"hotlink_protection":[5,4],"images":[0,1],"indexes":[7,3],"ip_blocker":[5,1],"leech_protection":[5,5],"mailing_lists":[3,5],"metrics_editor":[4,7],"mime_types":[7,6],"multiphp_ini_editor":[6,5],"multiphp_manager":[6,4],"mysql_database_wizard":[1,2],"mysql_databases":[1,1],"optimize_website":[6,3],"perl_modules":[6,1],"php_my_admin":[1,0],"php_pear_packages":[6,0],"raw_access":[4,3],"redirects":[2,5],"remote_mysql":[1,3],"site_publisher":[2,0],"site_software":[6,2],"ssh_access":[5,0],"ssl_tls":[5,2],"subdomains":[2,3],"terminal":[7,0],"tls_status":[5,6],"track_delivery":[3,6],"track_dns":[7,2],"user_manager":[8,4],"version_control":[0,7],"visitors":[4,0],"web_disk":[0,4],"webalizer":[4,6],"zone_editor":[2,6]},"type":"object"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return current user's cPanel application details","tags":["Branding","Application Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Branding \\\n  get_available_applications\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Branding/get_available_applications"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Branding_get_available_applications.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Branding_get_available_applications.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Branding/,\n    q/get_available_applications/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Branding_get_available_applications.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Branding_get_available_applications.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Branding',\n    'get_available_applications'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/CacheBuster/update":{"get":{"description":"This function generates a random integer (the CacheBuster ID). Use this ID to work with and around a browser's caching mechanism.","operationId":"update","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"update","type":"string"},"module":{"description":"The name of the module called.","example":"CacheBuster","type":"string"},"result":{"properties":{"data":{"properties":{"cache_id":{"description":"random integer that the system uses to work with and around a browser's caching mechanism. An eight-digit integer.","example":11381138,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create web browser cached file override ID","tags":["CacheBuster","Browser Cache Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  CacheBuster \\\n  update\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/CacheBuster/update"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file CacheBuster_update.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/CacheBuster_update.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/CacheBuster/,\n    q/update/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file CacheBuster_update.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/CacheBuster_update.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'CacheBuster',\n    'update'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.46"}},"/DNS/parse_zone":{"get":{"description":"This function parses a given DNS zone.\n\n**Important:**\n\nMost DNS zones contain only 7-bit ASCII. However, it is possible for\nDNS zones to contain any binary sequence. An application that decodes\nthis function's base64 output **must** be able to handle cases\nwhere the decoded octets do not match any specific character\nencoding.","operationId":"dns-parse_zone","parameters":[{"description":"The name of one of the user’s DNS zones.","in":"query","name":"zone","required":true,"schema":{"example":"example.com","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"parse_zone","type":"string"},"module":{"description":"The name of the module called.","example":"DNS","type":"string"},"result":{"properties":{"data":{"$ref":"#/components/schemas/Payload"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return a parsed DNS zone","tags":["DNS","DNS Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DNS \\\n  parse_zone \\\n  zone='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DNS/parse_zone?zone=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DNS_parse_zone.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DNS_parse_zone.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DNS/,\n    q/parse_zone/,\n    {\n        'zone' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DNS_parse_zone.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DNS_parse_zone.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DNS',\n    'parse_zone',\n    array (\n        'zone' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":96}},"/Email/add_auto_responder":{"get":{"description":"This function creates an autoresponder for an email account.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"add_auto_responder","parameters":[{"description":"The email account name. For example, `user` if the email address is `user@example.com`.","in":"query","name":"email","required":true,"schema":{"example":"user","type":"string"}},{"description":"The contents of the autoresponder message's `From:` field.","in":"query","name":"from","required":true,"schema":{"example":"User Name","type":"string"}},{"description":"The contents of the autoresponder message's `Subject:` field.","in":"query","name":"subject","required":true,"schema":{"example":"Autoresponder Subject","type":"string"}},{"description":"The contents of the autoresponder message's `Body` section.","in":"query","name":"body","required":true,"schema":{"example":"This is an autoresponder message.","type":"string"}},{"description":"The email account's domain. For example, `example.com` if the email address is `user@example.com`.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"Whether the body of the autoresponder message begins with an [HTML Content-Type declaration](https://en.wikipedia.org/wiki/Character_encodings_in_HTML#Specifying_the_document.27s_character_encoding).\n* `1` — Include an HTML content type declaration.\n* `0` — Do **not** include an HTML content type declaration.","in":"query","name":"is_html","required":true,"schema":{"enum":[0,1],"example":1,"type":"integer"}},{"description":"The [character set](https://en.wikipedia.org/wiki/Character_encoding).","in":"query","name":"charset","required":false,"schema":{"default":"utf-8","example":"UTF-8","type":"string"}},{"description":"The amount of time, in hours, that the server waits between autoresponder messages to the same address.\n\n**Note:**\n\n  If you specify `0`, the system sends a message for each received email.","in":"query","name":"interval","required":true,"schema":{"example":24,"minimum":0,"type":"integer"}},{"description":"When to enable the autoresponder.","in":"query","name":"start","required":true,"schema":{"example":1410277881,"format":"unix_timestamp","type":"integer"}},{"description":"When to disable the autoresponder. A time that is after the `start` time.","in":"query","name":"stop","required":true,"schema":{"example":1410300000,"format":"unix_timestamp","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"add_auto_responder","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create email account's autoresponder","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  add_auto_responder \\\n  email='user' \\\n  from='User Name' \\\n  subject='Autoresponder Subject' \\\n  body='This is an autoresponder message.' \\\n  domain='example.com' \\\n  is_html='1' \\\n  interval='24' \\\n  start='1410277881' \\\n  stop='1410300000'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/add_auto_responder?email=user&from=User%20Name&subject=Autoresponder%20Subject&body=This%20is%20an%20autoresponder%20message.&domain=example.com&is_html=1&interval=24&start=1410277881&stop=1410300000"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_add_auto_responder.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_add_auto_responder.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/add_auto_responder/,\n    {\n        'email' => 'user',\n        'from' => 'User Name',\n        'subject' => 'Autoresponder Subject',\n        'body' => 'This is an autoresponder message.',\n        'domain' => 'example.com',\n        'is_html' => '1',\n        'interval' => '24',\n        'start' => '1410277881',\n        'stop' => '1410300000',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_add_auto_responder.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_add_auto_responder.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'add_auto_responder',\n    array (\n        'email' => 'user',\n        'from' => 'User Name',\n        'subject' => 'Autoresponder Subject',\n        'body' => 'This is an autoresponder message.',\n        'domain' => 'example.com',\n        'is_html' => '1',\n        'interval' => '24',\n        'start' => '1410277881',\n        'stop' => '1410300000',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/CacheBuster/read":{"get":{"description":"This function returns the current `CacheBuster` id. The system uses this ID to force the browser to fetch a new resource when that resource already exists in the web browser cache. This is useful when an application has updated the resource on the server. You should append this ID to the end of the url in the query-string. For example, if you are accessing a url like:\n\n`https://example.com/styled/basic/sprites/icon_spritemap.css`\n\n To force the browser to fetch the updated version, you would append the following:\n\n `https://example.com/styled/basic/sprites/icon_spritemap.css?<CacheBusterID>`\n\n **Note**\n\n The application that updates the resource at this url on the server **must** call the `CacheBuster::update` function when it updates the resource to signify that update.","operationId":"CacheBuster-read","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"read","type":"string"},"module":{"description":"The name of the module called.","example":"CacheBuster","type":"string"},"result":{"properties":{"data":{"properties":{"cache_id":{"description":"An eight-digit random integer that the system uses to work around a browser's caching mechanism.","example":11381138,"maximum":99999999,"minimum":10000000,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return web browser cached file override ID","tags":["CacheBuster","Browser Cache Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  CacheBuster \\\n  read\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/CacheBuster/read"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file CacheBuster_read.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/CacheBuster_read.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/CacheBuster/,\n    q/read/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file CacheBuster_read.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/CacheBuster_read.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'CacheBuster',\n    'read'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.46"}},"/ClamScanner/get_scan_paths":{"get":{"description":"This function gets the available local paths that a cPanel account is permitted to scan.\n\n**Note**:\n\nThe system determines the available scan types based on what the system administrator has set in WHM's [Configure ClamAV®](https://go.cpanel.net/configureclamavscanner) page.\n\n**Note**:\n\nYou must run the APIs in this order:\n\n1. Run [`ClamScanner::start_scan`](https://go.cpanel.net/ClamScanner-start-scan) to start the virus scan.\n2. Run [`ClamScanner::get_scan_status`](https://go.cpanel.net/ClamScanner-get-scan-status) in a loop until the scan is finished.\n3. Run [`ClamScanner::list_infected_files`](https://go.cpanel.net/ClamScanner-list-infected-files) to get a report of the complete list of infected files.\n4. Decide how you want to handle each infected file.\n5. Run [`ClamScanner::disinfect_files`](https://go.cpanel.net/ClamScanner-disinfect-files) to queue the disinfection of the files.\n6. Run [`ClamScanner::check_disinfection_status`](https://go.cpanel.net/ClamScanner-check-disinfection-status) in a loop until you get a done status.","operationId":"ClamScanner::get_scan_paths","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_scan_paths","type":"string"},"module":{"description":"The name of the module called.","example":"ClamScanner","type":"string"},"result":{"properties":{"data":{"properties":{"id":{"description":"The type of path\n* `home` — The cPanel account's entire home directory.\n* `mail` — The cPanel account's email directory.\n* `public_html` — The cPanel account's web directory.\n* `public_ftp` — The cPanel account's FTP directory.","enum":["home","mail","public_html","public_ftp"],"example":"home","type":"string"},"message":{"description":"Short description of the path","example":"Scan Entire Home Directory","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return virus scan types","tags":["ClamScanner","Antivirus Protection (ClamAV)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  ClamScanner \\\n  get_scan_paths\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/ClamScanner/get_scan_paths"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file ClamScanner_get_scan_paths.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/ClamScanner_get_scan_paths.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/ClamScanner/,\n    q/get_scan_paths/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file ClamScanner_get_scan_paths.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/ClamScanner_get_scan_paths.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'ClamScanner',\n    'get_scan_paths'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 94"}},"/ClamScanner/start_scan":{"get":{"description":"This function starts a ClamAV® scan on a directory.\n\n**Note**:\n\nYou must run the APIs in this order:\n\n1. Run [`ClamScanner::start_scan`](https://go.cpanel.net/ClamScanner-start-scan) to start the virus scan.\n2. Run [`ClamScanner::get_scan_status`](https://go.cpanel.net/ClamScanner-get-scan-status) in a loop until the scan is finished.\n3. Run [`ClamScanner::list_infected_files`](https://go.cpanel.net/ClamScanner-list-infected-files) to get a report of the complete list of infected files.\n4. Decide how you want to handle each infected file.\n5. Run [`ClamScanner::disinfect_files`](https://go.cpanel.net/ClamScanner-disinfect-files) to queue the disinfection of the files.\n6. Run [`ClamScanner::check_disinfection_status`](https://go.cpanel.net/ClamScanner-check-disinfection-status) in a loop until you get a done status.","operationId":"ClamScanner::start_scan","parameters":[{"description":"The type of directory to scan.\n\n* `home` — User's entire home directory\n* `mail` — User's email directory\n* `public_html` — User's web directory\n* `public_ftp` — User's ftp directory","in":"query","name":"scan_type","required":true,"schema":{"enum":["home","mail","public_html","public_ftp"],"example":"home"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"start_scan","type":"string"},"module":{"description":"The name of the module called.","example":"ClamScanner","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Start virus scan","tags":["ClamScanner","Antivirus Protection (ClamAV)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  ClamScanner \\\n  start_scan \\\n  scan_type='home'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/ClamScanner/start_scan?scan_type=home"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file ClamScanner_start_scan.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/ClamScanner_start_scan.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/ClamScanner/,\n    q/start_scan/,\n    {\n        'scan_type' => 'home',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file ClamScanner_start_scan.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/ClamScanner_start_scan.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'ClamScanner',\n    'start_scan',\n    array (\n        'scan_type' => 'home',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 94"}},"/Email/add_list":{"get":{"description":"This function creates a Mailman mailing list.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"add_list","parameters":[{"description":"The mailing list name.","in":"query","name":"list","required":true,"schema":{"example":"newlist","type":"string"}},{"description":"The mailing list password.","in":"query","name":"password","required":true,"schema":{"example":"12345luggage","type":"string"}},{"description":"The domain.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"Whether to rebuild the mailing list.\n* `1` — Rebuild the mailing list.\n* `0` — Do **not** rebuild the mailing list.","in":"query","name":"rebuildonly","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"Whether the mailing list is private.\n* `1` — Private.\n* `0` — Public.","in":"query","name":"private","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"add_list","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create mailing list","tags":["Email","Mailing Lists"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  add_list \\\n  list='newlist' \\\n  password='12345luggage' \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/add_list?list=newlist&password=12345luggage&domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_add_list.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_add_list.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/add_list/,\n    {\n        'list' => 'newlist',\n        'password' => '12345luggage',\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_add_list.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_add_list.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'add_list',\n    array (\n        'list' => 'newlist',\n        'password' => '12345luggage',\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/ContactInformation/unset_email_addresses":{"get":{"description":"Use this function to unset all contact email address for an account.\n\nTo set contact email address(es), call `set_email_addresses`.","operationId":"contactinformation-unset_email_addresses","parameters":[{"description":"The account’s existing contact email addresses.\n\nIf this list does not match the account’s current current email address(es),\nthen the request will fail. This control is here to prevent\nrace conditions.","example":["old1@example.com"],"explode":true,"in":"query","name":"old_address","required":true,"schema":{"items":{"format":"email","type":"string"},"type":"array"}},{"description":"The account’s password.","in":"query","name":"password","required":true,"schema":{"example":"q1df%D9<z0ShqdxRP%^","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"create","type":"string"},"module":{"description":"The name of the module called.","example":"DynamicDNS","type":"string"},"result":{"properties":{"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"Request was successful."}},"summary":"Unset contact email addresses","tags":["ContactInformation","Contact Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  ContactInformation \\\n  unset_email_addresses \\\n  old_address='old1@example.com' \\\n  password='q1df%D9<z0ShqdxRP%^'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/ContactInformation/unset_email_addresses?old_address=old1%40example.com&password=q1df%25D9%3cz0ShqdxRP%25%5e"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file ContactInformation_unset_email_addresses.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/ContactInformation_unset_email_addresses.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/ContactInformation/,\n    q/unset_email_addresses/,\n    {\n        'old_address' => 'old1@example.com',\n        'password' => 'q1df%D9<z0ShqdxRP%^',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file ContactInformation_unset_email_addresses.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/ContactInformation_unset_email_addresses.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'ContactInformation',\n    'unset_email_addresses',\n    array (\n        'old_address' => 'old1@example.com',\n        'password' => 'q1df%D9<z0ShqdxRP%^',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":102}},"/TeamRoles/list_feature_descriptions":{"get":{"description":"This function gives a list of all team roles and their included features.","operationId":"list_feature_descriptions","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_feature_descriptions","type":"string"},"module":{"description":"The name of the module called.","example":"TeamRoles","type":"string"},"result":{"properties":{"data":{"$ref":"#/components/schemas/FeatureDescriptions"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"List all role feature descriptions","tags":["Team Roles"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  TeamRoles \\\n  list_feature_descriptions\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/TeamRoles/list_feature_descriptions"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file TeamRoles_list_feature_descriptions.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/TeamRoles_list_feature_descriptions.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/TeamRoles/,\n    q/list_feature_descriptions/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file TeamRoles_list_feature_descriptions.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/TeamRoles_list_feature_descriptions.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'TeamRoles',\n    'list_feature_descriptions'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":108}},"/ContactInformation/set_email_addresses":{"get":{"description":"Use this function to set an account's contact email address(es).\n\nTo unset all contact email addresses, call `unset_email_addresses`.","operationId":"contactinformation-set_email_addresses","parameters":[{"description":"The account’s new contact email addresses.","example":["foo@example.com","bar@example.com"],"explode":true,"in":"query","name":"address","required":true,"schema":{"items":{"format":"email","type":"string"},"type":"array"}},{"description":"The account’s existing contact email addresses.\n\nIf this list does not match the account’s current current email address(es),\nthen the request will fail. This control is here to prevent\nrace conditions.","example":["old1@example.com"],"explode":true,"in":"query","name":"old_address","required":true,"schema":{"items":{"format":"email","type":"string"},"type":"array"}},{"description":"The account’s password.","in":"query","name":"password","required":true,"schema":{"example":"q1df%D9<z0ShqdxRP%^","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_email_addresses","type":"string"},"module":{"description":"The name of the module called.","example":"ContactInformation","type":"string"},"result":{"properties":{"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"Request was successful."}},"summary":"Set contact email address(es)","tags":["ContactInformation","Contact Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  ContactInformation \\\n  set_email_addresses \\\n  address='foo@example.com' address='bar@example.com' \\\n  old_address='old1@example.com' \\\n  password='q1df%D9<z0ShqdxRP%^'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/ContactInformation/set_email_addresses?address=foo%40example.com&address=bar%40example.com&old_address=old1%40example.com&password=q1df%25D9%3cz0ShqdxRP%25%5e"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file ContactInformation_set_email_addresses.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/ContactInformation_set_email_addresses.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/ContactInformation/,\n    q/set_email_addresses/,\n    {\n        'address' => 'foo@example.com'&address='bar@example.com',\n        'old_address' => 'old1@example.com',\n        'password' => 'q1df%D9<z0ShqdxRP%^',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file ContactInformation_set_email_addresses.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/ContactInformation_set_email_addresses.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'ContactInformation',\n    'set_email_addresses',\n    array (\n        'address' => 'foo@example.com'&address='bar@example.com',\n        'old_address' => 'old1@example.com',\n        'password' => 'q1df%D9<z0ShqdxRP%^',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":102}},"/CSVImport/doimport":{"get":{"description":"This function imports email accounts from an already uploaded CSV file.","operationId":"CSVImport::doimport","parameters":[{"description":"The unique ID of the import operation. The cPanel API 2 CSVImport::uploadimport function generates this ID and stores it in the `CPVAR` attribute named `csvimportid`.","in":"query","name":"id","required":true,"schema":{"example":"Leq58oid3sF3Moye3_YbJGqoMvCb7M4j","type":"string"}},{"description":"The type of email address to add.\n\n* `email` — A regular email account.\n* `fwd` — A forwarder.","in":"query","name":"type","required":true,"schema":{"enum":["email","fwd"],"example":"email","type":"string"}},{"description":"The domain under which to add the email accounts.","in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"doimport","type":"string"},"module":{"description":"The name of the module called.","example":"CSVImport","type":"string"},"result":{"properties":{"data":{"properties":{"results":{"description":"The results for each attempted add operation.","example":[{"email":"j.doe@example.com","reason":"OK","status":1,"type":"email"},{"email":"jdoe@example.com","reason":"The account jdoe@example.com already exists!","status":0,"type":"email"}],"items":{"properties":{"email":{"description":"The email address or forwarder.","example":"j.doe@example.com","format":"email","type":"string"},"fwd":{"description":"The destination of the forwarder (if applicable).","example":null,"format":"email","nullable":true,"type":"string"},"reason":{"description":"The explanation of the outcome for each operation.","type":"string"},"status":{"description":"The outcome of each operation.\n\n* `1` — Success.\n* `0` — Failed.","enum":[0,1],"type":"integer"},"type":{"description":"The type of email address.\n\n* `email` — A regular email account.\n* `fwd` — A forwarder.","enum":["email","fwd"],"example":"email","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":["1 error(s) were encountered while importing accounts."],"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success\n* `0` — Failed: One or more errors occurred. For errors related to individual account add operations, see the `reason` field in each record from `results` for more information.","enum":[0,1],"example":0,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Import email accounts from CSV file","tags":["CSVImport","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  CSVImport \\\n  doimport \\\n  id='Leq58oid3sF3Moye3_YbJGqoMvCb7M4j' \\\n  type='email' \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/CSVImport/doimport?id=Leq58oid3sF3Moye3_YbJGqoMvCb7M4j&type=email&domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file CSVImport_doimport.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/CSVImport_doimport.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/CSVImport/,\n    q/doimport/,\n    {\n        'id' => 'Leq58oid3sF3Moye3_YbJGqoMvCb7M4j',\n        'type' => 'email',\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file CSVImport_doimport.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/CSVImport_doimport.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'CSVImport',\n    'doimport',\n    array (\n        'id' => 'Leq58oid3sF3Moye3_YbJGqoMvCb7M4j',\n        'type' => 'email',\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 94"}},"/Contactus/is_enabled":{"get":{"description":"This function checks whether the cPanel account can contact their hosting provider from the cPanel interface.","operationId":"is_enabled","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"is_enabled","type":"string"},"module":{"description":"The name of the module called.","example":"Contactus","type":"string"},"result":{"properties":{"data":{"properties":{"enabled":{"description":"Whether the cPanel account can contact their hosting provider\nfrom the cPanel interface.\n\n* `1` — The cPanel account can contact their hosting provider\nfrom the cPanel interface.\n* `0` — The cPanel account **cannot** contact their hosting\nprovider from the cPanel interface.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return whether contact option is enabled","tags":["Contactus","Contact Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Contactus \\\n  is_enabled\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Contactus/is_enabled"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Contactus_is_enabled.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Contactus_is_enabled.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Contactus/,\n    q/is_enabled/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Contactus_is_enabled.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Contactus_is_enabled.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Contactus',\n    'is_enabled'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/set_manual_mx_redirects":{"get":{"description":"This function lets you create a manual Exim mail exchanger (MX) redirect for a domain.\nAn MX redirection lets you bypass the domain's MX lookup via the Domain Name System (DNS).\nThis function adds the manual redirect entries to the `/etc/manualmx` file.\n\n**Note:**\n\n  To remove a domain's manual MX redirection, use the UAPI Email `unset_manual_mx_redirect` function.","operationId":"set_manual_mx_redirects","parameters":[{"description":"The domain for which to add a manual MX redirect entry.\n\n**Note:**\n\n* To add multiple domain entries, increment the parameter. For example, use the `domain`, `domain-1`, and `domain-2` parameters.\n* For multiple domains, you **must** include its corresponding `mx_host` value.","in":"query","name":"domain","required":true,"examples":{"single":{"summary":"Add a single manual MX redirect entry.","value":"'example.com'"},"multiple":{"summary":"Add multiple manual MX redirect entries.","value":"example.com&domain-1=example1.com&domain-2=example2.com"}},"schema":{"example":"example.com","type":"string","format":"domain"}},{"description":"The domain, IPv4, or IPv6 address to redirect the domain value's emails to.\n\n**Note:**\n\n * To add multiple MX hosts, increment the parameter. For example, use the `mx_host`, `mx_host-1`, and `mx_host-2` parameters.\n * For multiple MX hosts, you **must** include its corresponding `domain` value.","in":"query","name":"mx_host","required":true,"examples":{"single":{"summary":"Add a single manual MX host.","value":"'mailhostexample'"},"multiple":{"summary":"Add multiple manual MX hosts.","value":"mailhostexample&mx_host-1=mailhostexample&mx_host-2=mailhostexample"}},"schema":{"oneOf":[{"type":"string","description":"A domain name.","format":"domain"},{"type":"string","description":"An IPv4 address.","format":"ipv4"},{"type":"string","description":"An IPv6 address.","format":"ipv6"}]}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_manual_mx_redirects","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"A list of domains and the replaced manual MX redirect entries.","properties":{"additionalProperties":{"description":"The domain for which the function replaced the manual MX redirect entry.\n\n* null — The domain did not have an existing manual MX redirect entry.\n\n**Note:**\n\nThis return's name is the `domain` parameter's value.","example":"mailhostexample.com","type":"string","nullable":true}},"type":"object","example":{"example.com":"mailhostexample.com"}},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add manual MX redirection","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty --user=username Email set_manual_mx_redirects domain='example.com' mx_host='mailhostexample.com'"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/set_manual_mx_redirects?domain=example.com&mx_host=mailhostexample.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_set_manual_mx_redirects.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_set_manual_mx_redirects.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/set_manual_mx_redirects/,\n    {\n        'domain' => 'example.com',\n        'mx_host' => 'mailhostexample.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_set_manual_mx_redirects.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_set_manual_mx_redirects.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'set_manual_mx_redirects',\n    array (\n        'domain' => 'example.com',\n        'mx_host' => 'mailhostexample.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 96"}},"/Email/unset_manual_mx_redirects":{"get":{"description":"This function lets you create a manual Exim mail exchanger (MX) redirect for a domain.\nAn MX redirection lets you bypass the domain's MX lookup via the Domain Name System (DNS).\nThis function adds the manual redirect entries to the `/etc/manualmx` file.\n\n**Note:**\n\n  To remove a domain's manual MX redirection, use the UAPI Email `unset_manual_mx_redirect` function.","operationId":"unset_manual_mx_redirects","parameters":[{"description":"The domain for which to add a manual MX redirect entry.\n\n**Note:**\n\n* To add multiple domain entries, increment the parameter. For example, use the `domain`, `domain-1`, and `domain-2` parameters.\n* For multiple domains, you **must** include its corresponding `mx_host` value.","in":"query","name":"domain","required":true,"examples":{"single":{"summary":"Add a single manual MX redirect entry.","value":"'example.com'"},"multiple":{"summary":"Add multiple manual MX redirect entries.","value":"example.com&domain-1=example1.com&domain-2=example2.com"}},"schema":{"example":"example.com","type":"string","format":"domain"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"unset_manual_mx_redirects","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"description":"A list of domains and the removed manual MX redirect entries.","properties":{"additionalProperties":{"description":"The domain for which the function removed the manual MX redirect entry.\n\n* null — The domain did not have a manual MX redirect entry.\n\n**Note:**\n\nThis return's name is the `domain` parameter's value.","example":"mailhostexample.com","type":"string","nullable":true}},"type":"object","example":{"example.com":"mailhostexample.com"}},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove manual MX redirection","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty --user=username Email unset_manual_mx_redirects domain='example.com'"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/unset_manual_mx_redirects?domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_unset_manual_mx_redirects.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_unset_manual_mx_redirects.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/unset_manual_mx_redirects/,\n    {\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_unset_manual_mx_redirects.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_unset_manual_mx_redirects.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'unset_manual_mx_redirects',\n    array (\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 96"}},"/ServiceProxy/get_service_proxy_backends":{"get":{"description":"This function reports a cPanel account's\n[service proxying](https://go.cpanel.net/ServiceProxying)\nconfiguration.","operationId":"serviceproxy-get_service_proxy_backends","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_service_proxy_backends","type":"string"},"module":{"description":"The name of the module called.","example":"ServiceProxy","type":"string"},"result":{"properties":{"data":{"description":"The account’s service proxying backends.","items":{"properties":{"backend":{"description":"The name of the server to which the system will proxy requests for this service group.","example":"example.com","format":"domain","type":"string"},"service_group":{"description":"The name of the proxying service group, if applicable.\n\n* null — The account’s general service proxying backend.","example":"Mail","nullable":true,"type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return a cPanel account’s service proxying setup","tags":["ServiceProxy"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  ServiceProxy \\\n  get_service_proxy_backends\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/ServiceProxy/get_service_proxy_backends"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file ServiceProxy_get_service_proxy_backends.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/ServiceProxy_get_service_proxy_backends.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/ServiceProxy/,\n    q/get_service_proxy_backends/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file ServiceProxy_get_service_proxy_backends.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/ServiceProxy_get_service_proxy_backends.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'ServiceProxy',\n    'get_service_proxy_backends'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 96"}},"/Chkservd/get_exim_ports_ssl":{"get":{"description":"This function retrieves Exim's SSL port.","operationId":"get_exim_ports_ssl","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_exim_ports_ssl","type":"string"},"module":{"description":"The name of the module called.","example":"Chkservd","type":"string"},"result":{"properties":{"data":{"properties":{"ports":{"description":"An array of port numbers on which Exim listens for SSL/TLS connections.","items":{"example":465,"maximum":65535,"minimum":0,"type":"integer"},"type":"array"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` - Success\n- `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return outgoing mail (SMTP) SSL-secured port","tags":["Chkservd","Mail Server Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Chkservd \\\n  get_exim_ports_ssl\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Chkservd/get_exim_ports_ssl"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Chkservd_get_exim_ports_ssl.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Chkservd_get_exim_ports_ssl.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Chkservd/,\n    q/get_exim_ports_ssl/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Chkservd_get_exim_ports_ssl.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Chkservd_get_exim_ports_ssl.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Chkservd',\n    'get_exim_ports_ssl'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/terminate_mailbox_sessions":{"get":{"description":"This function terminates all IMAP and POP3 connections for a cPanel account.\n\n**Note:**\n\nThis function ends connections for every email address, which includes the [default address](https://go.cpanel.net/cpaneldocsDefaultAddress).","operationId":"email-terminate_mailbox_sessions","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"metadata":{"properties":{"command":{"description":"The method name called.","example":"terminate_mailbox_sessions","type":"string"},"reason":{"description":"The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.","example":"OK","type":"string"},"result":{"description":"* `1` - Success.\n* `0` - Failed. Check the `reason` field for more details.","enum":[0,1],"example":1,"type":"integer"},"version":{"description":"The version of the API function.","example":1,"type":"integer"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Stop cPanel account IMAP and POP3 connections","tags":["Email","Email Accounts"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  terminate_mailbox_sessions\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/terminate_mailbox_sessions"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_terminate_mailbox_sessions.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_terminate_mailbox_sessions.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/terminate_mailbox_sessions/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_terminate_mailbox_sessions.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_terminate_mailbox_sessions.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'terminate_mailbox_sessions'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 96"}},"/ServiceProxy/unset_all_service_proxy_backends":{"get":{"description":"This function removes a cPanel account's\n[service proxying](https://go.cpanel.net/ServiceProxying).\n\n**Note:**\n\n* If the [Web Server](https://go.cpanel.net/howtouseserverprofiles#roles) role is active on\nthe server, this function rebuilds the cPanel user's web virtual hosts (vhosts) and restarts\nthe web server.\n* If the system **cannot** rebuild the cPanel user's vhosts, the API call will still succeed.\nHowever, the function returns a failure warning in the metadata.\n* To set a service proxying for a cPanel account, use the UAPI\n`set_service_proxy_backends` function.","operationId":"serviceproxy-unset_all_service_proxy_backends","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"unset_all_service_proxy_backends","type":"string"},"module":{"description":"The name of the module called.","example":"ServiceProxy","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove cPanel account service proxying","tags":["ServiceProxy"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  ServiceProxy \\\n  unset_all_service_proxy_backends\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/ServiceProxy/unset_all_service_proxy_backends"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file ServiceProxy_unset_all_service_proxy_backends.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/ServiceProxy_unset_all_service_proxy_backends.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/ServiceProxy/,\n    q/unset_all_service_proxy_backends/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file ServiceProxy_unset_all_service_proxy_backends.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/ServiceProxy_unset_all_service_proxy_backends.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'ServiceProxy',\n    'unset_all_service_proxy_backends'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 96"}},"/cPGreyList/has_greylisting_enabled":{"get":{"description":"This function checks whether Greylisting is enabled for the cPanel account.","operationId":"has_greylisting_enabled","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"has_greylisting_enabled","type":"string"},"module":{"description":"The name of the module called.","example":"cPGreyList","type":"string"},"result":{"properties":{"data":{"properties":{"enabled":{"description":"Whether Greylisting is enabled.\n* `1` — Enabled.\n* `0` — Disabled.","enum":[0,1],"example":0,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return whether Greylisting is enabled","tags":["cPGreyList","Spam Filtering (Greylisting)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  cPGreyList \\\n  has_greylisting_enabled\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/cPGreyList/has_greylisting_enabled"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file cPGreyList_has_greylisting_enabled.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/cPGreyList_has_greylisting_enabled.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/cPGreyList/,\n    q/has_greylisting_enabled/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file cPGreyList_has_greylisting_enabled.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/cPGreyList_has_greylisting_enabled.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'cPGreyList',\n    'has_greylisting_enabled'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.50"}},"/cPGreyList/enable_all_domains":{"get":{"description":"This function enables Greylisting on all of the cPanel account's domains.","operationId":"cPGreyList-enable_all_domains","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"enable_all_domains","type":"string"},"module":{"description":"The name of the module called.","example":"cPGreyList","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"dependencies":{"description":"An array of domains that your changes will affect.","example":["this.com","that.com","theother.com"],"items":{"type":"string"},"type":"array"},"domain":{"description":"The domain.","example":"example.com","type":"string"},"enabled":{"description":"Whether Greylisting is enabled.\n* `1` — Enabled.\n* `0` — Disabled.","enum":[0,1],"example":0,"type":"integer"},"searchhint":{"description":"A comma-separated list of domain-related search terms.","example":"this, that, and the other.","type":"string"},"type":{"description":"The domain type.\n* `main` — A main domain.\n* `sub` — A subdomain.","example":"main","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* 1 — Success.\n* 0 — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable Greylisting for all domains","tags":["cPGreyList","Spam Filtering (Greylisting)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  cPGreyList \\\n  enable_all_domains\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/cPGreyList/enable_all_domains"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file cPGreyList_enable_all_domains.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/cPGreyList_enable_all_domains.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/cPGreyList/,\n    q/enable_all_domains/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file cPGreyList_enable_all_domains.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/cPGreyList_enable_all_domains.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'cPGreyList',\n    'enable_all_domains'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.50"}},"/ClamScanner/list_infected_files":{"get":{"description":"This function lists infected files from a ClamAV® virus scan.\n\n**Note**:\n\nYou must run the APIs in this order:\n\n1. Run [`ClamScanner::start_scan`](https://go.cpanel.net/ClamScanner-start-scan) to start the virus scan.\n2. Run [`ClamScanner::get_scan_status`](https://go.cpanel.net/ClamScanner-get-scan-status) in a loop until the scan is finished.\n3. Run [`ClamScanner::list_infected_files`](https://go.cpanel.net/ClamScanner-list-infected-files) to get a report of the complete list of infected files.\n4. Decide how you want to handle each infected file.\n5. Run [`ClamScanner::disinfect_files`](https://go.cpanel.net/ClamScanner-disinfect-files) to queue the disinfection of the files.\n6. Run [`ClamScanner::check_disinfection_status`](https://go.cpanel.net/ClamScanner-check-disinfection-status) in a loop until you get a done status.","operationId":"ClamScanner::list_infected_files","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_infected_files","type":"string"},"module":{"description":"The name of the module called.","example":"ClamScanner","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"file":{"description":"An absolute path to the infected file on the system.","example":"/home/username/infected_file.txt","format":"path","type":"string"},"virus_type":{"description":"A virus type.","example":"Eicar-Signature","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return infected file list","tags":["ClamScanner","Antivirus Protection (ClamAV)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  ClamScanner \\\n  list_infected_files\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/ClamScanner/list_infected_files"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file ClamScanner_list_infected_files.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/ClamScanner_list_infected_files.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/ClamScanner/,\n    q/list_infected_files/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file ClamScanner_list_infected_files.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/ClamScanner_list_infected_files.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'ClamScanner',\n    'list_infected_files'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 94"}},"/DAV/get_calendar_contacts_config":{"get":{"description":"This function returns the connection information to set up the CalDAV and CardDAV clients.","operationId":"get_calendar_contacts_config","parameters":[{"description":"A cPanel account or valid email account user.\n\nIf you do **not** include this parameter, the function defaults to the current\nauthenticated user.","in":"query","name":"user","required":false,"schema":{"oneOf":[{"description":"A cPanel account.","example":"username","format":"username","type":"string"},{"description":"A valid email account.","example":"username@example.com","format":"email","type":"string"}]}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_calendar_contacts_config","type":"string"},"module":{"description":"The name of the module called.","example":"DAV","type":"string"},"result":{"properties":{"data":{"properties":{"activesync":{"description":"Configuration details for ActiveSync.","properties":{"enabled":{"description":"Whether the server has ActiveSync enabled.\n* `1` — Enabled.\n* `0` — **Not** enabled.","enum":[1,0],"example":1,"type":"integer"},"port":{"description":"The port number the system uses for secure ActiveSync connections.","example":2091,"maximum":65535,"minimum":1,"type":"integer"},"server":{"description":"The fully qualified domain name to connect to.","example":"example.com","format":"domain","type":"string"},"user":{"description":"The cPanel user or email account user to\nwhom the returned connection information pertains.\n\nIf you do **not** specify the `user` parameter,\nthis function returns the authenticated cPanel user.","example":"username","type":"string"}},"type":"object"},"no_ssl":{"description":"A list of non-SSL connection configurations.","properties":{"calendars":{"description":"An array of objects containing the user's calendars.","items":{"properties":{"description":{"description":"The description of the calendar.","example":"Custom calendar 1.","type":"string"},"name":{"description":"The name of the calendar.","example":"Calendar 1","type":"string"},"path":{"description":"The relative URL path to the calendar.","example":"/calendars/example/calendar:ZcG9JBH68WXxfMVUgvSrUw1","type":"string"},"url":{"description":"The absolute URL to the calendar.","example":"http://example.com:2079/calendars/example/calendar:ZcG9JBH68WXxfMVUgvSrUw1","format":"url","type":"string"}},"type":"object"},"type":"array"},"contacts":{"description":"An array of objects containing the user's address books.","items":{"properties":{"description":{"description":"The description of the address book.","example":"Custom address book 1.","type":"string"},"name":{"description":"The name of the address book.","example":"Custom 1","type":"string"},"path":{"description":"The relative URL to the address book.","example":"/addressbooks/example/contacts:E-KKA5uQZyQJbTBKcGP3OQ6","type":"string"},"url":{"description":"The absolute URL to the address book.","example":"https://example.com:2080/addressbooks/example/contacts:E-KKA5uQZyQJbTBKcGP3OQ6","format":"url","type":"string"}},"type":"object"},"type":"array"},"free_busy":{"description":"The absolute URL path and HTTP port to the user's\nCalDAV `free-busy-query` connection.\n\n**Note:**\n\nThis information is useful for clients that support Autodiscovery.","example":"http://server.example.com:2079/kronolith/fb.php?u=example","format":"url","type":"string"},"full_server":{"description":"The absolute URL path and HTTP port to the user's CalDAV\nand CardDAV connection information.\n\n**Note:**\n\nThis information is useful for clients that do **not** support Autodiscovery.","example":"http://example.com:2079/rpc/principal/example","format":"url","type":"string"},"port":{"description":"The port number that the system uses for non-SSL connections.","example":2079,"maximum":65535,"minimum":1,"type":"integer"},"server":{"description":"The short server connection string that includes a domain name and a port that uses the HTTP protocol.","example":"http://example.com:2079","format":"url","type":"string"}},"type":"object"},"ssl":{"description":"A list of SSL connection configurations.","properties":{"calendars":{"description":"An array of objects containing the user's calendars.","items":{"properties":{"description":{"description":"The description of the calendar.","example":"Custom calendar 2.","type":"string"},"name":{"description":"The name of the calendar.","example":"Calendar 2","type":"string"},"path":{"description":"The relative URL path to the calendar.","example":"/calendars/example/calendar:ZcG9JBH68WXxfMVUgvSrUw1","type":"string"},"url":{"description":"The absolute URL to the calendar.","example":"http://example.com:2080/calendars/example/calendar:ZcG9JBH68WXxfMVUgvSrUw1","format":"url","type":"string"}},"type":"object"},"type":"array"},"contacts":{"description":"An array of objects containing the user's address books.","items":{"properties":{"description":{"description":"The description of the address book.","example":"Custom address book 2.","type":"string"},"name":{"description":"The name of the address book.","example":"Address book 2","type":"string"},"path":{"description":"The relative URL to the address book.","example":"/addressbooks/example/contacts:E-KKA5uQZyQJbTBKcGP3OQ6","type":"string"},"url":{"description":"The absolute URL to the address book.","example":"https://example.com:2080/addressbooks/example/contacts:E-KKA5uQZyQJbTBKcGP3OQ6","format":"url","type":"string"}},"type":"object"},"type":"array"},"free_busy":{"description":"The absolute URL path and HTTPS port to the user's CalDAV\n`free-busy-query` connection.\n\n**Note:**\n\nThis information is useful for clients that support Autodiscovery.","example":"http://server.example.com:2080/kronolith/fb.php?u=example","format":"url","type":"string"},"full_server":{"description":"The absolute URL path and HTTPS port to the user's CalDAV and\nCardDAV connection information.\n\n**Note:**\n\nThis information is useful for clients that do **not** support\nAutodiscovery.","example":"http://example.com:2080/rpc/principal/example","format":"url","type":"string"},"is_self_signed":{"description":"Whether the server uses a self-signed certificate.\n\n* `1` — Self-signed.\n* `0` — **Not** self-signed.","enum":[1,0],"example":1,"type":"integer"},"port":{"description":"The port number that the system uses for SSL connections.","example":2080,"maximum":65535,"minimum":1,"type":"integer"},"server":{"description":"The short server connection string that includes a\ndomain name and a port that uses the HTTPS protocol.\n\n**Note:**\n\nThis value is useful for clients that support Autodiscovery.","example":"https://example.com:2080","format":"url","type":"string"}},"type":"object"},"user":{"description":"The cPanel user or email account user to\nwhom the returned connection information pertains.\n\nIf you do **not** specify the `user` parameter,\nthis function returns the authenticated cPanel user.","example":"username","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return CalDAV and CardDAV connection information","tags":["DAV","Calendar and Contacts (DAV)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DAV \\\n  get_calendar_contacts_config\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DAV/get_calendar_contacts_config"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DAV_get_calendar_contacts_config.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DAV_get_calendar_contacts_config.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DAV/,\n    q/get_calendar_contacts_config/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DAV_get_calendar_contacts_config.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DAV_get_calendar_contacts_config.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DAV',\n    'get_calendar_contacts_config'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.50"}},"/DAV/is_dav_service_enabled":{"get":{"description":"This function checks whether the DAV service is enabled.","operationId":"is_dav_service_enabled","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"is_dav_service_enabled","type":"string"},"module":{"description":"The name of the module called.","example":"DAV","type":"string"},"result":{"properties":{"data":{"properties":{"enabled":{"description":"Whether the DAV service is enabled.\n* `1` — Enabled.\n* `0` — Disabled.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` — Success.\n- `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return whether DAV is enabled","tags":["DAV","Calendar and Contacts (DAV)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DAV \\\n  is_dav_service_enabled\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DAV/is_dav_service_enabled"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DAV_is_dav_service_enabled.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DAV_is_dav_service_enabled.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DAV/,\n    q/is_dav_service_enabled/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DAV_is_dav_service_enabled.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DAV_is_dav_service_enabled.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DAV',\n    'is_dav_service_enabled'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.50"}},"/Email/add_spam_filter":{"get":{"description":"This function sets a new minimum Apache SpamAssassin™ spam score threshold value.\n\n**Notes:**\n\n  * To disable spam filtering, use the UAPI `Email::disable_spam_autodelete` fuction.\n  * For more information, read our [Spam Filters](https://go.cpanel.net/cpaneldocsSpamFilters) documentation.\n\n**Important:**\n\n  * When you disable the [*Spam Filter* role](https://go.cpanel.net/serverroles#roles), the system **disables** this function.","operationId":"add_spam_filter","parameters":[{"description":"Set a spam score threshold value.\n\n**Notes:**\n\n  * You **must** specify a value greater than `0`, and lower than the domain owner's spam score threshold value.\n  * You **cannot** enter `0` as a value for this parameter.\n  * You can retrieve the domain owner‘s spam score threshold value via the `cpuser_spam_auto_delete_score` return from the UAPI `Email::get_spam_settings` function.\n  * The default value, `5`, is an aggressive spam score.\n  * The lower the spam score, the more likely that Apache SpamAssassin will label messages as spam and delete them.\n  * Some systems may wish to use a more lenient spam score (for example, `8` or `10`).","in":"query","name":"required_score","required":false,"schema":{"default":5,"example":"8","minimum":1,"type":"string"}},{"description":"The email account to apply a spam score threshold value.\n\n**Note:**\n\n  If you do **not** specify a value, the function applies the new spam score threshold value to **all** accounts.","in":"query","name":"account","required":false,"schema":{"example":"username@example.com","format":"email","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"add_spam_filter","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update minimum spam score threshold value","tags":["Email","Spam Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  add_spam_filter\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/add_spam_filter"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_add_spam_filter.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_add_spam_filter.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/add_spam_filter/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_add_spam_filter.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_add_spam_filter.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'add_spam_filter'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/cPGreyList/disable_all_domains":{"get":{"description":"This function disables Greylisting on a cPanel account's domains.","operationId":"cPGreyList-disable_all_domains","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"disable_all_domains","type":"string"},"module":{"description":"The name of the module called.","example":"cPGreyList","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"dependencies":{"description":"The domains that your changes will affect.","example":["this.com","that.com","theother.com"],"items":{"type":"string"},"type":"array"},"domain":{"description":"The domain.","example":"example.com","type":"string"},"enabled":{"description":"Whether Greylisting is enabled.\n- `1` — Enabled.\n- `0` — Disabled.","enum":[0,1],"example":0,"type":"integer"},"searchhint":{"description":"A comma-separated list of domain-related search terms.","example":"this, that, the other","type":"string"},"type":{"description":"The domain type.\n- `main` — A main domain.\n- `addon` — An addon domain.\n- `parked` — A parked domain.","enum":["main","addon","parked"],"example":"main","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 — Success.\n- 0 — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Disable Greylisting for all domains","tags":["cPGreyList","Spam Filtering (Greylisting)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  cPGreyList \\\n  disable_all_domains\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/cPGreyList/disable_all_domains"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file cPGreyList_disable_all_domains.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/cPGreyList_disable_all_domains.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/cPGreyList/,\n    q/disable_all_domains/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file cPGreyList_disable_all_domains.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/cPGreyList_disable_all_domains.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'cPGreyList',\n    'disable_all_domains'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.50"}},"/NginxCaching/clear_cache":{"get":{"description":"This function clears the user's NGINX cache.\n\n**Note:**\n\n  - You can **only** use this function if you installed the `ea-nginx` package.","operationId":"clear_cache","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"clear_cache","type":"string"},"module":{"description":"The name of the module called.","example":"NginxCaching","type":"string"},"result":{"properties":{"data":{"properties":{}},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete NGINX cache contents.","tags":["NginxCaching"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  NginxCaching \\\n  clear_cache\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/NginxCaching/clear_cache"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file NginxCaching_clear_cache.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/NginxCaching_clear_cache.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/NginxCaching/,\n    q/clear_cache/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file NginxCaching_clear_cache.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/NginxCaching_clear_cache.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'NginxCaching',\n    'clear_cache'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 100"}},"/SSL/set_default_key_type":{"get":{"description":"This function sets a user’s preferred SSL/TLS key type.","operationId":"SSL::set_default_key_type","parameters":[{"description":"The key type to set.\n\n* `system` — Use the system’s `ssl_default_key_type` value.\n* `rsa-2048` — 2,048-bit RSA.\n* `rsa-4096` — 4,096-bit RSA.\n* `ecdsa-prime256v1` — ECDSA prime256v1 (“P-256”).\n* `ecdsa-secp384r1` — ECDSA secp384r1 (“P-384”).","example":"ecdsa-prime256v1","in":"query","name":"type","required":true,"schema":{"enum":["system","rsa-2048","rsa-4096","ecdsa-prime256v1","ecdsa-secp384r1"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_default_key_type","type":"string"},"module":{"description":"The name of the module called.","example":"SSL","type":"string"},"result":{"properties":{"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update SSL TLS key type","tags":["SSL","cPanel Account SSL Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  SSL \\\n  set_default_key_type \\\n  type='ecdsa-prime256v1'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/SSL/set_default_key_type?type=ecdsa-prime256v1"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_set_default_key_type.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/SSL_set_default_key_type.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/SSL/,\n    q/set_default_key_type/,\n    {\n        'type' => 'ecdsa-prime256v1',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_set_default_key_type.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/SSL_set_default_key_type.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'SSL',\n    'set_default_key_type',\n    array (\n        'type' => 'ecdsa-prime256v1',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 92"}},"/NginxCaching/reset_cache_config":{"get":{"description":"This function resets the user's NGINX caching configuration.\n\n**Note:**\n\n  - You can **only** use this function if you installed the `ea-nginx` package.","operationId":"reset_cache_config","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"reset_cache_config","type":"string"},"module":{"description":"The name of the module called.","example":"NginxCaching","type":"string"},"result":{"properties":{"data":{"properties":{}},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Reset the user's NGINX cache configuration","tags":["NginxCaching"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  NginxCaching \\\n  reset_cache_config\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/NginxCaching/reset_cache_config"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file NginxCaching_reset_cache_config.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/NginxCaching_reset_cache_config.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/NginxCaching/,\n    q/reset_cache_config/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file NginxCaching_reset_cache_config.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/NginxCaching_reset_cache_config.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'NginxCaching',\n    'reset_cache_config'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 100"}},"/Chkservd/get_exim_ports":{"get":{"description":"This function lists the ports on which Exim listens.","operationId":"get_exim_ports","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_exim_ports","type":"string"},"module":{"description":"The name of the module called.","example":"Chkservd","type":"string"},"result":{"properties":{"data":{"properties":{"ports":{"description":"An array of port numbers on which Exim listens.","items":{"example":25,"maximum":65535,"minimum":1,"type":"integer"},"type":"array","uniqueItems":true}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return outgoing (SMTP) mail port","tags":["Chkservd","Mail Server Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Chkservd \\\n  get_exim_ports\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Chkservd/get_exim_ports"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Chkservd_get_exim_ports.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Chkservd_get_exim_ports.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Chkservd/,\n    q/get_exim_ports/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Chkservd_get_exim_ports.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Chkservd_get_exim_ports.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Chkservd',\n    'get_exim_ports'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Team/set_password":{"get":{"description":"This function replaces the current password with a new one.","operationId":"set_team_user_password","parameters":[{"description":"The username of the team user.","in":"query","name":"user","required":true,"schema":{"example":"teamuser","type":"string"}},{"description":"The password to set for the team user.","in":"query","name":"password","required":true,"schema":{"example":"securepassword","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_password","type":"string"},"module":{"description":"The name of the module called.","example":"Team","type":"string"},"result":{"properties":{"data":{"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Set password for a team user","tags":["Team Users"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Team \\\n  set_password \\\n  user='teamuser' \\\n  password='securepassword'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Team/set_password?user=teamuser&password=securepassword"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account, where theme-name represents\n# jupiter.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Team_set_password.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Team_set_password.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Team/,\n    q/set_password/,\n    {\n        'user' => 'teamuser',\n        'password' => 'securepassword',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account, where theme-name represents\n// jupiter.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Team_set_password.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Team_set_password.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Team',\n    'set_password',\n    array (\n        'user' => 'teamuser',\n        'password' => 'securepassword',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}\n"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":106}},"/DCV/check_domains_via_dns":{"post":{"description":"This function checks whether the account's domains can pass Domain Control Validation (DCV) via a DNS request.","operationId":"check_domains_via_dns","parameters":[{"description":"The domain or domains to check.\n\n**Note:**\n\n To check multiple domains, increment the parameter name. For example, `domain-0`, `domain-1`, and `domain-2`.","examples":{"multiple":{"summary":"Check multiple domains.","value":"domain-0=example.com&domain-1=example2.com"},"single":{"summary":"Check a single domain.","value":"example.com"}},"in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"check_domains_via_dns","type":"string"},"module":{"description":"The name of the module called.","example":"DCV","type":"string"},"result":{"properties":{"data":{"description":"An array of objects containing the results from each `domain` parameter’s DCV check.\n\n**Note:**\n\n The function returns the results from the `domain` parameter in the same order in which you called them.","items":{"properties":{"dcv_string":{"description":"The expected value of the queried DNS record.","example":"_dcv-test-record=wsWRlG9IsG7KNnLdIsx9Oz2oTw8m5q0imRR9L6LnDBz14sZelvDHqrJyJc6LA0DY","type":"string"},"domain":{"description":"The domain that the system verified.","example":"example.com","format":"domain","type":"string"},"failure_reason":{"description":"A message that contains the reason why the DCV check failed.\n\n**Note:**\n\n  If the server fails to update the DNS zone, the system returns this value.","example":"The DNS query to _dcv-test-record.example2.org for the DCV challenge returned no TXT record that matches the value _dcv-test-record=wRUFPTN1DskKDG8KHfYM_5cQF5QUGWq1_A2ovO8rKsrIYO_HilAjsQABFCrbJkLX.","type":"string"},"query_results":{"description":"The strings that the DNS query returned. This array may be empty.\n\n**Note:**\n\n If the server fails to update the DNS zone, the system returns the `failure_reason` value.","example":["_dcv-test-record=wsWRlG9IsG7KNnLdIsx9Oz2oTw8m5q0imRR9L6LnDBz14sZelvDHqrJyJc6LA0DY"],"items":{"type":"string"},"type":"array"},"succeeded":{"description":"Whether the DCV check succeeded.\n- `1` - At least one of the `query_results` values equals the `dcv_string` value.\n- `0` - None of the `query_results` values equal the `dcv_string` value.","enum":[1,0],"example":1,"type":"integer"},"zone":{"description":"The altered and queried DNS zone name.","example":"example.com","format":"domain","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Verify domain ownership via DNS","tags":["DCV","Verify Domain Ownership"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DCV \\\n  check_domains_via_dns \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DCV/check_domains_via_dns?domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DCV_check_domains_via_dns.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DCV_check_domains_via_dns.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DCV/,\n    q/check_domains_via_dns/,\n    {\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DCV_check_domains_via_dns.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DCV_check_domains_via_dns.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DCV',\n    'check_domains_via_dns',\n    array (\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 74"}},"/CCS/remove_delegate":{"get":{"description":"This function removes a delegate from another user's calendar.\n\n**Note:**\n\nYou **must** install the [Calendar and Contacts Server](https://go.cpanel.net/CalendarAndContactsServer) cPanel plugin to access this API function.","operationId":"remove_delegate","parameters":[{"description":"The calendar's owner.","in":"query","name":"delegator","required":true,"schema":{"example":"user1@example.com","format":"email","type":"string"}},{"description":"The user from whom you wish to remove delegation rights.","in":"query","name":"delegatee","required":true,"schema":{"example":"user2@example.com","format":"email","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"remove_delegate","type":"string"},"module":{"description":"The name of the module called.","example":"CCS","type":"string"},"result":{"properties":{"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` - Success.\n- `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove calendar delegation","tags":["CCS","Calendar and Contacts Server"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  CCS \\\n  remove_delegate \\\n  delegator='user1@example.com' \\\n  delegatee='user2@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/CCS/remove_delegate?delegator=user1%40example.com&delegatee=user2%40example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file CCS_remove_delegate.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/CCS_remove_delegate.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/CCS/,\n    q/remove_delegate/,\n    {\n        'delegator' => 'user1@example.com',\n        'delegatee' => 'user2@example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file CCS_remove_delegate.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/CCS_remove_delegate.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'CCS',\n    'remove_delegate',\n    array (\n        'delegator' => 'user1@example.com',\n        'delegatee' => 'user2@example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 90"}},"/Team/remove_roles":{"get":{"description":"This function removes roles from a team user.","operationId":"remove_roles","parameters":[{"description":"The username of the team user.","in":"query","name":"user","required":true,"schema":{"example":"teamuser","type":"string"}},{"description":"The role or roles to remove from the team user.","in":"query","name":"role","required":true,"schema":{"example":"database","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"remove_roles","type":"string"},"module":{"description":"The name of the module called.","example":"Team","type":"string"},"result":{"properties":{"data":{"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove roles from a team user","tags":["Team Users"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Team \\\n  remove_roles \\\n  user='teamuser' \\\n  role='database'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Team/remove_roles?user=teamuser&role=database"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Team_remove_roles.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Team_remove_roles.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Team/,\n    q/remove_roles/,\n    {\n        'user' => 'teamuser',\n        'role' => 'database',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Team_remove_roles.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Team_remove_roles.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Team',\n    'remove_roles',\n    array (\n        'user' => 'teamuser',\n        'role' => 'database',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":108}},"/DCV/check_domains_via_http":{"get":{"description":"This function checks whether the account's domains can pass Domain Control Validation (DCV) via an HTTP request.","operationId":"check_domains_via_http","parameters":[{"description":"The domains to check.\n\n**Note:**\n\nTo check more than one domain, repeat or increment the parameter name. For\nexample, `domain-1`, `domain-2`, and `domain-3`.","examples":{"multiple":{"summary":"Check multiple domains.","value":"domain-1=example.com&domain-2=example2.com&domain-3=example2.com"},"single":{"summary":"Check a single domain.","value":"example.com"}},"in":"query","name":"domain","required":true,"schema":{"format":"domain","type":"string"}},{"description":"An array of characters that the certificate provider allows in the DCV check file's filename.","in":"query","name":"dcv_file_allowed_characters","required":false,"schema":{"default":["A","B","C","D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z",0,1,2,3,4,5,6,7,8,9],"items":{"type":"string"},"type":"array"}},{"description":"The number of characters that the certificate provider allows in the DCV check file's filename.","in":"query","name":"dcv_file_random_character_count","required":false,"schema":{"default":100,"example":32,"minimum":1,"type":"integer"}},{"description":"The DCV check file extension that the certificate provider requires.","in":"query","name":"dcv_file_extension","required":false,"schema":{"default":"","example":"txt","type":"string"}},{"description":"The DCV check file's file path, relative to the domain's document `root` directory.","in":"query","name":"dcv_file_relative_path","required":false,"schema":{"default":".well-known/pki-validation","example":".well-known/pki-validation","type":"string"}},{"description":"The [user agent string](https://wikipedia.org/wiki/User_agent) that the system uses for the imitated local DCV check.\n\n**Important:**\n\nThe default value can change at any time.","in":"query","name":"dcv_user_agent_string","required":false,"schema":{"example":"SECTIGO+DCV","type":"string"}},{"description":"The number of domain redirects the system permits the DCV check to follow. The function checks the provider's supported number of redirects.\nIt will then return the `redirect` array of objects for the passed value, plus one. This ensures the function will display any redirects causing DCV failures, if any exist.\n\n**Note:**\n\n* If you pass a `0` value, this function does **not** limit the number of redirect returns.\n* Use the `Market::get_provider_specific_dcv_constraints` UAPI function to list a provider's supported number of redirects.","in":"query","name":"dcv_max_redirects","required":false,"schema":{"default":null,"example":2,"minimum":0,"nullable":true,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"check_domains_via_http","type":"string"},"module":{"description":"The name of the module called.","example":"DCV","type":"string"},"result":{"properties":{"data":{"description":"An array of objects that contains results from each domain's DCV check.\n\n**Note:**\n\n The function returns the domain's results in the same order that you pass them in the `domain` parameter.","items":{"properties":{"failure_reason":{"description":"The reason that the DCV check failed.\n* `null` — The domain passed the DCV check.","example":"The system queried for a temporary file at http://example.com/.well-known/pki-validationD01511F4E E535A5442FC378AA946CF41.txt, but the web server responded with the following error: 404 (Not Found). A DNS (Domain Name System) or web server misconfiguration may exist. The domain example.com resolved to an IP address 93.184.216.34 that does not exist on this server.","nullable":true,"type":"string"},"redirects":{"description":"An array of objects that contains DCV check redirect information.\n\n**Note:**\n\n This **only** contains data if the `redirects_count` return includes a value greater than zero.","items":{"properties":{"content":{"description":"A message that explains why the function failed.","example":"<!DOCTYPE HTML PUBLIC \\\"-//IETF//DTD HTML 2.0//EN\\\">\\n<html><head>\\n<title>301 Moved Permanently</title>\\n </head><body>\\n<h1>Moved Permanently</h1>\\n <p>The document has moved <a href=\\\"http://www.example.com/.well-known/pki-validation/770102 17B0CCF0CCF6211602F9A1B2B2.txt\\\">here</a>.</p>\\n</body></html>\\n","type":"string"},"headers":{"description":"An object that contains the [HTTP::Tiny](http://search.cpan.org/~dagolden/HTTP-Tiny-0.070/lib/HTTP/Tiny.pm) CPAN module returns.\n\n**Note:**\n\n  This object's contents vary according to the URL's headers.","type":"object"},"protocol":{"description":"The URL's HTTP protocol.","example":"HTTP/1.1","type":"string"},"reason":{"description":"The HTTP response status message.","example":"Moved Permanently","type":"string"},"redirects":{"description":"An array of objects containing the redirects, if the value exists.","example":null,"nullable":true,"type":"array"},"status":{"description":"The [HTTP response status code](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes).","example":301,"type":"integer"},"success":{"description":"Whether the server returns a [2XX HTTP status code](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#2xx_Success).\n* `1` — The server returns a 2XX status code.\n* `0` or an empty string — The server does **not** return a 2XX status code.","example":"","oneOf":[{"enum":[""],"type":"string"},{"enum":[0,1],"type":"integer"}]},"url":{"description":"The URL that the function searches for the DCV file.","example":"http://example.com/.well-known/pki-validation/77010217B0CCF0CCF6211602F9A1B2B2.txt","format":"url","type":"string"}},"type":"object"},"type":"array"},"redirects_count":{"description":"The number of HTTP redirects that the DCV check follows.","example":0,"minimum":0,"type":"integer"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Verify domain ownership via HTTP","tags":["DCV","Verify Domain Ownership"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DCV \\\n  check_domains_via_http \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DCV/check_domains_via_http?domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DCV_check_domains_via_http.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DCV_check_domains_via_http.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DCV/,\n    q/check_domains_via_http/,\n    {\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DCV_check_domains_via_http.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DCV_check_domains_via_http.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DCV',\n    'check_domains_via_http',\n    array (\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 60"}},"/ClamScanner/get_scan_status":{"get":{"description":"This function gets the status of a ClamAV® scan on a directory.\n\n**Note**:\n\nYou must run the APIs in this order:\n\n1. Run [`ClamScanner::start_scan`](https://go.cpanel.net/ClamScanner-start-scan) to start the virus scan.\n2. Run [`ClamScanner::get_scan_status`](https://go.cpanel.net/ClamScanner-get-scan-status) in a loop until the scan is finished.\n3. Run [`ClamScanner::list_infected_files`](https://go.cpanel.net/ClamScanner-list-infected-files) to get a report of the complete list of infected files.\n4. Decide how you want to handle each infected file.\n5. Run [`ClamScanner::disinfect_files`](https://go.cpanel.net/ClamScanner-disinfect-files) to queue the disinfection of the files.\n6. Run [`ClamScanner::check_disinfection_status`](https://go.cpanel.net/ClamScanner-check-disinfection-status) in a loop until you get a done status.","operationId":"ClamScanner::get_scan_status","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_scan_status","type":"string"},"module":{"description":"The name of the module called.","example":"ClamScanner","type":"string"},"result":{"properties":{"data":{"properties":{"current_file":{"description":"The current file being scanned.","example":"/home/username/afilename.txt","type":"string"},"infected_files":{"description":"List of files scanned and found to be infected.","example":["/home/username/afile/witha/virus.txt","/home/username/we/gotcha.exe"],"type":"array"},"scan_complete":{"description":"Whether the last scan has completed.\n* `1` - scan has completed.\n* `0` - scan has **not** completed.","enum":[0,1],"example":1,"type":"integer"},"scanned_file_count":{"description":"The number of files already scanned.","example":135,"minimum":0,"type":"integer"},"scanned_file_size":{"description":"The number of bytes of data scanned.","example":6022,"minimum":0,"type":"integer"},"time_started":{"description":"The epoch timestamp of the beginning of the last scan.","example":"1608593571","minimum":0,"type":"string"},"total_file_count":{"description":"The total number of files found to scan.","example":135,"minimum":0,"type":"integer"},"total_file_size_MiB":{"description":"The total number of megabytes of data found to scan.","example":3640222,"minimum":0,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Request virus scan status","tags":["ClamScanner","Antivirus Protection (ClamAV)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  ClamScanner \\\n  get_scan_status\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/ClamScanner/get_scan_status"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file ClamScanner_get_scan_status.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/ClamScanner_get_scan_status.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/ClamScanner/,\n    q/get_scan_status/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file ClamScanner_get_scan_status.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/ClamScanner_get_scan_status.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'ClamScanner',\n    'get_scan_status'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 94"}},"/DNS/mass_edit_zone":{"get":{"description":"This function updates a given DNS zone. It can add, edit,\nand remove many records in a single call. It also ensures\nthat each record not removed will occupy the same\nnumber of lines after the edit as it did before the edit.","operationId":"dns-mass_edit_zone","parameters":[{"description":"The name of one of the user’s DNS zones.","in":"query","name":"zone","required":true,"schema":{"example":"example.com","type":"string"}},{"description":"The current serial number in the DNS zone’s SOA (Start of Authority)\nrecord. If this value does not match the zone’s current state, the\nrequest fails.","in":"query","name":"serial","required":true,"schema":{"example":202001010100,"minimum":0,"type":"integer"}},{"description":"The records to add to the zone. Each item must be a serialized\nJSON object that contains:\n\n* `dname` — The record’s name.\n* `ttl` — The record’s TTL (Time-To-Live) value.\n* `record_type` — The record’s type. For example, `A` or `TXT`.\n* `data` — An array of strings. The format and number of the\n  strings depend on the `record_type` value.","examples":{"a":{"description":"An A record.","value":"'{\"dname\":\"example\", \"ttl\":14400, \"record_type\":\"A\", \"data\":[\"11.22.33.44\"]}'"},"aaaa":{"description":"A TXT record.","value":"'{\"dname\":\"example\", \"ttl\":14400, \"record_type\":\"TXT\", \"data\":[\"string1\", \"string2\"]}'"}},"explode":true,"in":"query","name":"add","required":false,"schema":{"items":{"format":"json","type":"string"},"type":"array"}},{"description":"The records to edit in the zone. Each item must be a serialized\nJSON object that contains:\n\n* `line_index` — The line number in the DNS zone where the record starts.\n  This is a 0-based index, so to edit the first line in the file\n  use the `0` value. To edit the second line, give `1`, and so forth.\n* `dname` — The record’s name.\n* `ttl` — The record’s TTL (Time-To-Live) value.\n* `record_type` — The record’s new type. For example, `A` or `TXT`.\n* `data` — An array of strings. The format and number of the\n  strings depend on the `record_type` value.","explode":true,"in":"query","name":"edit","required":false,"schema":{"items":{"example":"'{\"line_index\": 9, \"dname\":\"example\", \"ttl\":14400, \"record_type\":\"TXT\", \"data\":[\"string1\", \"string2\"]}'","format":"json","type":"string"},"type":"array"}},{"description":"The line indexes of records to remove from the zone.","explode":true,"in":"query","name":"remove","required":false,"schema":{"items":{"example":22,"minimum":0,"type":"integer"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"mass_edit_zone","type":"string"},"module":{"description":"The name of the module called.","example":"DNS","type":"string"},"result":{"properties":{"data":{"properties":{"new_serial":{"description":"The DNS zone’s SOA record’s new serial number.\nYou can use this to submit later edits if you\ntrack the number of lines each record takes up.","example":2021031903,"minimum":0,"type":"integer"}}},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update a DNS zone","tags":["DNS","DNS Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty --user=username DNS mass_edit_zone zone='example.com' serial='202001010100' remove=23 add='{\"dname\":\"example\",\"ttl\":14400,\"record_type\":\"A\",\"data\":[\"127.0.0.1\"]}'"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DNS/mass_edit_zone?zone=example.com&serial=202001010100&remove=23"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DNS_mass_edit_zone.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DNS_mass_edit_zone.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DNS/,\n    q/mass_edit_zone/,\n    {\n        'zone' => 'example.com',\n        'serial' => '202001010100',\n        'add' => '{\"dname\":\"example\",\"ttl\":14400,\"record_type\":\"A\",\"data\":[\"127.0.0.1\"]}',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DNS_mass_edit_zone.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DNS_mass_edit_zone.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DNS',\n    'mass_edit_zone',\n    array (\n        'zone' => 'example.com',\n        'serial' => '202001010100',\n        'add' => '{\"dname\":\"example\",\"ttl\":14400,\"record_type\":\"A\",\"data\":[\"127.0.0.1\"]}',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":96}},"/DynamicDNS/delete":{"get":{"description":"This function deletes an existing Dynamic DNS (DDNS) domain.\n\n**Important:**\n\nWhen you disable the [_DNS_ role](https://go.cpanel.net/serverroles), the system disables this function.","operationId":"dynamicdns-delete","parameters":[{"description":"The DDNS domain’s ID.","in":"query","name":"id","required":true,"schema":{"example":"ggiugyxxjwnkmqtwysgmvrurplmafxpq","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"delete","type":"string"},"module":{"description":"The name of the module called.","example":"DynamicDNS","type":"string"},"result":{"properties":{"data":{"description":"Information about the deletion.","properties":{"deleted":{"description":"Whether a DDNS domain with the given ID existed for deletion.\n\n* `0` - No DDNS domain with the given ID existed.\n* `1` - A DDNS domain with the given ID existed but is now deleted.","enum":[0,1],"example":1,"type":"number"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete Dynamic DNS domain","tags":["DynamicDNS","Dynamic DNS"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DynamicDNS \\\n  delete \\\n  id='ggiugyxxjwnkmqtwysgmvrurplmafxpq'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DynamicDNS/delete?id=ggiugyxxjwnkmqtwysgmvrurplmafxpq"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DynamicDNS_delete.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DynamicDNS_delete.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DynamicDNS/,\n    q/delete/,\n    {\n        'id' => 'ggiugyxxjwnkmqtwysgmvrurplmafxpq',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DynamicDNS_delete.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DynamicDNS_delete.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DynamicDNS',\n    'delete',\n    array (\n        'id' => 'ggiugyxxjwnkmqtwysgmvrurplmafxpq',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":82}},"/DNS/swap_ip_in_zones":{"get":{"description":"This function replaces a domain's IPv4 address in the DNS zone\nfile with the specified destination IPv4 address.","operationId":"DNS-swap_ip_in_zones","parameters":[{"description":"The domain to perform the zone file updates on.\n\n**Note:**\n\nTo update multiple domains, increment or duplicate the parameter name. For\nexample, `domain-0`, `domain-1`, and `domain-2`.","examples":{"multiple":{"summary":"Update multiple domains.","value":"example.com domain-1=example1.com domain-2=example2.com"},"multiple-alternative":{"summary":"Update multiple domains.","value":"example.com domain=example1.com domain=example2.com"},"single":{"summary":"Update a single domain.","value":"example.com"}},"in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}},{"description":"The IPv4 address to replace in the zone files. The detected source IPv4 address is one of:\n\n* If there is an A record for the root of the zone **and** the IP address is **not** a loopback address, then the system will use its address.\n* If there are any A records in the zone whose addresses are **not** loopback addresses, then the system will use the address of the first such A record in the zone file.\n* If no A records exist in the zone **or** all A records have loopback addresses, then the system will **not** update the zone file.\n\nIf you do **not** call this parameter, the system will automatically detect the IP addresses in the zone files.","in":"query","name":"source_ip","required":false,"schema":{"type":"string","format":"ipv4","example":"192.0.2.0"}},{"description":"The IPv4 address to use as the replacement in the zone files.","in":"query","name":"dest_ip","required":true,"schema":{"type":"string","format":"ipv4","example":"192.0.2.1"}},{"description":"The IPv4 address to use as the replacement for FTP records in the zone files.\n\nIf this parameter is **not** provided, then the system will use the `dest_ip` value.","in":"query","name":"ftp_ip","required":false,"schema":{"type":"string","format":"ipv4","example":"192.0.2.1"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"swap_ip_in_zones","type":"string"},"module":{"description":"The name of the module called.","example":"DNS","type":"string"},"result":{"properties":{"data":{"description":"An array of objects containing the updated DNS records, including their previous values.","items":{"properties":{"zone_name":{"description":"The DNS zone in which the system updated the domain's record.","format":"domain","nullable":false,"type":"string","example":"example.com"},"record_name":{"description":"The name of the domain's updated DNS record.","format":"domain","nullable":false,"type":"string","example":"example.com"},"record_type":{"description":"The type of the DNS record which was updated.","type":"string","example":"A"},"old_value":{"description":"The value of the DNS record before it was updated.","type":"string","example":"192.0.2.0"},"new_value":{"description":"The value of the DNS record after it was updated.","type":"string","example":"192.0.2.1"}}}},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update IP addresses in zone files","tags":["DNS"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --user=username DNS swap_ip_in_zones domain='example.com' source_ip='192.0.2.0' dest_ip='192.0.2.1'"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DNS/swap_ip_in_zones?domain=example.com&source_ip=192.0.2.0&dest_ip=192.0.2.1"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DNS_swap_ip_in_zones.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DNS_swap_ip_in_zones.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DNS/,\n    q/swap_ip_in_zones/,\n    {\n        'domain'    => 'example.com',\n        'source_ip' => '192.0.2.0',\n        'dest_ip'   => '192.0.2.1',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DNS_swap_ip_in_zones.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DNS_swap_ip_in_zones.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DNS',\n    'swap_ip_in_zones',\n    array (\n        'domain'    => 'example.com',\n        'source_ip' => '192.0.2.0',\n        'dest_ip'   => '192.0.2.1',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 96"}},"/DynamicDNS/recreate":{"get":{"description":"This function gives a new, randomly-generated ID to an existing Dynamic DNS (DDNS) domain.\n\n**Important:**\n\nWhen you disable the [_DNS_ role](https://go.cpanel.net/serverroles), the system disables this function.","operationId":"dynamicdns-recreate","parameters":[{"description":"The DDNS domain’s ID.","in":"query","name":"id","required":true,"schema":{"example":"ggiugyxxjwnkmqtwysgmvrurplmafxpq","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"recreate","type":"string"},"module":{"description":"The name of the module called.","example":"DynamicDNS","type":"string"},"result":{"properties":{"data":{"description":"Information about the DDNS domain.","properties":{"id":{"description":"The DDNS domain’s new ID.","example":"ggiugyxxjwnkmqtwysgmvrurplmafxpq","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update Dynamic DNS domain ID","tags":["DynamicDNS","Dynamic DNS"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DynamicDNS \\\n  recreate \\\n  id='ggiugyxxjwnkmqtwysgmvrurplmafxpq'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DynamicDNS/recreate?id=ggiugyxxjwnkmqtwysgmvrurplmafxpq"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DynamicDNS_recreate.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DynamicDNS_recreate.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DynamicDNS/,\n    q/recreate/,\n    {\n        'id' => 'ggiugyxxjwnkmqtwysgmvrurplmafxpq',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DynamicDNS_recreate.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DynamicDNS_recreate.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DynamicDNS',\n    'recreate',\n    array (\n        'id' => 'ggiugyxxjwnkmqtwysgmvrurplmafxpq',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":82}},"/get_php_recommendations":{"get":{"description":"This function returns a list of recommended PHP versions.","operationId":"EA4::get_php_recommendations","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_php_recommendations","type":"string"},"module":{"description":"The name of the module called.","example":"EA4","type":"string"},"result":{"properties":{"data":{"description":"An array of recommended PHP versions.","items":{"example":"php80","type":"string"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Get custom PHP recommendations.","tags":["PHP"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  EA4 \\\n  get_php_recommendations\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/EA4/get_php_recommendations"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file EA4_get_php_recommendations.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/EA4_get_php_recommendations.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/EA4/,\n    q/get_php_recommendations/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file EA4_get_php_recommendations.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/EA4_get_php_recommendations.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'EA4',\n    'get_php_recommendations'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":82}},"/DynamicDNS/set_description":{"get":{"description":"This function sets the description on a user’s Dynamic DNS (DDNS) domain.\n\n**Important:**\n\nWhen you disable the [_DNS_ role](https://go.cpanel.net/serverroles), the system disables this function.","operationId":"dynamicdns-set_description","parameters":[{"description":"The DDNS domain’s ID.","in":"query","name":"id","required":true,"schema":{"example":"ggiugyxxjwnkmqtwysgmvrurplmafxpq","type":"string"}},{"description":"A human-readable string that describes the domain.","in":"query","name":"description","required":true,"schema":{"example":"Home network","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list","type":"string"},"module":{"description":"The name of the module called.","example":"DynamicDNS","type":"string"},"result":{"properties":{"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update Dynamic DNS domain description","tags":["DynamicDNS","Dynamic DNS"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DynamicDNS \\\n  set_description \\\n  id='ggiugyxxjwnkmqtwysgmvrurplmafxpq' \\\n  description='Home network'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DynamicDNS/set_description?id=ggiugyxxjwnkmqtwysgmvrurplmafxpq&description=Home%20network"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DynamicDNS_set_description.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DynamicDNS_set_description.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DynamicDNS/,\n    q/set_description/,\n    {\n        'id' => 'ggiugyxxjwnkmqtwysgmvrurplmafxpq',\n        'description' => 'Home network',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DynamicDNS_set_description.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DynamicDNS_set_description.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DynamicDNS',\n    'set_description',\n    array (\n        'id' => 'ggiugyxxjwnkmqtwysgmvrurplmafxpq',\n        'description' => 'Home network',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":82}},"/get_recommendations":{"get":{"description":"This function retrieves a list of EasyApache 4 (EA4) configuration recommendations.","operationId":"get_recommendations","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_recommendations","type":"string"},"module":{"description":"The name of the module called.","example":"EA4","type":"string"},"result":{"properties":{"data":{"additionalProperties":{"description":"An object that contains recommendation information about a package.\n\n**Note:**\n\nThe function uses the name of the referenced package as the return name.","items":{"properties":{"desc":{"description":"The recommendation's description.\n\n**Note:**\n\nThe function **only** returns this value if one exists.","type":"string"},"level":{"description":"The level that triggers a recommendation to appear, based on [Bootstrap 3 alert components](http://getbootstrap.com/components/#alerts).\n\n* `primary`\n* `success`\n* `info`\n* `warning`\n* `danger`\n\n**Note:**\n\n* The function **only** returns this value if one exists.\n* This return's value only affects the UI if set to `danger`.","enum":["primary","success","info","warning","danger"],"type":"string"},"name":{"description":"The recommendation's name.","type":"string"},"on":{"description":"The action that triggers a recommendation.\n\n* `add`\n* `remove`","enum":["add","remove"],"type":"string"},"options":{"description":"An object that contains each option for the package's recommendations.","items":{"properties":{"items":{"description":"An array of information that corresponds with a text value.\n\n**Note:**\n\nThe function **only** returns this value if one exists.","items":{"type":"string"},"type":"array"},"level":{"description":"The level that triggers a recommendation to appear, based on [Bootstrap 3 alert components](http://getbootstrap.com/components/#alerts).\n\n* `primary`\n* `success`\n* `info`\n* `warning`\n* `danger`\n\n**Note:**\n\n* The function **only** returns this value if one exists.\n* This return's value only affects the UI if set to `danger`.","enum":["primary","success","info","warning","danger"],"type":"string"},"recommended":{"description":"The type of recommendation that the interface will return.\n\n* `true` - Recommended.\n* `false` - Not recommended.\n\n**Note:**\n\n* The function **only** returns this value if one exists.\n* If the function does **not** return this value, then the interface will display informational text.","type":"boolean"},"text":{"description":"The text that the user interface displays.","type":"string"},"url":{"description":"A URL that provides more information.\n\n**Note:**\n\nThe function **only** returns this value if one exists.","format":"url","type":"string"}},"type":"object"},"type":"array"},"url":{"description":"A URL to provide more information.\n\n**Note:**\n\nThe function **only** returns this value if one exists.","format":"url","type":"string"}},"type":"object"},"type":"array"},"example":{"ea-php55-php":[{"desc":"PHP DSO runs as the user [asis,nobody] by default. In a shared hosting environment, this is a security issue.","level":"danger","name":"PHP DSO","on":"add","options":[{"items":["ea-apache24-mod_ruid2","ea-apache24-mod_mpm_itk"],"level":"success","recommended":true,"text":"We strongly recommend that you install one of the following packages unless this is a single-user system:"},{"level":"warning","recommended":false,"text":"If you use suPHP, you will add some security, but may experience performance issues on your server."}],"url":"https://www.example.com"}]},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` – Success.\n* `0` – Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Get EA4 configuration recommendations","tags":["EA4"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  EA4 \\\n  get_recommendations\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/EA4/get_recommendations"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file EA4_get_recommendations.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/EA4_get_recommendations.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/EA4/,\n    q/get_recommendations/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file EA4_get_recommendations.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/EA4_get_recommendations.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'EA4',\n    'get_recommendations'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 84"}},"/ServiceProxy/set_service_proxy_backends":{"get":{"description":"This function lets you configure a cPanel account's\n[service proxying](https://go.cpanel.net/ServiceProxying).\n\n**Note:**\n\n* If the [Web Server](https://go.cpanel.net/howtouseserverprofiles#roles) role is active\non the server, this function rebuilds the user's web virtual hosts (vhosts) and restarts\nthe web server.\n* If the system cannot rebuild the user's vhosts, the API call will still succeed. However,\nthe function returns a failure warning in the metadata.\n* To remove an account's service proxying, use the UAPI `unset_all_service_proxy_backends`\nfunction.","operationId":"serviceproxy-set_service_proxy_backends","parameters":[{"description":"The hostname or IP address to assign as the server that handles\nthe account's service proxy requests.\n\nThis parameter defaults to the existing service proxy configuration,\nif one exists.","in":"query","name":"general","required":false,"schema":{"anyOf":[{"description":"A valid hostname.","example":"hostname.example.com","format":"hostname","type":"string"},{"description":"A valid IP address.","example":"192.0.2.102","format":"ipv4","type":"string"}]}},{"description":"The name of a service group for which to assign a proxy backend. The\ncorresponding `service_group_backend` value will be the service group's\nnew proxy backend.\n\n* `Mail` — The [Mail service group](https://go.cpanel.net/ServiceProxying#Mail).\n\nThis parameter defaults to the existing setting, if one exists.\n\n**Note:**\n\n * When you call this parameter, you **must** include a corresponding\n `service_group_backend` value.\n * To add multiple `service_group` values, increment the parameter name. For example,\n `service_group`, `service_group-1`, and `service_group-2`.","examples":{"multiple":{"summary":"Add multiple service backend groups.","value":"Mail&service-group-1=Mail&service-group-2=Mail"},"single":{"summary":"Add a single service backend group.","value":"Mail"}},"in":"query","name":"service_group","required":false,"schema":{"enum":["Mail"],"type":"string"}},{"description":"The hostname or IP address of the server to assign as the corresponding\n`service_group` value's proxy backend server.\n\nThis parameter defaults to the existing setting, if one exists.\n\n**Note:**\n\n * When you call this parameter, you **must** include a corresponding `service_group`\n value.\n * To add multiple `service_group_backend` values, increment the parameter name.\n For example, `service_group_backend`, `service_group_backend-1`,\n and `service_group_backend-2`.","examples":{"multiple":{"summary":"Add multiple service group backend servers.","value":"mail.example.com&service_group_backend-1=mail.example1.com&service_group_backend-2=mail.example2.com"},"single":{"summary":"Add a single service group backend server.","value":"mail.example.com"}},"in":"query","name":"service_group_backend","required":false,"schema":{"anyOf":[{"description":"A valid hostname.","example":"hostname.example.com","format":"hostname","type":"string"},{"description":"A valid IP address.","example":"192.0.2.102","format":"ipv4","type":"string"}]}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_service_proxy_backends","type":"string"},"module":{"description":"The name of the module called.","example":"ServiceProxy","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add cPanel account service proxying","tags":["ServiceProxy"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  ServiceProxy \\\n  set_service_proxy_backends\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/ServiceProxy/set_service_proxy_backends"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file ServiceProxy_set_service_proxy_backends.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme_name>/\n#    to .../frontend/<theme_name>/api_examples/ServiceProxy_set_service_proxy_backends.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/ServiceProxy/,\n    q/set_service_proxy_backends/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme_name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file ServiceProxy_set_service_proxy_backends.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme_name>/\n//    to .../frontend/<theme_name>/api_examples/ServiceProxy_set_service_proxy_backends.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'ServiceProxy',\n    'set_service_proxy_backends'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 96"}},"/cPGreyList/disable_domains":{"get":{"description":"This function disables Greylisting on a cPanel account's selected domains.","operationId":"cPGreyList-disable_domains","parameters":[{"description":"The domain on which to disable Greylisting.\n\n**Note:**\n\nTo disable Greylisting on multiple domains, use the `domains` parameter multiple times.","examples":{"multiple":{"description":"Multiple domains.","value":"domain=example.com domain=example1.com domain=example2.com"},"single":{"description":"A single domain.","value":"example.com"}},"in":"query","name":"domains","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"disable_domains","type":"string"},"module":{"description":"The name of the module called.","example":"cPGreyList","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"dependencies":{"description":"An array of domains that your changes will affect.","example":["this.com","that.com","theother.com"],"items":{"type":"string"},"type":"array"},"domain":{"description":"The domain.","example":"example.com","type":"string"},"enabled":{"description":"Whether Greylisting is disabled.\n* `1` — Enabled.\n* `0` — Disabled.","enum":[0,1],"example":0,"type":"integer"},"searchhint":{"description":"A comma-separated list of domain-related search terms.","example":"this, that, the other","type":"string"},"type":{"description":"The domain type.\n* `main` — A main domain.\n* `sub` — A subdomain.","enum":["main","sub"],"example":"main","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* 1 — Success.\n* 0 — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Disable Greylisting for specified domains","tags":["cPGreyList","Spam Filtering (Greylisting)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  cPGreyList \\\n  disable_domains \\\n  domains='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/cPGreyList/disable_domains?domains=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file cPGreyList_disable_domains.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/cPGreyList_disable_domains.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/cPGreyList/,\n    q/disable_domains/,\n    {\n        'domains' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file cPGreyList_disable_domains.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/cPGreyList_disable_domains.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'cPGreyList',\n    'disable_domains',\n    array (\n        'domains' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.50"}},"/cPGreyList/list_domains":{"get":{"description":"This function returns Greylisting's status for a cPanel account's domains.","operationId":"cPGreyList::list_domains","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_domains","type":"string"},"module":{"description":"The name of the module called.","example":"cPGreyList","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"cPGreyList":{"description":"An object that contains the number of domains with Greylisting enabled or disabled.","properties":{"total_disabled":{"description":"The number of domains with Greylisting disabled.","example":1,"minimum":0,"type":"integer"},"total_enabled":{"description":"The number of domains with Greylisting enabled.","example":0,"minimum":0,"type":"integer"}},"type":"object"},"dependencies":{"description":"An array of domains that your changes to a selected domain will affect.","example":["this.com","that.com","theother.com"],"items":{"format":"domain","type":"string"},"type":"array"},"domain":{"description":"The domain.","example":"example.com","format":"domain","type":"string"},"enabled":{"description":"Whether Greylisting is enabled.\n* `1` — Enabled.\n* `0` — Disabled.","enum":[0,1],"example":0,"type":"integer"},"searchhint":{"description":"A comma-separated list of domain-related search terms.","example":"this, that, and the other.","type":"string"},"type":{"description":"The domain type.\n* `main` — A main domain.\n* `sub` — A subdomain.","enum":["main","sub"],"example":"main","type":"string"}},"type":"object"},"properties":{},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* 1 — Success.\n* 0 — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return Greylisting status for domains","tags":["cPGreyList","Spam Filtering (Greylisting)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  cPGreyList \\\n  list_domains\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/cPGreyList/list_domains"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file cPGreyList_list_domains.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/cPGreyList_list_domains.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/cPGreyList/,\n    q/list_domains/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file cPGreyList_list_domains.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/cPGreyList_list_domains.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'cPGreyList',\n    'list_domains'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.50"}},"/cPGreyList/enable_domains":{"get":{"description":"This function enables Greylisting on a cPanel account's selected domains.","operationId":"cPGreyList-enable_domains","parameters":[{"description":"The domain on which to enable Greylisting.\n\n**Note:**\n\n To enable Greylisting on multiple domains, use the `domains` parameter multiple times.","examples":{"multiple":{"summary":"Multiple domains.","value":"domain=example.com&domain=example1.com&domain=example2.com"},"single":{"summary":"A single domain.","value":"example.com"}},"in":"query","name":"domains","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"enable_domains","type":"string"},"module":{"description":"The name of the module called.","example":"cPGreyList","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"dependencies":{"description":"An array of domains that your changes will affect.","example":["example.com","example1.com","example2.com"],"items":{"format":"domain","type":"string"},"type":"array"},"domain":{"description":"The domain.","example":"example.com","type":"string"},"enabled":{"description":"Whether Greylisting is disabled.\n* `1` — Enabled.\n* `0` — Disabled.","enum":[0,1],"example":0,"type":"integer"},"searchhint":{"description":"A comma-separated list of domain-related search terms.","example":"example, example1, example2","type":"string"},"type":{"description":"The domain type.\n* `main` — A main domain.\n* `sub` — A subdomain.","enum":["main","sub"],"example":"main","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable Greylisting for specified domains","tags":["cPGreyList","Spam Filtering (Greylisting)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  cPGreyList \\\n  enable_domains \\\n  domains='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/cPGreyList/enable_domains?domains=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file cPGreyList_enable_domains.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/cPGreyList_enable_domains.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/cPGreyList/,\n    q/enable_domains/,\n    {\n        'domains' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file cPGreyList_enable_domains.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/cPGreyList_enable_domains.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'cPGreyList',\n    'enable_domains',\n    array (\n        'domains' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.50"}},"/Team/add_team_user":{"get":{"description":"This function creates and adds a new team user.\n\n**Note:**\n\n  This action may result in team users gaining access to team owner level privileges.","operationId":"add_team_user","parameters":[{"description":"The username of the team user. Follows cPanel standards.","in":"query","name":"user","required":true,"schema":{"example":"teamuser","type":"string"}},{"description":"The contact email for the new team user.","in":"query","name":"email1","required":true,"schema":{"example":"teamuser@example.com","type":"string"}},{"description":"The secondary email for the new team user.","in":"query","name":"email2","required":false,"schema":{"example":"teamuser-backup@example.com","type":"string"}},{"description":"The password to set for the new team user.\n\n**Note:**\n\n * You must pass either the `password` or `activation_email` parameter.","in":"query","name":"password","required":false,"schema":{"example":"securepassword","type":"string"}},{"description":"Send an email to the team user that allows them to set their own password.\n* `1` - Enabled.\n\n**Note:**\n\n * You must pass either the `password` or `activation_email` parameter.","in":"query","name":"activation_email","required":false,"schema":{"example":1,"type":"integer"}},{"description":"A comma-separated list of roles assigned to the new team user. Current roles include admin, database, email, web.","in":"query","name":"roles","required":false,"schema":{"example":"email,database","type":"string"}},{"description":"Notes about the new team user. This field should not contain private information. Maximum of 100 characters.","in":"query","name":"notes","required":false,"schema":{"example":"This is a note about teamuser","type":"string"}},{"description":"The epoch time on which the team user account expires, or the offset from the current time, in days. Integers are treated as Unix Epoch Time unless followed by 'days'.","examples":{"offset":{"value":"120days"},"unix-timestamp":{"value":1649948169}},"in":"query","name":"expire_date","required":false,"schema":{"oneOf":[{"type":"integer"},{"type":"string"}]}},{"description":"The reason for expiration.","in":"query","name":"expire_reason","required":false,"schema":{"example":"teamUser gave a two week notice.","type":"string"}},{"description":"Whether to create an email subaccount for the team user. A subaccount is always created for a team user, but it does not have any associated service subaccounts by default.\n\n* `1` - Create an email subaccount.\n* `0` - **Do Not** create an email subaccount.","in":"query","name":"services.email.enabled","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"The maximum amount of disk space, in megabytes (MB), allocated to the team user's email account.\n\n* `0` or `unlimited` - The subaccount has unlimited disk space.\n\nThis value defaults to the defined system value.\n\n**Note:**\n\nThis value **cannot** be larger than the system's maximum email quota.","in":"query","name":"services.email.quota","required":false,"schema":{"example":"500","type":"string"}},{"description":"Whether to create an FTP subaccount for the team user. A subaccount is always created for a team user, but it does not have any associated service subaccounts by default.\n\n* `1` - Create an FTP subaccount.\n* `0` - **Do Not** create an FTP subaccount.","in":"query","name":"services.ftp.enabled","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"The team user's FTP home directory, relative to the cPanel account's home directory.\n\n**Note:**\n\n* This parameter is **required** if you enabled the `services.ftp.homedir` parameter.\n* The directory **must** exist.","in":"query","name":"services.ftp.homedir","required":false,"schema":{"example":"/Teamusername","format":"path","type":"string"}},{"description":"Whether to create a Web Disk subaccount for the team user. A subaccount is always created for a team user, but it does not have any associated service subaccounts by default.\n\n* `1` - Create a Web Disk subaccount.\n* `0` - **Do Not** create a Web Disk subaccount.","in":"query","name":"services.webdisk.enabled","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to enable the Web Disk Digest Authentication.\n\n* `1` - Enabled.\n* `0` - Disabled.\n\n**Note:**\n\n* **Only** enable Digest Authentication for clients that require additional compatibility support on\n  certain versions of Windows® operating systems. This compatibility support is **only** required on servers\n  that use a self-signed certificate for the `cpsrvd` and `cpdavd` daemons.\n* We recommend that you do **not** use Digest Authentication.","in":"query","name":"services.webdisk.enabledigest","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"Whether to set the directory's permissions to public or private.\n\n* `1` - Private (`0700`).\n* `0` - Public (`0755`).","in":"query","name":"services.webdisk.private","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"The team user's Web Disk home directory, relative to the cPanel account's home directory.\n\n**Note:**\n\nThis parameter is **required** if you enable the `services.webdisk.enabled` parameter.","in":"query","name":"services.webdisk.homedir","required":false,"schema":{"example":"/Teamusername","format":"path","type":"string"}},{"description":"The team user's file permissions for its Web Disk home directory.\n\n* `ro` - Read-only permissions.\n* `rw` - Read and write permissions.\n\n**Note:**\n\n The `services.webdisk.homedir` parameter determines the team user's Web Disk home directory.","in":"query","name":"services.webdisk.perms","required":false,"schema":{"default":"rw","example":"rw","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"add_team_user","type":"string"},"module":{"description":"The name of the module called.","example":"Team","type":"string"},"result":{"properties":{"data":{"description":"The unix timestamp that represents when the team user expires.","example":1674575562,"format":"unix-timestamp","type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add a team user","tags":["Team Users"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Team \\\n  add_team_user \\\n  user='teamuser' \\\n  email1='teamuser@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Team/add_team_user?user=teamuser&email1=teamuser%40example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account, where theme-name represents\n# jupiter.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Team_add_team_user.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Team_add_team_user.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Team/,\n    q/add_team_user/,\n    {\n        'user' => 'teamuser',\n        'email1' => 'teamuser@example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account, where theme-name represents\n// jupiter.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Team_add_team_user.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Team_add_team_user.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Team',\n    'add_team_user',\n    array (\n        'user' => 'teamuser',\n        'email1' => 'teamuser@example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}\n"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":104}},"/ClamScanner/disinfect_files":{"post":{"description":"This function applies the disinfection option selected by the user\nfor each infected file.\n\n**Note:**\n\nYou must run the APIs in this order:\n\n1. Run [`ClamScanner::start_scan`](https://go.cpanel.net/ClamScanner-start-scan) to start the virus scan.\n2. Run [`ClamScanner::get_scan_status`](https://go.cpanel.net/ClamScanner-get-scan-status) in a loop until the scan is finished.\n3. Run [`ClamScanner::list_infected_files`](https://go.cpanel.net/ClamScanner-list-infected-files) to get a report of the complete list of infected files.\n4. Decide how you want to handle each infected file.\n5. Run [`ClamScanner::disinfect_files`](https://go.cpanel.net/ClamScanner-disinfect-files) to queue the disinfection of the files.\n6. Run [`ClamScanner::check_disinfection_status`](https://go.cpanel.net/ClamScanner-check-disinfection-status) in a loop until you get a done status.","operationId":"disinfect_files","requestBody":{"content":{"application/json":{"schema":{"properties":{"actions":{"additionalProperties":{"description":"The name of the property is a path to the file. The path may be either a full path to the file or a users home directory relative path to the file.\n\nThe value of the property is on of the following:\n\n* `cleanse_mailbox` — Cleanse the specified mailbox.\n* `delete` — Delete the file.\n* `quarantine` — Move the file to the quarantine directory.\n* `ignore` - Ignore the file.\n\n**Note**\n\nOnly include files that the scanner identified as containing a virus. All other file paths passed will be ignored.","enum":["cleanse_mailbox","delete","quarantine","ignore"],"type":"string"},"description":"The user provides the actions to perform on each specific infected file found in the scan.","example":{"home/unsure":"ignore","home/virus1":"delete","home/virus2":"quarantine"},"type":"object"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"disinfect_files","type":"string"},"module":{"description":"The name of the module called.","example":"ClamScanner","type":"string"},"result":{"properties":{"data":{"properties":{"log":{"description":"Path to the disinfection log file. The log file will contain a list of JSON objects one per line.\n\nIf the last line is:\n\n`{ \"status\": \"done\" }`\n\nthe requested files with viruses have be handled as requested.  Use the /ClamScanner/check_disinfection_status\nAPI to check the status of a running or finished disinfection.","example":"/home/user/.clamavconnector.disinfection.log","type":"string"},"task_id":{"description":"The Task Queue system's task ID number.","example":"00000000/5a9ec8dd4c345d","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Start disinfecting files with viruses","tags":["ClamScanner","Antivirus Protection (ClamAV)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"echo '{\"home/unsure\":\"ignore\",\"home/virus1\":\"delete\",\"home/virus2\":\"quarantine\"}' | uapi --user=username --input=json --output=jsonpretty ClamScanner disinfect_files"},{"label":"HTTP Request (Wire Format)","lang":"HTTP","source":"POST /cpsess##########/execute/ClamScanner/disinfect_files HTTP/1.1\nHost: example.com:2083\nCookie: ###################################\nContent-Type: application/json\nContent-Length: 74\n\n{\"home/unsure\":\"ignore\",\"home/virus1\":\"delete\",\"home/virus2\":\"quarantine\"}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":94}},"/Chrome/get_dom":{"get":{"description":"This function returns header and footer HTML. You can use this HTML to create a page with the same visual appearance as your cPanel theme.","operationId":"get_dom","parameters":[{"description":"The title of the page to wrap in the theme's headers and footers.","in":"query","name":"page_title","required":true,"schema":{"example":"Test","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_dom","type":"string"},"module":{"description":"The name of the module called.","example":"Chrome","type":"string"},"result":{"properties":{"data":{"properties":{"footer":{"description":"The pages' footer.","example":"\n\n</html>\n\n","type":"string"},"header":{"description":"The pages' header.","example":"\n\n<!DOCTYPE html>\n\n<html lang=\"en\" dir=\"ltr\">\n","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel theme header and footer HTML","tags":["Chrome","Brand Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Chrome \\\n  get_dom \\\n  page_title='Test'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Chrome/get_dom?page_title=Test"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Chrome_get_dom.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Chrome_get_dom.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Chrome/,\n    q/get_dom/,\n    {\n        'page_title' => 'Test',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Chrome_get_dom.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Chrome_get_dom.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Chrome',\n    'get_dom',\n    array (\n        'page_title' => 'Test',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/WordPressSite/retrieve":{"get":{"description":"This function retrieves the installation status and detailed information of the WordPress site for cPanel user's primary domain.","operationId":"WordPressSite::retrieve","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"retrieve","type":"string"},"module":{"description":"The name of the module called.","example":"WordPressSite","type":"string"},"result":{"properties":{"data":{"description":"An object that contains the installation status and information for the WordPress site.","items":{"properties":{"details":{"description":"Detailed information of the WordPress site.","example":null,"type":"object"},"install_status":{"description":"Installation status of the WordPress site.","example":"in progress","type":"string"}}}},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return WordPress site information","tags":["WordPressSite","Site Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  WordPressSite \\\n  retrieve\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/WordPressSite/retrieve"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file WordPressSite_retrieve.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/WordPressSite_retrieve.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/WordPressSite/,\n    q/retrieve/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file WordPressSite_retrieve.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/WordPressSite_retrieve.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'WordPressSite',\n    'retrieve'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Email/delete_filter":{"get":{"description":"This function deletes an email filter.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles), the system **disables** this function.","operationId":"delete_filter","parameters":[{"description":"The email address that owns the filter.","in":"query","name":"account","required":true,"schema":{"example":"user@example.com","format":"email","type":"string"}},{"description":"The filter's name.","in":"query","name":"filtername","required":true,"schema":{"example":"coffee","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"delete_filter","type":"string"},"module":{"description":"The name of the module called.","example":"Email","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete email account's email filter","tags":["Email","Email Filtering"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  delete_filter \\\n  account='user@example.com' \\\n  filtername='coffee'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Email/delete_filter?account=user%40example.com&filtername=coffee"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Email_delete_filter.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Email_delete_filter.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Email/,\n    q/delete_filter/,\n    {\n        'account' => 'user@example.com',\n        'filtername' => 'coffee',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Email_delete_filter.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Email_delete_filter.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Email',\n    'delete_filter',\n    array (\n        'account' => 'user@example.com',\n        'filtername' => 'coffee',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Team/list_team":{"get":{"description":"This function lists the team users connected to a cPanel account.\nThis list is given in an array by default, but can be given in a hash.","operationId":"list_team","parameters":[{"description":"The format in which the team data is listed.","in":"query","name":"format","required":false,"schema":{"example":"array","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_team","type":"string"},"module":{"description":"The name of the module called.","example":"Team","type":"string"},"result":{"properties":{"data":{"oneOf":[{"$ref":"#/components/schemas/TeamArray"},{"$ref":"#/components/schemas/TeamHash"}]},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"List Team Users","tags":["Team Users"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Team \\\n  list_team\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Team/list_team"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Team_list_team.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Team_list_team.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Team/,\n    q/list_team/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Team_list_team.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Team_list_team.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Team',\n    'list_team'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":104}},"/Team/suspend_team_user":{"get":{"description":"This function immediately suspends a team user.","operationId":"suspend_team_user","parameters":[{"description":"The username of the team user.","in":"query","name":"user","required":true,"schema":{"example":"teamuser","type":"string"}},{"description":"The reason for suspension.","in":"query","name":"reason","required":false,"schema":{"example":"teamuser is on vacation","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"suspend_team_user","type":"string"},"module":{"description":"The name of the module called.","example":"Team","type":"string"},"result":{"properties":{"data":{"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Suspend a team user","tags":["Team Users"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Team \\\n  suspend_team_user \\\n  user='teamuser'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Team/suspend_team_user?user=teamuser"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Team_suspend_team_user.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Team_suspend_team_user.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Team/,\n    q/suspend_team_user/,\n    {\n        'user' => 'teamuser',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Team_suspend_team_user.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Team_suspend_team_user.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Team',\n    'suspend_team_user',\n    array (\n        'user' => 'teamuser',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":108}},"/NginxCaching/disable_cache":{"get":{"description":"This function disables the user's NGINX cache.\n\n**Note:**\n\n  - You can **only** use this function if you installed the `ea-nginx` package.","operationId":"disable_cache","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"disable_cache","type":"string"},"module":{"description":"The name of the module called.","example":"NginxCaching","type":"string"},"result":{"properties":{"data":{"properties":{}},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Disable the user's NGINX cache","tags":["NginxCaching"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  NginxCaching \\\n  disable_cache\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/NginxCaching/disable_cache"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file NginxCaching_disable_cache.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/NginxCaching_disable_cache.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/NginxCaching/,\n    q/disable_cache/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file NginxCaching_disable_cache.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/NginxCaching_disable_cache.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'NginxCaching',\n    'disable_cache'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 100"}},"/Team/edit_team_user":{"get":{"description":"This function modifies a team user.","operationId":"edit_team_user","parameters":[{"description":"The username of the team user.","in":"query","name":"user","required":true,"schema":{"example":"teamUser","type":"string"}},{"description":"The primary contact email address to set for the team user.","in":"query","name":"email1","required":false,"schema":{"example":"teamuser@example.com","type":"string"}},{"description":"The secondary contact email address to set for the team user.","in":"query","name":"email2","required":false,"schema":{"example":"teamuser@example.com","type":"string"}},{"description":"The password to set for the team user.","in":"query","name":"password","required":false,"schema":{"example":"securepassword","type":"string"}},{"description":"The role or roles to set for the team user.","in":"query","name":"set_role","required":false,"schema":{"example":"email","type":"string"}},{"description":"The role or roles to add to the team user.","in":"query","name":"add_role","required":false,"schema":{"example":"database","type":"string"}},{"description":"The role or roles to remove from the team user.","in":"query","name":"remove_role","required":false,"schema":{"example":"database","type":"string"}},{"description":"Notes about the new team user. This field should not contain private information.","in":"query","name":"notes","required":false,"schema":{"example":"This is a note about teamUser","type":"string"}},{"description":"The epoch time the team user account expires on or the offset in days.","examples":{"offset":{"value":"120days"},"unix-timestamp":{"value":1649948169}},"in":"query","name":"set_expire","required":false,"schema":{"oneOf":[{"type":"integer"},{"type":"string"}]}},{"description":"The reason for expiration.","in":"query","name":"expire_reason","required":false,"schema":{"example":"teamUser gave a two week notice.","type":"string"}},{"description":"Whether to create or remove an email subaccount for the team user. A subaccount is always created for a team user, but it does not have any associated service subaccounts by default.\n\n* `1` - Create and associate an email subaccount.\n* `0` - Remove any associated email subaccounts.","in":"query","name":"services.email.enabled","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"The maximum amount of disk space, in megabytes (MB), allocated to the team user's email account.\n\n* `0` or `unlimited` - The subaccount has unlimited disk space.\n\nThis value defaults to the defined system value.\n\n**Note:**\n\nThis value **cannot** be larger than the system's maximum email quota.","in":"query","name":"services.email.quota","required":false,"schema":{"example":"500","type":"string"}},{"description":"Whether to create or remove an FTP subaccount for the team user. A subaccount is always created for a team user, but it does not have any associated service subaccounts by default.\n\n* `1` - Create and associate an FTP subaccount.\n* `0` - Remove any associated FTP subaccounts.","in":"query","name":"services.ftp.enabled","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"The team user's FTP home directory, relative to the cPanel account's home directory.\n\n**Note:**\n\n* This parameter is **required** if you enabled the `services.ftp.homedir` parameter.\n* The directory **must** exist.","in":"query","name":"services.ftp.homedir","required":false,"schema":{"example":"/Teamusername","format":"path","type":"string"}},{"description":"Whether to create or remove a Web Disk subaccount for the team user. A subaccount is always created for a team user, but it does not have any associated service subaccounts by default.\n\n* `1` - Create and associate a Web Disk subaccount.\n* `0` - Remove any associated Web Disk subaccounts.","in":"query","name":"services.webdisk.enabled","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to enable the Web Disk Digest Authentication.\n\n* `1` - Enabled.\n* `0` - Disabled.\n\n**Note:**\n\n* **Only** enable Digest Authentication for clients that require additional compatibility support on\n  certain versions of Windows® operating systems. This compatibility support is **only** required on servers\n  that use a self-signed certificate for the `cpsrvd` and `cpdavd` daemons.\n* We recommend that you do **not** use Digest Authentication.","in":"query","name":"services.webdisk.enabledigest","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}},{"description":"Whether to set the directory's permissions to public or private.\n\n* `1` - Private (`0700`).\n* `0` - Public (`0755`).","in":"query","name":"services.webdisk.private","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"The team user's Web Disk home directory, relative to the cPanel account's home directory.\n\n**Note:**\n\nThis parameter is **required** if you enable the `services.webdisk.enabled` parameter.","in":"query","name":"services.webdisk.homedir","required":false,"schema":{"example":"/Teamusername","format":"path","type":"string"}},{"description":"The team user's file permissions for its Web Disk home directory.\n\n* `ro` - Read-only permissions.\n* `rw` - Read and write permissions.\n\n**Note:**\n\n The `services.webdisk.homedir` parameter determines the team user's Web Disk home directory.","in":"query","name":"services.webdisk.perms","required":false,"schema":{"default":"rw","example":"rw","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"edit_team_user","type":"string"},"module":{"description":"The name of the module called.","example":"Team","type":"string"},"result":{"properties":{"data":{"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Edit a team user","tags":["Team Users"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Team \\\n  edit_team_user \\\n  user='teamUser'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Team/edit_team_user?user=teamUser"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account, where theme-name represents\n# jupiter.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Team_edit_team_user.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Team_edit_team_user.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Team/,\n    q/edit_team_user/,\n    {\n        'user' => 'teamUser',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account, where theme-name represents\n// jupiter.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Team_edit_team_user.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Team_edit_team_user.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Team',\n    'edit_team_user',\n    array (\n        'user' => 'teamUser',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}\n"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":110}},"/DNS/has_local_authority":{"get":{"description":"This function checks whether the local server is authoritative for the domain's DNS records.","operationId":"has_local_authority","parameters":[{"description":"The domain to check whether the local server is authoritative for the domain's\nDNS records.\n\n**Note:**\n\nTo check multiple domains, increment or duplicate the parameter name. For\nexample, `domain-0`, `domain-1`, and `domain-2`.","examples":{"multiple":{"summary":"Check multiple domains.","value":"domain-0=example.com domain-1=example1.com domain-2=example2.com"},"multiple-alternative":{"summary":"Check multiple domains.","value":"domain=example.com domain=example1.com domain=example2.com"},"single":{"summary":"Check a single domain.","value":"example.com"}},"in":"query","name":"domain","required":true,"schema":{"example":"example.com","format":"domain","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"has_local_authority","type":"string"},"module":{"description":"The name of the module called.","example":"DNS","type":"string"},"result":{"properties":{"data":{"description":"An array of objects containing information about the authoritative status of a domain's local DNS zone files.","example":[{"domain":"example.com","local_authority":1,"nameservers":["ns1.example.com","ns2.example.com"],"zone":"example.com"},{"domain":"example2.com","local_authority":0,"nameservers":[]},{"domain":"example3.com","error":"(XID 3z756a) DNS query (example3.com/SOA) timeout!","local_authority":0,"nameservers":[],"zone":"example3.com"}],"items":{"properties":{"domain":{"description":"The queried domain.","format":"domain","type":"string"},"error":{"description":"An error message that details the reason why the local server's\nauthoritative check failed.\n\n**Note:**\n\nThe function **only** returns this value when the check fails.","type":"string"},"local_authority":{"description":"Whether the local server is authoritative for the domain's DNS\nrecords.\n\n* `1` — The local server is authoritative for the domain's DNS\nrecords.\n* `0` — The local server is **not** authoritative for the domain's\nDNS records.","enum":[1,0],"type":"integer"},"nameservers":{"description":"The domain's nameservers, if any exist.","items":{"format":"domain","type":"string"},"type":"array"},"zone":{"description":"The domain's DNS zone, if one exists.\n\n* `null` — No valid DNS zone.","format":"domain","nullable":true,"type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"nullable":true,"type":"string"},"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return whether local DNS server is authoritative","tags":["DNS","DNS Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DNS \\\n  has_local_authority \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DNS/has_local_authority?domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DNS_has_local_authority.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DNS_has_local_authority.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DNS/,\n    q/has_local_authority/,\n    {\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DNS_has_local_authority.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DNS_has_local_authority.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DNS',\n    'has_local_authority',\n    array (\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 78"}},"/DirectoryPrivacy/add_user":{"get":{"description":"This function adds a user who can access a protected directory on the cPanel account.","operationId":"add_user","parameters":[{"description":"The directory to add users to.","in":"query","name":"dir","required":true,"schema":{"example":"/home/example/example.com","format":"path","type":"string"}},{"description":"The username of the user who can access the directory.","in":"query","name":"user","required":true,"schema":{"example":"example1","type":"string"}},{"description":"The password for the user.","in":"query","name":"password","required":true,"schema":{"example":"123456luggage","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"add_user","type":"string"},"module":{"description":"The name of the module called.","example":"DirectoryPrivacy","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add authorized user for protected directory","tags":["DirectoryPrivacy","Directory Privacy"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DirectoryPrivacy \\\n  add_user \\\n  dir='/home/example/example.com' \\\n  user='example1' \\\n  password='123456luggage'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DirectoryPrivacy/add_user?dir=%2fhome%2fexample%2fexample.com&user=example1&password=123456luggage"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DirectoryPrivacy_add_user.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DirectoryPrivacy_add_user.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DirectoryPrivacy/,\n    q/add_user/,\n    {\n        'dir' => '/home/example/example.com',\n        'user' => 'example1',\n        'password' => '123456luggage',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DirectoryPrivacy_add_user.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DirectoryPrivacy_add_user.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DirectoryPrivacy',\n    'add_user',\n    array (\n        'dir' => '/home/example/example.com',\n        'user' => 'example1',\n        'password' => '123456luggage',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 88"}},"/ClamScanner/check_disinfection_status":{"get":{"description":"This function checks the status of the previously queued disinfection\nof infected files.\n\n**Note:**\n\nYou must run the APIs in this order:\n\n1. Run [`ClamScanner::start_scan`](https://go.cpanel.net/ClamScanner-start-scan) to start the virus scan.\n2. Run [`ClamScanner::get_scan_status`](https://go.cpanel.net/ClamScanner-get-scan-status) in a loop until the scan is finished.\n3. Run [`ClamScanner::list_infected_files`](https://go.cpanel.net/ClamScanner-list-infected-files) to get a report of the complete list of infected files.\n4. Decide how you want to handle each infected file.\n5. Run [`ClamScanner::disinfect_files`](https://go.cpanel.net/ClamScanner-disinfect-files) to queue the disinfection of the files.\n6. Run [`ClamScanner::check_disinfection_status`](https://go.cpanel.net/ClamScanner-check-disinfection-status) in a loop until you get a done status.\n\nIf you want to display the progress, you can render the `ClamScanner::check_disinfection_status` returned 'result{data}{details}' array where the `type` is `step`.\n\nEach `step` record indicates the action taken on a specific file in the set being processed.","operationId":"ClamScanner::check_disinfection_status","parameters":[{"description":"The unique `id` of the message you last received from this same log.\n\nThe API will return only the records after the specified `last_id`.\n\nIf this parameter is not provided, the entire log is returned.\n\n**Note:**\n\nFor improved performance, we recommend applications include the last record ID (last_id)\nfrom a previous call to this API, so only messages since the previous API call are returned.","in":"query","name":"last_id","schema":{"example":10,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"check_disinfection_status","type":"string"},"module":{"description":"The name of the module called.","example":"ClamScanner","type":"string"},"result":{"properties":{"data":{"properties":{"details":{"description":"The list of events recorded in the log. If you pass the `last_id` parameter, only records in the log after that id are returned.","items":{"oneOf":[{"properties":{"file":{"description":"The absolute path to the file.","example":"/home/user/virus","type":"string"},"id":{"description":"The task processing order.","example":2,"type":"number"},"message":{"description":"Optional message that may include more information about errors.","type":"string"},"state":{"description":"The state of the step. It will be one of the following:\n\n* `deleted` - The file was deleted.\n* `error` - An error occurred while processing the file.\n* `mailbox-cleansed` - The mailbox was clear of viruses.\n* `no-action` - No action was taken on the file.\n* `quarantined` - The file was quarantined.","enum":["deleted","error","mailbox-cleansed","no-action","quarantined"],"example":"deleted","type":"string"},"type":{"description":"* `step` - Record about a single file being processes.","enum":["step"],"type":"string"}},"required":["type","state"],"type":"object"},{"properties":{"id":{"description":"The task processing order.","example":2,"type":"number"},"message":{"description":"Optional message that may include more information about errors and warnings.","type":"string"},"state":{"description":"The state of the issue. It will be one of the following:\n\n* `error` - An error occurred while starting or finishing the disinfection.\n* `warning` - A non-cricitcal problem occurred while starting or finishing the disinfection.","enum":["error","warning"],"example":"warning","type":"string"},"type":{"description":"* `issue` - Record that the disinfection is complete for all files indicated.","enum":["issue"],"type":"string"}},"required":["type","state"],"type":"object"},{"properties":{"id":{"description":"The task processing order.","example":2,"type":"number"},"message":{"description":"Optional message that may include more information about errors.","type":"string"},"state":{"description":"The state of the step. It will be one of the following:\n\n* `error` - An error occurred while processing the file.\n* `info` - The message is information only.\n* `success` - The disinfection was successful.","enum":["error","info","success"],"example":"success","type":"string"},"type":{"description":"* `done` - Record that the disinfection is complete for all files indicated.","enum":["done"],"type":"string"}},"required":["type"],"type":"object"}]},"type":"array"},"log":{"description":"Path to the disinfection log file. The log file will contain a list of JSON objects one per line.  If the last line includes `\"type\":\"done\"`, the file disinfection is complete.","example":"/home/user/.clamavconnector.disinfection.log","type":"string"},"status":{"description":"* `done` - The disinfection is finished.\n* `none` - There is no disinfection scheduled.\n* `queued` - The disinfection is queued.\n* `running` - The disinfection is in progress.","enum":["done","queued","running"],"example":"done","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Request disinfection process status","tags":["ClamScanner","Antivirus Protection (ClamAV)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  ClamScanner \\\n  check_disinfection_status\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/ClamScanner/check_disinfection_status"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file ClamScanner_check_disinfection_status.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/ClamScanner_check_disinfection_status.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/ClamScanner/,\n    q/check_disinfection_status/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file ClamScanner_check_disinfection_status.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/ClamScanner_check_disinfection_status.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'ClamScanner',\n    'check_disinfection_status'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":94}},"/BoxTrapper/set_status":{"get":{"description":"This function enables or disables BoxTrapper for an email account.\n\n**Important:**\n\n  When you disable the [Receive Mail](https://go.cpanel.net/serverroles) role, the system **disables** this function.","operationId":"set_status","parameters":[{"description":"The account's name. This can be an email address or the cPanel user’s username.\n\n**Warning:**\n\nIf you call this function in Webmail, the system ignores this parameter and defaults to the currently-authenticated email address.","example":"user@example.com","in":"query","name":"email","required":true,"schema":{"oneOf":[{"example":"user@example.com","format":"email","type":"string"},{"example":"exampleuser","format":"username","type":"string"}]}},{"description":"Whether to enable or disable BoxTrapper for the email account.\n\n* `1` - Enable BoxTrapper.\n* `0` - **Disable** BoxTrapper.","in":"query","name":"enabled","required":true,"schema":{"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_status","type":"string"},"module":{"description":"The name of the module called.","example":"BoxTrapper","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Enable or disable BoxTrapper for email account","tags":["BoxTrapper","Spam Prevention (BoxTrapper)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  BoxTrapper \\\n  set_status \\\n  email='user@example.com' \\\n  enabled='1'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/BoxTrapper/set_status?email=user%40example.com&enabled=1"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file BoxTrapper_set_status.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/BoxTrapper_set_status.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/BoxTrapper/,\n    q/set_status/,\n    {\n        'email' => 'user@example.com',\n        'enabled' => '1',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file BoxTrapper_set_status.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/BoxTrapper_set_status.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'BoxTrapper',\n    'set_status',\n    array (\n        'email' => 'user@example.com',\n        'enabled' => '1',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/CCS/list_users":{"get":{"description":"This function lists all calendar users on the cPanel account.\n\n**Note:**\n\nYou **must** install the [Calendar and Contacts Server](https://go.cpanel.net/CalendarAndContactsServer) cPanel plugin to access this API function.","operationId":"list_users","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_users","type":"string"},"module":{"description":"The name of the module called.","example":"CCS","type":"string"},"result":{"properties":{"data":{"additionalProperties":{"description":"The user account's [universally unique identifier](https://en.wikipedia.org/wiki/Universally_unique_identifier) (UUID). The user account's name is the return's name."},"example":{"user1@example.com":"0882362A-0B98-11E8-BAF5-D988266709C1","user2@example.com":"96F1EB2F-A501-11EA-A3EF-A553B2E4FFA8","user3@example.com":"195C8A51-E1B3-11E6-8715-F54FA4E00DDD","user4@example.com":"028F4AB1-0F1A-11E7-AEC7-E08FECEC8036"},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` - Success.\n- `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"List cPanel account's calendar users","tags":["CCS","Calendar and Contacts Server"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  CCS \\\n  list_users\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/CCS/list_users"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file CCS_list_users.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/CCS_list_users.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/CCS/,\n    q/list_users/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file CCS_list_users.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/CCS_list_users.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'CCS',\n    'list_users'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 90"}},"/DCV/ensure_domains_can_pass_dcv":{"get":{"deprecated":true,"description":"This function indicates whether the account's domains can pass a Domain Control\nValidation (DCV) check.\n\n**Warning:**\n\nWe deprecated this function. Use UAPI's `DCV::check_domains_via_http` function.","operationId":"ensure_domains_can_pass_dcv","parameters":[{"description":"The domains to check.\n\n**Note:**\n\n To check multiple domains, duplicate or increment the parameter name. For example,\n `domain-1`, `domain-2`, and `domain-3`.","examples":{"multiple":{"summary":"Check multiple domains.","value":"domain-1=example1.com domain-2=example2.com domain-3=example3.com"},"multiple-alternative":{"summary":"Check multiple domains.","value":"domain=example1.com domain=example2.com domain=example3.com"},"single":{"summary":"Check a single domain.","value":"example.com"}},"in":"query","name":"domain","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"ensure_domains_can_pass_dcv","type":"string"},"module":{"description":"The name of the module called.","example":"DCV","type":"string"},"result":{"properties":{"data":{"description":"A list of results from each domain parameter's DCV check.\n\n* `null` — The domain passes the DCV check.\n\n**Note:**\n\nThe function returns the results from the domains in the same order\nin which you called them.","example":[null,null,"The domain resolves to Mars. Beep beep beep."],"items":{"nullable":true,"type":"string"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Verify domain ownership","tags":["DCV","Verify Domain Ownership"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DCV \\\n  ensure_domains_can_pass_dcv \\\n  domain='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DCV/ensure_domains_can_pass_dcv?domain=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DCV_ensure_domains_can_pass_dcv.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DCV_ensure_domains_can_pass_dcv.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DCV/,\n    q/ensure_domains_can_pass_dcv/,\n    {\n        'domain' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DCV_ensure_domains_can_pass_dcv.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DCV_ensure_domains_can_pass_dcv.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DCV',\n    'ensure_domains_can_pass_dcv',\n    array (\n        'domain' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 56"}},"/VersionControl/retrieve":{"get":{"description":"This function lists Git™ repositories on a cPanel account. For more information\nabout support for version control in cPanel & WHM, read our\n[Git Version Control](https://go.cpanel.net/GitVersionControl) and\n[Guide to Git](https://go.cpanel.net/GitDeployment) documentation.\n\n**Important:**\n\n* This feature does **not** allow the following characters in repository paths:\n  ``\\ * | \" ' < > & @ ` $ { } [ ] ( ) ; ? : = % #``\n* This function does **not** allow repositories that exist in the following\ncPanel-controlled directories:\n\n  * `.cpanel`\n  * `.htpasswds`\n  * `.ssh`\n  * `.trash`\n  * `access-logs`\n  * `cgi-bin`\n  * `etc`\n  * `logs`\n  * `perl5`\n  * `mail`\n  * `spamassassin`\n  * `ssl`\n  * `tmp`\n  * `var`\n\nUsers can create repositories in some of these directories on the command line.\nThey may appear in the list of repositories in Gitweb, but users may see an error\nmessage if they try to access them.","operationId":"VersionControl::retrieve","parameters":[{"description":"A comma-separated list of desired return values.\n\n**Note:**\n\nUse a wildcard (`*`) to list all possible return values.","in":"query","name":"fields","required":false,"schema":{"default":"*","example":"name,type,branch,last_update","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"retrieve","type":"string"},"module":{"description":"The name of the module called.","example":"VersionControl","type":"string"},"result":{"properties":{"data":{"description":"An array of objects containing repository data.","example":[{"available_branches":["master"],"branch":"master","clone_urls":{"read_only":["https://user@example.com/home/user/example"],"read_write":["ssh://user@example.com/home/user/example"]},"deployable":1,"last_deployment":{"deployment_date":1598774400,"repository_state":{"author":"User Name <user.name@example.com>","date":1598774400,"identifier":"2fd4e1c67a2d28fced849ee1bb76e7391b93eb12","message":"I'm committing some particularly cromulent code."}},"last_update":{"author":"Jane Doe <jane.doe@example.com>","date":1598774400,"identifier":"2fd4e1c67a2d28fced849ee1bb76e7391b93eb12","message":"I'm committing some particularly cromulent code."},"name":"example","repository_root":"/home/user/example","tasks":[{"action":"create","args":{"log_file":"/home/user/.cpanel/logs/vc_1526305129.123456_git_create.log","repository_root":"/home/user/example"},"id":"00000000/5a9ec8dd4c345d","sse_url":"/sse/UserTasks/B3A27B96-51F7-11E8-92E3-CC90C4F823F0","subsystem":"VersionControl"}],"type":"git"},{"available_branches":["master"],"branch":"master","deployable":1,"last_update":{"author":"June Due <june.due@example2.com>","clone_urls":{"read_only":["https://user@example.com/home/user/example"],"read_write":["ssh://user@example.com/home/user/example"]},"date":1599730200,"identifier":"4ee0b73ddf78213c41fcc185acfab68ced99046d","last_deployment":{"deployment_date":1599730200,"repository_state":{"author":"User Name <user.name@example.com>","date":1599730200,"identifier":"2fd4e1c67a2d28fced849ee1bb76e7391b93eb12","message":"I'm committing some particularly cromulent code."}},"message":"My code makes more sense, actually.","tasks":[{"action":"create","args":{"log_file":"/home/user/.cpanel/logs/vc_1526305129.123456_git_create.log","repository_root":"/home/user/example"},"id":"00000000/5a9ec8dd4c345d","sse_url":"/sse/UserTasks/B3A27B96-51F7-11E8-92E3-CC90C4F823F0","subsystem":"VersionControl"}]},"name":"example2","repository_root":"/home/user/example2","type":"git"}],"items":{"properties":{"available_branches":{"description":"A list of available local and remote branches for the cloned\nor existing repository.\n\n* An empty array — No branches exist.\n* `null` — The repository is a bare repository.","items":{"type":"string"},"nullable":true,"type":"array"},"branch":{"description":"The repository's current branch.\n\n* `null` — The system has not finished the clone process for the\nrepository, no local branches exist, or the repository is a bare\nrepository.","nullable":true,"type":"string"},"clone_urls":{"description":"An array of objects containing URLS to use to clone the repository.","properties":{"read_only":{"description":"A list of clone URLs with read-only permissions.\n\nThis function returns a blank array if the account does\nnot include the *Shell Access* setting.\n\n**Important:**\n\nIf the server uses a nonstandard SSH port, the system returns a\nclone URL that includes the port number.","items":{"type":"string"},"type":"array"},"read_write":{"description":"A list of clone URLs with read-write permissions.\n\nThis function returns a blank array if the account does\nnot include the *Shell Access* setting.\n\n**Important:**\n\nIf the server uses a nonstandard SSH port, the system returns a\nclone URL that includes the port number.","items":{"type":"string"},"type":"array"}},"type":"object"},"deployable":{"description":"Whether the system could deploy the repository.\n\n* `1` — Can deploy.\n* `0` — Cannot deploy.","enum":[1,0],"type":"integer"},"last_deployment":{"description":"An object containing information about the commit that the system\nmost recently deployed.\n\n**Note:**\n\nThe system **only** returns this object if deployment information\nexists.","properties":{"deployment_date":{"description":"The timestamp for the most-recent deployment.","format":"unix_timestamp","type":"integer"},"repository_state":{"description":"A object containing information about the state of the repository at the time of the most recent deployment.","properties":{"author":{"description":"The author's name and email address for the commit that the system most recently deployed.","type":"string"},"date":{"description":"The timestamp for the commit that the system most recently deployed.","format":"unix_timestamp","type":"integer"},"identifier":{"description":"The identifier (SHA-1 value) for the commit that the system most recently deployed.","type":"string"},"message":{"description":"The commit message for the commit that the system most recently deployed.","type":"string"}},"type":"object"}},"type":"object"},"last_update":{"description":"An object containing information about the most-recent (HEAD) commit\nfor the current branch. \n\n**Note:**\n\nThis object's information resembles the output of the `git log -1`\ncommand.\n\n**Important:**\n\n* If the repository does not include any commits, the function returns\na `null` value instead of an object.\n* The system may require a large amount of time to clone larger\nrepositories. Until this process finishes, HEAD information is\nunavailable.","nullable":true,"properties":{"author":{"description":"The most-recent commit's author's name and email address.","example":"Jane Doe <jane.doe@example.com>","type":"string"},"date":{"description":"The timestamp for the most-recent commit.","example":1569844800,"format":"unix_timestamp","type":"integer"},"identifier":{"description":"The identifier (SHA-1 value) for the most-recent commit.","example":"2fd4e1c67a2d28fced849ee1bb76e7391b93eb12","type":"string"},"message":{"description":"The commit message.","example":"I'm committing some particularly cromulent code.","type":"string"}},"type":"object"},"name":{"description":"The repository's display name.","example":"example","type":"string"},"repository_root":{"description":"The absolute directory path in the user's `home` directory containing the repository.","example":"/home/user/public_html/example","format":"path","type":"string"},"source_repository":{"description":"An object containing information about the source repository.\n\n**Note:**\n\nThe function **only** returns this object if you cloned a source\nrepository.","properties":{"remote_name":{"description":"The source repository's name.","example":"origin","type":"string"},"url":{"description":"The source repository's clone URL.","example":"ssh://clone.domain.com/cloneme","type":"string"}},"type":"object"},"tasks":{"description":"An array of objects containing information about the\n[Task Queue](https://go.cpanel.net/whmdocsTaskQueueMonitor)\nsystem's process that will clone the repository.\n\n**Note:**\n\nThe function only returns this value if the clone process is\n**not** finished.","items":{"properties":{"action":{"description":"The task's action.\n\n* `create` — Create the repository.\n* `deploy` — Deploy the repository.","enum":["create","deploy"],"type":"string"},"args":{"description":"A list of arguments for the Task Queue system's process.","properties":{"log_file":{"description":"The absolute path to the process's log file.\n\n**Note:**\n\nThe function only returns this value if the process generated\na log file.","example":"/home/username/.cpanel/logs/vc_1234567890.123456_git_deploy.log","format":"path","type":"string"},"repository_root":{"description":"The absolute path to the repository's directory in the user's `home` directory.","example":"/home/user/example","type":"string"}},"type":"object"},"id":{"description":"The Task Queue system's task ID number.","example":"00000000/5a9ec8dd4c345d","type":"string"},"sse_url":{"description":"The Secure Server Events (SSE) interface URL to track the progress of the process.","example":"/sse/UserTasks/B3A27B96-51F7-11E8-92E3-CC90C4F823F0","type":"string"},"subsystem":{"description":"The Task Queue subsystem that will handle the task.\n\n* `VersionControl` is the only possible value.","enum":["VersionControl"],"example":"VersionControl","type":"string"}},"type":"object"},"type":"array"},"type":{"description":"The repository type.\n\n* `git` is the only possible value.","enum":["git"],"example":"git","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return Git repositories","tags":["VersionControl","Repository Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  VersionControl \\\n  retrieve\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/VersionControl/retrieve"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file VersionControl_retrieve.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/VersionControl_retrieve.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/VersionControl/,\n    q/retrieve/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file VersionControl_retrieve.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/VersionControl_retrieve.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'VersionControl',\n    'retrieve'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 72"}},"/Backup/restore_databases":{"post":{"description":"This function restores a database's backup files.\n\n**Important:**\n\nWhen the [MySQL Client role](https://go.cpanel.net/howtouseserverprofiles#roles) is disabled, the system also **disables** this function.\n\n**Note:**\n\nYou **must** pass either the `file` **or** `backup` parameter.","operationId":"restore_databases","parameters":[{"description":"The database backup file to restore.\n\n**Important:**\n\n**Only** pass this parameter to restore files already on the server.\n\n**Note:**\n\nTo restore multiple database backup files, increment the parameter name. For example: `backup-1`, `backup-2`, and `backup-3`.","examples":{"multiple":{"summary":"Restore multiple database backup files.","value":"backup-1=home/user/user_db1.sql.gz backup-2=home/user/user_db2.sql.gz backup-3=home/user/user_db3.sql.gz"},"single":{"summary":"Restore a single database backup file.","value":"home/user/user_db1.sql.gz"}},"in":"query","name":"backup","required":false,"schema":{"type":"string"}},{"description":"Whether to return additional information from the `/usr/local/cpanel/logs/cpbackup` log file.\n* `1` - Return additional information.\n* `0` - Do **not** return additional information.","in":"query","name":"verbose","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"The maximum number of seconds to try to restore the file.\n* `0` - The system will not time out the file restoration.","in":"query","name":"timeout","required":false,"schema":{"default":7200,"example":3600,"minimum":0,"type":"integer"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file":{"format":"binary","type":"string"}},"type":"object"}}},"description":"The database backup file to upload and restore.\n\n**Important:**\n\n* **Only** pass this parameter to upload files that don't already exist on the server.\n* You can **not** pass this parameter on the command line.\n\n**Note:**\n\n* To upload multiple database backup files, increment the parameter name. For example: `file-1`, `file-2`, and `file-3`.\n* Pass this file in a multipart/form-data structure.\n* For more information about this structure, read Mozilla's [POST Method](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST) documentation."},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"restore_databases","type":"string"},"module":{"description":"The name of the module called.","example":"Backup","type":"string"},"result":{"properties":{"data":{"properties":{"log_id":{"description":"The log file's restoration identification (ID). The system uses the backup restoration's date to create this ID. The ID is in [ISO-8601 Date Time](https://en.wikipedia.org/wiki/ISO_8601) format with the log's revision number appended.","example":"2019-08-13T15:10:07Z.1","type":"string"},"log_path":{"description":"The filepath to the backup restoration's log file.","example":"/home/cptest/logs/restoredb/2019-08-13T15:10:07Z.1.log","format":"path","type":"string"},"messages":{"description":"An array of statements about the database's restoration.","items":{"example":"The system successfully restored the database 'user_db1' from the backup file 'user_db1.sql.gz'","type":"string"},"type":"array"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Restore databases","tags":["File Restoration"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --input=json --output=jsonpretty \\\n  --user=username \\\n  Backup \\\n  restore_databases\n"},{"label":"HTTP Request (Wire Format)","lang":"HTTP","source":"POST /cpsess##########/execute/Backup/restore_databases HTTP/1.1\nHost: example.com:2083\nCookie: ###################################\nContent-Type: application/json\nContent-Length: 0\n\n"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 84"}},"/Backup/fullbackup_to_scp_with_password":{"get":{"description":"This function creates a full backup to a remote server via the secure copy protocol (`scp`) command with a password. The system creates a file in the `backup-MM.DD.YYYY_HH-mm-ss.tar.gz` filename format.","operationId":"fullbackup_to_scp_with_password","parameters":[{"description":"The remote server's hostname or IP address.","in":"query","name":"host","required":true,"schema":{"example":"example.com","oneOf":[{"description":"A valid ipv4 address.","format":"ipv4","type":"string"},{"description":"A valid hostname.","format":"hostname","type":"string"}],"type":"string"}},{"description":"The port to use during the transfer.","in":"query","name":"port","required":false,"schema":{"default":22,"example":22,"maximum":65335,"minimum":1,"type":"integer"}},{"description":"How to manage the home directory in the backup.\n\n* `include` — Include the home directory in the backup.\n* `skip` — Omit the home directory from the backup.","in":"query","name":"homedir","required":false,"schema":{"default":"include","enum":["include","skip"],"example":"include","type":"string"}},{"description":"The remote server account's username.","in":"query","name":"username","required":true,"schema":{"example":"username","type":"string"}},{"description":"The remote server account's password.","in":"query","name":"password","required":true,"schema":{"example":"luggage123456","type":"string"}},{"description":"The directory on the remote server that will store the backup.\n\n**Note:**\n\nThis parameter defaults to the remote server account's default login directory.","in":"query","name":"directory","required":false,"schema":{"example":"/user","type":"string"}},{"description":"The email address to receive a confirmation email when the backup completes.\n\n**Note:**\n\nThe system does **not** provide confirmation if you do **not** pass this parameter.","in":"query","name":"email","required":false,"schema":{"default":null,"example":"username@example.com","format":"email","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"fullbackup_to_scp_with_password","type":"string"},"module":{"description":"The name of the module called.","example":"Backup","type":"string"},"result":{"properties":{"data":{"properties":{"pid":{"description":"The backup's process identifier.","example":"2857","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Back up cPanel account via SCP with password","tags":["Backup"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Backup \\\n  fullbackup_to_scp_with_password \\\n  host='example.com' \\\n  username='username' \\\n  password='luggage123456'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Backup/fullbackup_to_scp_with_password?host=example.com&username=username&password=luggage123456"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Backup_fullbackup_to_scp_with_password.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Backup_fullbackup_to_scp_with_password.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Backup/,\n    q/fullbackup_to_scp_with_password/,\n    {\n        'host' => 'example.com',\n        'username' => 'username',\n        'password' => 'luggage123456',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Backup_fullbackup_to_scp_with_password.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Backup_fullbackup_to_scp_with_password.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Backup',\n    'fullbackup_to_scp_with_password',\n    array (\n        'host' => 'example.com',\n        'username' => 'username',\n        'password' => 'luggage123456',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 78"}},"/CCS/update_delegate":{"get":{"description":"This function updates the delegation of a user's calendar to another user.\n\n**Note:**\n\nYou **must** install the [Calendar and Contacts Server](https://go.cpanel.net/CalendarAndContactsServer) cPanel plugin to access this API function.","operationId":"update_delegate","parameters":[{"description":"The calendar's owner.","in":"query","name":"delegator","required":true,"schema":{"example":"user1@example.com","format":"email","type":"string"}},{"description":"The user to whom you delegated the calendar.","in":"query","name":"delegatee","required":true,"schema":{"example":"user2@example.com","format":"email","type":"string"}},{"description":"Whether the delegatee will only have read-only access on the calendar.\n* `1` - Read-only access.\n* `0` - Full access.","in":"query","name":"readonly","required":false,"schema":{"default":0,"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"update_delegate","type":"string"},"module":{"description":"The name of the module called.","example":"CCS","type":"string"},"result":{"properties":{"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` - Success.\n- `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update calendar delegation","tags":["CCS","Calendar and Contacts Server"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  CCS \\\n  update_delegate \\\n  delegator='user1@example.com' \\\n  delegatee='user2@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/CCS/update_delegate?delegator=user1%40example.com&delegatee=user2%40example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file CCS_update_delegate.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/CCS_update_delegate.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/CCS/,\n    q/update_delegate/,\n    {\n        'delegator' => 'user1@example.com',\n        'delegatee' => 'user2@example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file CCS_update_delegate.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/CCS_update_delegate.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'CCS',\n    'update_delegate',\n    array (\n        'delegator' => 'user1@example.com',\n        'delegatee' => 'user2@example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 90"}},"/Bandwidth/get_enabled_protocols":{"get":{"description":"This function returns a list of the server's enabled protocols.","operationId":"get_enabled_protocols","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_enabled_protocols","type":"string"},"module":{"description":"The name of the module called.","example":"Bandwidth","type":"string"},"result":{"properties":{"data":{"description":"The bandwidth protocols that the server records.\n* `ftp`\n* `imap`\n* `pop3`\n* `smtp`\n* `http` — This value includes all web traffic for the 80 and 443 ports.","items":{"enum":["ftp","http","imap","pop3","smtp"],"example":"imap","type":"string"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return services monitored in bandwidth data","tags":["Bandwidth"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Bandwidth \\\n  get_enabled_protocols\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Bandwidth/get_enabled_protocols"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Bandwidth_get_enabled_protocols.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Bandwidth_get_enabled_protocols.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Bandwidth/,\n    q/get_enabled_protocols/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Bandwidth_get_enabled_protocols.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Bandwidth_get_enabled_protocols.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Bandwidth',\n    'get_enabled_protocols'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 76"}},"/Bandwidth/query":{"get":{"description":"This function queries an account's bandwidth data and returns a report.\n\n**Note:**\n\nThis function also returns the bandwidth use of a [distributed cPanel account](https://go.cpanel.net/cPanelGlossary#distributed-cpanel-account).","operationId":"query","parameters":[{"description":"How to group the data in the report, in pipe-separated format. This list **must** contain one or both of the following parameters:\n\nA pipe-separated list that contains one or both of the following parameters:\n* `domain`\n* `protocol`\n\nThis parameter can also include only **one** of the following start time interval types:\n* `year`\n* `year_month`\n* `year_month_day`\n* `year_month_day_hour`\n* `year_month_day_mour_minute`\n\n**Note:**\n\n* This parameter accepts a maximum of three values.\n* The function nests the return objects in the order that you declare the values in this parameter.","examples":{"domain_protocol_year":{"summary":"domain|protocol|year","value":"grouping=domain|protocol|year"},"domain_year":{"summary":"domain|year","value":"grouping=domain|year"},"protocol_year_month":{"summary":"protocol|year_month","value":"grouping=protocol|year_month"},"year_month_day":{"summary":"year_month_day","value":"grouping=year_month_day"}},"explode":false,"in":"query","name":"grouping","required":true,"schema":{"anyOf":[{"enum":["domain","protocol"],"type":"string"},{"enum":["year","year_month","year_month_day","year_month_day_hour","year_month_day_hour_minute"],"type":"string"}]},"style":"pipeDelimited"},{"description":"Length of time between bandwidth data samples.\n\n* `daily`\n* `hourly`\n* `5min`\n\n**Note:**\n\nThe interval's retention period determines availability of the interval's data.\nUse the `Bandwidth::get_retention_periods` API to determine an interval's retention period.","in":"query","name":"interval","required":false,"schema":{"default":"daily","enum":["daily","hourly","5min"],"example":"daily","type":"string"}},{"description":"A pipe-separated list of domains for which to provided data.\n\n**Note:**\n\n* If you do not include this parameter, the function will return data for all domains on the cPanel account.\n* The `UNKNOWN` \"pseudo-domain\" refers to data recorded without a specific domain. All traffic except HTTP traffic\nis recorded without a specific domain.","examples":{"multiple":{"summary":"Get data for multiple domains and UNKNOWN.","value":"domains=example.com|subdomain.example.com|subdomain2.example.com|parkedexample.com|UNKNOWN"},"single":{"summary":"Get data for a specific domain.","value":"example.com"}},"explode":false,"in":"query","name":"domains","required":false,"schema":{"format":"domain","type":"string"},"style":"pipeDelimited"},{"description":"A pipe-separated list of the protocols for which to provide data.\n* `http`\n* `imap`\n* `smtp`\n* `pop3`\n* `ftp`","examples":{"multiple":{"summary":"Get data for multiple protocols.","value":"protocols=http|imap|smtp|pop3|ftp"},"single":{"summary":"Get data for a specific protocol.","value":"http"}},"explode":false,"in":"query","name":"protocols","required":false,"schema":{"type":"string"},"style":"pipeDelimited"},{"description":"The start date of the report window.","in":"query","name":"start","required":false,"schema":{"example":1445664609,"format":"unix_timestamp","type":"integer"}},{"description":"The end date of the report window.","in":"query","name":"end","required":false,"schema":{"example":1446664809,"format":"unix_timestamp","type":"integer"}},{"description":"The timezone in which to report the data.","in":"query","name":"timezone","required":false,"schema":{"example":"America/Chicago","format":"olson_timezone_name","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"domain":{"description":"grouping=domain","value":{"data":{"UNKNOWN":70447164,"example.com":815258916235,"parkedexample.com":18861122614,"subdomain.example.com":11407,"subdomain2.example.com":683533},"errors":null,"messages":null,"metadata":{},"status":1}},"domain_protocol_year":{"description":"grouping=domain|protocol|year","value":{"data":{"UNKNOWN":{"imap":{"1325376000":11036.0461226852,"1356998400":14892,"1388534400":5148,"1420070400":39745},"smtp":{"1325376000":155605,"1356998400":2525944.05255787,"1388534400":37310742,"1420070400":30384052}},"example.com":{"http":{"1325376000":11700672006,"1356998400":252262219725,"1388534400":330435334428,"1420070400":220860690076}},"parkedexample.com":{"http":{"1356998400":1214392,"1420070400":18859908222}},"subdomain.example.com":{"http":{"1388534400":10227,"1420070400":1180}},"subdomain2.example.com":{"http":{"1420070400":683533}}},"errors":null,"messages":null,"metadata":{},"status":1}},"domain_year":{"description":"grouping=domain|year","value":{"data":{"UNKNOWN":{"1325376000":141799,"1356998400":52558,"1388534400":56450,"1420070400":3737236},"example.com":{"1325376000":27496678808,"1356998400":16961550301,"1388534400":17664354048,"1420070400":26169989838},"parkedexample.com":{"1325376000":2474092283,"1356998400":1214392,"1388534400":1514221571,"1420070400":14871594368},"subdomain.example.com":{"1356998400":1180,"1388534400":5708,"1420070400":4519},"subdomain2.example.com":{"1420070400":683533}},"errors":null,"messages":null,"metadata":{},"status":1}},"year_domain":{"description":"grouping=year|domain","value":{"data":{"1325376000":{"UNKNOWN":70447164,"example.com":815258916235,"parkedexample.com":18861122614,"subdomain.example.com":11407,"subdomain2.example.com":683533},"1356998400":{"UNKNOWN":70447164,"example.com":815258916235,"parkedexample.com":18861122614,"subdomain.example.com":11407,"subdomain2.example.com":683533},"1388534400":{"UNKNOWN":70447164,"example.com":815258916235,"parkedexample.com":18861122614,"subdomain.example.com":11407,"subdomain2.example.com":683533},"1420070400":{"UNKNOWN":70447164,"example.com":815258916235,"parkedexample.com":18861122614,"subdomain.example.com":11407,"subdomain2.example.com":683533}},"errors":null,"messages":null,"metadata":{},"status":1}}},"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"query","type":"string"},"module":{"description":"The name of the module called.","example":"Bandwidth","type":"string"},"result":{"properties":{"data":{"additionalProperties":{"additionalProperties":{"additionalProperties":{"description":"This object's keys are the values of the third grouping parameter.","nullable":true,"type":"object","x-additionalPropertiesName":"grouping-param-value-3"},"description":"This object's keys are the values of the second grouping parameter.","nullable":true,"type":"object","x-additionalPropertiesName":"grouping-param-value-2"},"description":"This object's keys are the values of the first grouping parameter.","type":"object","x-additionalPropertiesName":"grouping-param-value-1"},"description":"The function returns data in a hierarchy of objects that the order of values in the `grouping` parameter determines.\n\nFor example:\n\n* `domain` - Returns data by domain.\n* `domain|protocol` - Returns data by protocol and nests it within the object for each domain.\n* `domain|year` - Returns data by year and nests it within the object for each domain.\n* `year|domain` - Returns data by domain and nests it within object for each year.\n* `domain|year|protocol` - Returns data by protocol and nests it within object for each year, which the result then nests in objects for each domain.\n\nThe deepest child object contains the bandwidth data in bytes.\n","type":"object"},"errors":{"description":"List of errors if the API failed.","items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"additionalProperties":{"nullable":true,"type":"object"},"description":"An object containing any additional data returned by the API."},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel account's bandwidth usage report","tags":["Bandwidth"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Bandwidth \\\n  query \\\n  grouping='domain|protocol|year'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Bandwidth/query?grouping=grouping%3ddomain%7cprotocol%7cyear"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Bandwidth_query.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Bandwidth_query.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Bandwidth/,\n    q/query/,\n    {\n        'grouping' => 'grouping=domain|protocol|year',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Bandwidth_query.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Bandwidth_query.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Bandwidth',\n    'query',\n    array (\n        'grouping' => 'grouping=domain|protocol|year',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.52"}},"/BoxTrapper/blacklist_messages":{"get":{"description":"This function blacklists email message senders.\n\n**Important:**\n\n  When you disable the [Receive Mail](https://go.cpanel.net/serverroles) role, the system disables this function.","operationId":"blacklist_messages","parameters":[{"description":"The email address for which to blacklist messages.\n\n**Warning:**\n\nIf you call this function in Webmail, the system ignores this parameter and defaults to the currently-authenticated user.","in":"query","name":"email","required":true,"schema":{"example":"user@example.com","format":"email","type":"string"}},{"description":"The filename of the email message to blacklist.","examples":{"multiple":{"summary":"Blacklist multiple filenames.","value":"queuefile=file1&queuefile=file2"},"single":{"summary":"Blacklist one filename.","value":"file1"}},"in":"query","name":"queuefile","required":true,"schema":{"example":"example.msg","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"blacklist_messages","type":"string"},"module":{"description":"The name of the module called.","example":"BoxTrapper","type":"string"},"result":{"properties":{"data":{"description":"An array of objects of blacklisted email information.","items":{"properties":{"email":{"description":"The email address that sent the blacklisted message.","example":"user@example.com","format":"email","type":"string"},"failed":{"description":"Whether the system failed to blacklist the message.\n\n**Note:**\n\n The function only returns this value if it doesn't blacklist the message.","enum":[1],"example":1,"type":"integer"},"matches":{"description":"An array of messages that the system deleted.","items":{"example":"example.msg","type":"string"},"type":"array"},"operator":{"description":"The action that the function performed.","enum":["blacklist"],"example":"blacklist","type":"string"},"reason":{"description":"A message about the failure or the warning.\n\n**Note:**\n\n The function only returns this value if it doesn't delete the message or experiences issues when it deletes the message.","example":"This is a failure message.","type":"string"},"warning":{"description":"Whether the system experienced issues when it blacklisted the message.\n\n**Note:**\n\n The function only returns this value if it doesn't blacklist the message.","enum":[1],"example":1,"type":"integer"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success.\n- 0 - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add email address to BoxTrapper blocked senders","tags":["BoxTrapper","Spam Prevention (BoxTrapper)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  BoxTrapper \\\n  blacklist_messages \\\n  email='user@example.com' \\\n  queuefile='file1'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/BoxTrapper/blacklist_messages?email=user%40example.com&queuefile=file1"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file BoxTrapper_blacklist_messages.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/BoxTrapper_blacklist_messages.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/BoxTrapper/,\n    q/blacklist_messages/,\n    {\n        'email' => 'user@example.com',\n        'queuefile' => 'file1',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file BoxTrapper_blacklist_messages.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/BoxTrapper_blacklist_messages.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'BoxTrapper',\n    'blacklist_messages',\n    array (\n        'email' => 'user@example.com',\n        'queuefile' => 'file1',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/BoxTrapper/deliver_messages":{"get":{"description":"This function delivers messages in the BoxTrapper queue.\n\n**Important:**\n\nWhen you disable the\n[*Receive Mail* role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),\nthe system **disables** this function.","operationId":"deliver_messages","parameters":[{"description":"The sender's cPanel account email address for which to deliver email messages.\n\n**Warning:**\n\nIf you call this function in Webmail, the system ignores this parameter\nand defaults to the currently-authenticated email address.","in":"query","name":"email","required":true,"schema":{"example":"user@example.com","format":"email","type":"string"}},{"description":"The filename of the email messages to deliver.\n\n**Note:**\n\nTo deliver multiple email messages, pass this parameter multiple times.","examples":{"multiple":{"summary":"Deliver multiple email messages.","value":"queuefile=example.msg&queuefile=example1.msg&queuefile=example2.msg"},"single":{"summary":"Deliver a single email message.","value":"example.msg"}},"in":"query","name":"queuefile","required":true,"schema":{"type":"string"}},{"description":"Whether to deliver all messages that resemble the `queuefile` parameter's value.\n\n* `1` - Deliver all similar messages.\n* `0` - Don't deliver all similar messages.","in":"query","name":"all_like","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"deliver_messages","type":"string"},"module":{"description":"The name of the module called.","example":"BoxTrapper","type":"string"},"result":{"properties":{"data":{"description":"The delivered email message information.","items":{"properties":{"email":{"description":"The delivered email message's sender.","example":"user@example.com","format":"email","type":"string"},"failed":{"description":"Whether the system could not deliver the message.\n\n**Note:**\n\n * The function only returns this value if it doesn't deliver the message.\n * `1` is the only possible value.","enum":[1],"example":1,"type":"integer"},"matches":{"description":"A list of delivered email messages.","items":{"example":"example.msg","type":"string"},"type":"array"},"operator":{"description":"The action that the function performed.\n\n* `deliver`\n* `deliverall`","enum":["deliver","deliverall"],"example":"deliverall","type":"string"},"reason":{"description":"A message about the failure or the warning.\n\n**Note:**\n\nThe function only returns this value if it doesn't delete the message or experiences\nissues when it deletes the message.","example":"This is a failure message.","type":"string"},"warning":{"description":"Whether the system experienced issues when it delivered the message.\n\n**Note:**\n\n * The function only returns this value if it experiences issues when it delivers the message.\n * `1` is the only possible value.","enum":[1],"example":1,"type":"integer"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Send messages in the BoxTrapper queue","tags":["BoxTrapper","Spam Prevention (BoxTrapper)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  BoxTrapper \\\n  deliver_messages \\\n  email='user@example.com' \\\n  queuefile='example.msg'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/BoxTrapper/deliver_messages?email=user%40example.com&queuefile=example.msg"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file BoxTrapper_deliver_messages.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/BoxTrapper_deliver_messages.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/BoxTrapper/,\n    q/deliver_messages/,\n    {\n        'email' => 'user@example.com',\n        'queuefile' => 'example.msg',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file BoxTrapper_deliver_messages.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/BoxTrapper_deliver_messages.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'BoxTrapper',\n    'deliver_messages',\n    array (\n        'email' => 'user@example.com',\n        'queuefile' => 'example.msg',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/BlockIP/add_ip":{"get":{"description":"This function blocks IP addresses from accessing the domains on a cPanel account.\n\n**Important**\n\nWhen you disable the Web Server role, the system disables this function.","operationId":"blockip-add-ip","parameters":[{"description":"The IP address or IP address range that you wish to block.","examples":{"cidr-ipv4":{"summary":"CIDR Format IPv4","value":"192.168.0.1/16"},"cidr-ipv6":{"summary":"CIDR Format IPv6","value":"2001:db8::/32"},"hostname":{"summary":"Add by resolving hostname","value":"example.com"},"implied-range":{"summary":"Implied Range","value":"192.168.0.1-58"},"ipv4-range":{"summary":"IPv4 Range","value":"192.168.0.1-192.168.0.58"},"ipv6-range":{"summary":"IPv6 Range","value":"2001:db8::1-2001:db8::3"},"single-ipv4":{"summary":"Single IPv4 Address","value":"192.0.2.0"},"single-ipv6":{"summary":"Single IPv6 Address","value":"2001:db8::1"},"subnet-octet":{"summary":"Subnet Range - Matches 10.*.*.*","value":"10."}},"in":"query","name":"ip","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"add_ip","type":"string"},"module":{"description":"The name of the module called.","example":"BlockIP","type":"string"},"result":{"properties":{"data":{"description":"IP addresses that were added, as translated by the system.","items":{"example":"1.1.1.1","type":"string"},"nullable":true,"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add IP address to cPanel account's block list","tags":["BlockIP","Block IP"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  BlockIP \\\n  add_ip \\\n  ip='192.168.0.1/16'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/BlockIP/add_ip?ip=192.168.0.1%2f16"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file BlockIP_add_ip.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/BlockIP_add_ip.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/BlockIP/,\n    q/add_ip/,\n    {\n        'ip' => '192.168.0.1/16',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file BlockIP_add_ip.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/BlockIP_add_ip.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'BlockIP',\n    'add_ip',\n    array (\n        'ip' => '192.168.0.1/16',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":82}},"/Backup/restore_email_forwarders":{"post":{"description":"This function restores an account's email forwarders.\n\n**Important:**\n\nWhen the [Receive Mail role](https://go.cpanel.net/howtouseserverprofiles#roles) is disabled, the system also **disables** this function.\n\n**Note:**\n\nYou **must** use the `backup` parameter when you call this function in one of the following formats:\n* As part of a `multipart/form-data` request body to upload and restore a backup file to the server. For more information about this structure, read Mozilla's [POST Method](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST) documentation.\n* As a query parameter to restore an existing file on the server.","operationId":"restore_email_forwarders","parameters":[{"description":"The email forwarder file to restore.\n\n**Important:**\n\n**Only** pass this parameter to restore email forwarder files that already exist on the server.\n\n**Note:**\n\nTo restore multiple email filter files, increment the parameter name. For example: `backup-1`, `backup-2`, and `backup-3`.","examples":{"multiple":{"summary":"Restore multiple email forwarder files.","value":"backup-1=/home/user/aliases-example1.com.gz backup-2=/home/user/aliases-example2.com.gz backup-3=/home/user/aliases-example3.com.gz"},"single":{"summary":"Restore a single email forwarder file.","value":"/home/user/aliases-example.com.gz"}},"in":"query","name":"backup","required":false,"schema":{"type":"string"}},{"description":"Whether to return additional information from the `/home/cpuser/.cpanel/logs/restore-email-forwarders` log files.\n* `1` - Return additional information.\n* `0` - Do not return additional information.","in":"query","name":"verbose","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"The maximum number of seconds to try to restore the file.\n* `0` - The system will not time out the file restoration.","in":"query","name":"timeout","required":false,"schema":{"default":7200,"example":3600,"minimum":0,"type":"integer"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"backup":{"format":"binary","type":"string"}},"type":"object"}}},"description":"The email forwarder file to upload and restore.\n\n**Important:**\n\n* **Only** pass this parameter to upload files that don't already exist on the server.\n* You can't pass this parameter on the command line.\n\n**Note:**\n\nTo upload multiple email filter files, increment the parameter name. For example: `backup-1`, `backup-2`, and `backup-3`."},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"restore_email_forwarders","type":"string"},"module":{"description":"The name of the module called.","example":"Backup","type":"string"},"result":{"properties":{"data":{"properties":{"log_id":{"description":"The log file's restoration identification (ID). The system uses the backup restoration's date to create this ID. The ID is in [ISO-8601 Date Time](https://en.wikipedia.org/wiki/ISO_8601) format with the log's revision number appended.","example":"2019-08-13T15:10:07Z.1","type":"string"},"log_path":{"description":"The filepath to the backup restoration's log file.","example":"/home/cpuser/.cpanel/logs/restore-email-forwarders/2019-09-11T18:30:49Z.1.log","format":"path","type":"string"},"messages":{"description":"An array of statements about the database's restoration.","items":{"example":"The system successfully restored the email forwarders from the 'aliases-example.com.gz' backup.","type":"string"},"type":"array"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Restore email forwarders","tags":["File Restoration"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --input=json --output=jsonpretty \\\n  --user=username \\\n  Backup \\\n  restore_email_forwarders\n"},{"label":"HTTP Request (Wire Format)","lang":"HTTP","source":"POST /cpsess##########/execute/Backup/restore_email_forwarders HTTP/1.1\nHost: example.com:2083\nCookie: ###################################\nContent-Type: application/json\nContent-Length: 0\n\n"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 86"}},"/BoxTrapper/get_blocklist":{"get":{"description":"This function retrieves a list of BoxTrapper blocklist configuration rules. BoxTrapper will delete messages that match these rules and send a notification to the sender.\n\n**Important:**\n\nWhen you disable the\n[*Receive Mail* role](https://go.cpanel.net/serverroles),\nthe system **disables** this function.","operationId":"BoxTrapper::get_blocklist","parameters":[{"description":"A valid email address on the cPanel account.\n\n**Warning:**\n\nIf you call this function in Webmail, the system overrides this parameter.\nThis parameter defaults to the current email address.","in":"query","name":"email","required":true,"schema":{"example":"user@example.com","format":"email","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_blocklist","type":"string"},"module":{"description":"The name of the module called.","example":"BoxTrapper","type":"string"},"result":{"properties":{"data":{"description":"The blocklist configuration rules.","items":{"description":"One blocklist rule.","example":"from blocklisted-email\\@domain\\.com","type":"string"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return account BoxTrapper blocklist rules","tags":["BoxTrapper","Spam Prevention (BoxTrapper)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  BoxTrapper \\\n  get_blocklist \\\n  email='user@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/BoxTrapper/get_blocklist?email=user%40example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file BoxTrapper_get_blocklist.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/BoxTrapper_get_blocklist.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/BoxTrapper/,\n    q/get_blocklist/,\n    {\n        'email' => 'user@example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file BoxTrapper_get_blocklist.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/BoxTrapper_get_blocklist.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'BoxTrapper',\n    'get_blocklist',\n    array (\n        'email' => 'user@example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 94"}},"/BoxTrapper/get_ignorelist":{"get":{"description":"This function retrieves a list of BoxTrapper ignorelist configuration rules. BoxTrapper will delete messages that match these rules without sending a notification to the sender.\n\n**Important:**\n\nWhen you disable the\n[*Receive Mail* role](https://go.cpanel.net/serverroles),\nthe system **disables** this function.","operationId":"BoxTrapper::get_ignorelist","parameters":[{"description":"A valid email address on the cPanel account.\n\n**Warning:**\n\nIf you call this function in Webmail, the system overrides this parameter.\nThis parameter defaults to the current email address.","in":"query","name":"email","required":true,"schema":{"example":"user@example.com","format":"email","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_ignorelist","type":"string"},"module":{"description":"The name of the module called.","example":"BoxTrapper","type":"string"},"result":{"properties":{"data":{"description":"The ignorelist configuration rules.","items":{"description":"One ignorelist rule.","example":"from ignored-email\\@domain\\.com","type":"string"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return account BoxTrapper ignorelist rules","tags":["BoxTrapper","Spam Prevention (BoxTrapper)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  BoxTrapper \\\n  get_ignorelist \\\n  email='user@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/BoxTrapper/get_ignorelist?email=user%40example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file BoxTrapper_get_ignorelist.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/BoxTrapper_get_ignorelist.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/BoxTrapper/,\n    q/get_ignorelist/,\n    {\n        'email' => 'user@example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file BoxTrapper_get_ignorelist.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/BoxTrapper_get_ignorelist.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'BoxTrapper',\n    'get_ignorelist',\n    array (\n        'email' => 'user@example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 94"}},"/BoxTrapper/get_message":{"get":{"description":"This function returns the first 200 lines of an email in the BoxTrapper queue.\n\n**Important:**\n\nWhen you disable the [Receive Mail](https://go.cpanel.net/serverroles) role, the system **disables** this function.","operationId":"get_message","parameters":[{"description":"The account’s name, either an email address or the cPanel user’s username.\n\n**Important:**\n\n If you call this function in Webmail, the system ignores this parameter.","example":"user@example.com","in":"query","name":"email","required":true,"schema":{"anyOf":[{"example":"user@example.com","format":"email","type":"string"},{"example":"exampleuser","format":"username","type":"string"}]}},{"description":"The message's filename.","in":"query","name":"queuefile","required":true,"schema":{"example":"example.msg","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_message","type":"string"},"module":{"description":"The name of the module called.","example":"BoxTrapper","type":"string"},"result":{"properties":{"data":{"properties":{"content":{"description":"The email message's contents. Up to the first 200 lines of an email message.","example":"From user@example.com Tue May 07 08:30:36 2019\nReceived: from user by example.com with local (Exim 4.92) (envelope-from <root@yourserver.net>)\n    id 1hO0B1-0003Ev-Md for user2@example.com; Tue, 07 May 2019 08:30:36 -0500\nFrom: user3@example.com\nSubject: Message\nMessage-Id: <E1hO0B1-0003Ev-Md@yourserver.net>\nDate: Tue, 07 May 2019 08:30:35 -0500\n\nThis is an email message","type":"string"},"contents":{},"queuefile":{"description":"The message's filename.","example":"example.msg","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return message's top 200 lines in BoxTrapper queue","tags":["BoxTrapper","Spam Prevention (BoxTrapper)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  BoxTrapper \\\n  get_message \\\n  email='user@example.com' \\\n  queuefile='example.msg'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/BoxTrapper/get_message?email=user%40example.com&queuefile=example.msg"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file BoxTrapper_get_message.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/BoxTrapper_get_message.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/BoxTrapper/,\n    q/get_message/,\n    {\n        'email' => 'user@example.com',\n        'queuefile' => 'example.msg',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file BoxTrapper_get_message.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/BoxTrapper_get_message.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'BoxTrapper',\n    'get_message',\n    array (\n        'email' => 'user@example.com',\n        'queuefile' => 'example.msg',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/BoxTrapper/get_email_template":{"get":{"description":"This function retrieves a BoxTrapper email message template.\n\n**Important:**\n\n  When you disable the\n  [*Receive Mail* role](https://go.cpanel.net/serverroles),\n  the system **disables** this function.","operationId":"get_email_template","parameters":[{"description":"A valid email address on the cPanel account.\n\n**Warning:**\n\nIf you call this function in Webmail, the system overrides this parameter.\nThis parameter defaults to the current email address.","in":"query","name":"email","required":true,"schema":{"example":"user@example.com","format":"email","type":"string"}},{"description":"The message template.\n\n* `blacklist`\n* `returnverify`\n* `verifyreleased`\n* `verify`\n\n**Note:**\n\nFor more information on each template, read our\n[BoxTrapper](https://go.cpanel.net/cpaneldocsBoxTrapper) documentation.","in":"query","name":"template","required":true,"schema":{"enum":["blacklist","returnverify","verifyreleased","verify"],"example":"verify","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_email_template","type":"string"},"module":{"description":"The name of the module called.","example":"BoxTrapper","type":"string"},"result":{"properties":{"data":{"description":"The template file's contents.","example":"To: %email%\\nSubject: Re: %subject%\\n\\nThe user %acct% does not accept mail from your address.\\n\\nThe headers of the message sent from your address are shown below:\\n\\n%headers%\\n\",","type":"string"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return specified BoxTrapper email template","tags":["BoxTrapper","Spam Prevention (BoxTrapper)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  BoxTrapper \\\n  get_email_template \\\n  email='user@example.com' \\\n  template='verify'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/BoxTrapper/get_email_template?email=user%40example.com&template=verify"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file BoxTrapper_get_email_template.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/BoxTrapper_get_email_template.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/BoxTrapper/,\n    q/get_email_template/,\n    {\n        'email' => 'user@example.com',\n        'template' => 'verify',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file BoxTrapper_get_email_template.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/BoxTrapper_get_email_template.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'BoxTrapper',\n    'get_email_template',\n    array (\n        'email' => 'user@example.com',\n        'template' => 'verify',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 84"}},"/BoxTrapper/ignore_messages":{"get":{"description":"This function marks email message senders for Exim to ignore.\n\n**Important:**\n\nWhen you disable the [Receive Mail role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"ignore_messages","parameters":[{"description":"The cPanel email account from which to ignore messages.\n\n**Warning:** \n\nIf you call this function in Webmail, the system ignores this parameter and defaults\nto the currently-authenticated email address.","in":"query","name":"email","required":true,"schema":{"example":"user@example.com","format":"email","type":"string"}},{"description":"The filename of the email message to ignore.\n\n**Note:**\n\n To ignore multiple email messages, duplicate this parameter.","examples":{"multiple":{"summary":"Ignore multiple email messages.","value":"queuefile-1=example1.msg queuefile-2=example2.msg queuefile-3=example3.msg"},"single":{"summary":"Ignore a single email message.","value":"example.msg"}},"in":"query","name":"queuefile","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"ignore_messages","type":"string"},"module":{"description":"The name of the module called.","example":"BoxTrapper","type":"string"},"result":{"properties":{"data":{"description":"An array of objects containing ignored email message information.","example":[{"email":"user@example.com","matches":["example.msg"],"operator":"ignore"}],"items":{"properties":{"email":{"description":"The ignored email message's sender.","example":"user@example.com","format":"email","type":"string"},"failed":{"description":"Whether the system failed to ignore the messages.\n\n* `1` - Failed to ignore the message.\n\n* `1` - Failed to ignore the message.\n\n* `1` - Failed to ignore the message.\n\n* `1` - Failed to ignore the message.\n\n* `1` - Failed to ignore the message.\n\n**Note:**\n\n The function only returns this value if it experiences issues when it ignores the message.","enum":[1],"example":1,"type":"integer"},"matches":{"description":"An array containing ignored message files.","items":{"example":"example.msg","type":"string"},"type":"array"},"operator":{"description":"The operation that the system performed.\n\n* `ignore` — The system ignored this email message.","enum":["ignore"],"example":"ignore","type":"string"},"reason":{"description":"A message that describes the failure or the warning.\n\n**Note:**\n\n The function only returns this value if it doesn't ignore the message or experiences issues when it ignores the message. ","example":"This is a failure message.","type":"string"},"warning":{"description":"Whether the system experienced issues when it ignored the message.\n\n* `1` — The system encountered a problem.\n\n**Note:**\n\n The function only returns this value if it experiences issues when it ignores the message.","enum":[1],"example":1,"type":"integer"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- `1` - Success.\n- `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add email account to Exim ignore list","tags":["BoxTrapper","Spam Prevention (BoxTrapper)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  BoxTrapper \\\n  ignore_messages \\\n  email='user@example.com' \\\n  queuefile='example.msg'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/BoxTrapper/ignore_messages?email=user%40example.com&queuefile=example.msg"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file BoxTrapper_ignore_messages.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/BoxTrapper_ignore_messages.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/BoxTrapper/,\n    q/ignore_messages/,\n    {\n        'email' => 'user@example.com',\n        'queuefile' => 'example.msg',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file BoxTrapper_ignore_messages.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/BoxTrapper_ignore_messages.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'BoxTrapper',\n    'ignore_messages',\n    array (\n        'email' => 'user@example.com',\n        'queuefile' => 'example.msg',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/BoxTrapper/reset_email_template":{"get":{"description":"This function restores the BoxTrapper email message templates to the system default setting.\n\n**Important:**\n\nWhen you **disable** the [Receive Mail](https://go.cpanel.net/serverroles) role, the system disables this function.","operationId":"reset_email_template","parameters":[{"description":"The account's email address.\n\n**Warning:**\n\nThe `email` parameter is required when this function is called outside of webmail.\nIf you call this function in Webmail, the `email` parameter is not required, and\nthe system overrides this parameter with the current authenticated user's email address.","in":"query","name":"email","schema":{"example":"user@example.com","format":"email","type":"string"}},{"description":"The message template. Possible values:\n* `blacklist` - BoxTrapper responds with this message when a blacklisted address sends an email.\n* `verify` - BoxTrapper responds with this message when an address that does not exist on the whitelist or blacklist sends an email. This message requests a response to confirm that the sender is legitimate.\n* `verifyreleased` - BoxTrapper responds with this message when a person responds to the verify message with an email or a click on the verification link.\n* `returnverify` - BoxTrapper responds with this message when the verification process fails.","in":"query","name":"template","required":true,"schema":{"enum":["blacklist","verify","verifyreleased","returnverify"],"example":"verify","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"reset_email_template","type":"string"},"module":{"description":"The name of the module called.","example":"BoxTrapper","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Restore default BoxTrapper email message template","tags":["BoxTrapper","Spam Prevention (BoxTrapper)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  BoxTrapper \\\n  reset_email_template \\\n  template='verify'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/BoxTrapper/reset_email_template?template=verify"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file BoxTrapper_reset_email_template.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/BoxTrapper_reset_email_template.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/BoxTrapper/,\n    q/reset_email_template/,\n    {\n        'template' => 'verify',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file BoxTrapper_reset_email_template.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/BoxTrapper_reset_email_template.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'BoxTrapper',\n    'reset_email_template',\n    array (\n        'template' => 'verify',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 84"}},"/BoxTrapper/set_ignorelist":{"get":{"description":"This function sets the BoxTrapper ignorelist configuration rules. BoxTrapper will delete messages that match these rules without sending a notification to the sender.\n\n**Important:**\n\nWhen you disable the\n[*Receive Mail* role](https://go.cpanel.net/serverroles),\nthe system **disables** this function.","operationId":"BoxTrapper::set_ignorelist","parameters":[{"description":"A valid email address on the cPanel account.\n\n**Warning:**\n\nIf you call this function in Webmail, the system overrides this parameter.\nThis parameter defaults to the current email address.","in":"query","name":"email","required":true,"schema":{"example":"user@example.com","format":"email","type":"string"}},{"description":"An array of ignorelist rules.\n\n**Note:**\n\nYou can set multiple ignore rules, duplicate or increment the parameter name. For example,\n`rules-1`, `rules-2`, and `rules-3`.","examples":{"multiple":{"summary":"Set multiple rules.","value":"rules-1='ignored-email\\@domain\\.com' rules-2='from ignored-email2\\@domain\\.com' rules-3='to domain2\\.com'"},"multiple-alternative":{"summary":"Set multiple rules.","value":"rules='ignored-email\\@domain\\.com' rules='from ignored-email2\\@domain\\.com' rules='to domain2\\.com'"},"single":{"summary":"Set a single rule.","value":"ignored-email\\@domain\\.com"}},"in":"query","name":"rules","required":true,"schema":{"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_ignorelist","type":"string"},"module":{"description":"The name of the module called.","example":"BoxTrapper","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update account BoxTrapper ignorelist","tags":["BoxTrapper","Spam Prevention (BoxTrapper)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty --user=username BoxTrapper set_ignorelist email='user@example.com' rules-1='ignored-email\\@domain\\.com' rules-2='from ignored-email2\\@domain\\.com' rules-3='to domain2\\.com'"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/BoxTrapper/set_ignorelist?email=user%40example.com&rules=ignored-email%5c%40domain%5c.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file BoxTrapper_set_ignorelist.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/BoxTrapper_set_ignorelist.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/BoxTrapper/,\n    q/set_ignorelist/,\n    {\n        'email' => 'user@example.com',\n        'rules' => 'ignored-email\\@domain\\.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file BoxTrapper_set_ignorelist.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/BoxTrapper_set_ignorelist.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'BoxTrapper',\n    'set_ignorelist',\n    array (\n        'email' => 'user@example.com',\n        'rules' => 'ignored-email\\@domain\\.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 94"}},"/BoxTrapper/save_email_template":{"get":{"description":"This function saves the contents of a BoxTrapper message template.\n\n**Important:**\n\nWhen you disable the [_Receive Mail_ role](https://go.cpanel.net/howtouseserverprofiles#roles),\nthe system **disables** this function.","operationId":"save_email_template","parameters":[{"description":"The account's email address.\n\n**Warning:**\n\nIf you call this function in Webmail, the system overrides this parameter.\n\n**Note:**\n\nThis parameter defaults to the current email address.","in":"query","name":"email","required":true,"schema":{"example":"user@example.com","format":"email","type":"string"}},{"description":"The message template.\n\n* `blacklist`\n* `returnverify`\n* `verifyreleased`\n* `verify`\n\n**Important:**\n\nIf you use the `verify` template, you **must** include `Subject: verify#%msgid%` in this parameter's value.\n\n**Note:**\n\nFor more information about each template, read our [BoxTrapper documentation](https://go.cpanel.net/cpaneldocsBoxTrapper).","in":"query","name":"template","required":true,"schema":{"enum":["blacklist","returnverify","verifyreleased","verify"],"example":"blacklist","type":"string"}},{"description":"The template file's contents.\n\nYou can use [variables](https://go.cpanel.net/cpaneldocsBoxTrapper) in the template\nto include details about the original message.\n\n**Important:**\n\n* You **must** include `To: %email%` in this parameter's value.\n* If you use the `verify` template, you **must** include `Subject: verify#%msgid%` in this parameter's value.\n* This value cannot exceed four kilobytes (KB).\n* You **must** URI-encode this parameter's value when using the CLI.","in":"query","name":"contents","required":true,"schema":{"example":"To: %email%\nSubject: Re: %subject%\n\nThe user %acct% does not accept mail from your address.\n\nThe headers of the message sent from your address are shown below:\n\n%headers%","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"save_email_template","type":"string"},"module":{"description":"The name of the module called.","example":"BoxTrapper","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Save BoxTrapper message template contents","tags":["BoxTrapper","Spam Prevention (BoxTrapper)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  BoxTrapper \\\n  save_email_template \\\n  email='user@example.com' \\\n  template='blacklist' \\\n  contents='To: %25email%25\nSubject: Re: %25subject%25\n\nThe user %25acct%25 does not accept mail from your address.\n\nThe headers of the message sent from your address are shown below:\n\n%25headers%25'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/BoxTrapper/save_email_template?email=user%40example.com&template=blacklist&contents=To%3a%20%25email%25%0aSubject%3a%20Re%3a%20%25subject%25%0a%0aThe%20user%20%25acct%25%20does%20not%20accept%20mail%20from%20your%20address.%0a%0aThe%20headers%20of%20the%20message%20sent%20from%20your%20address%20are%20shown%20below%3a%0a%0a%25headers%25"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file BoxTrapper_save_email_template.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/BoxTrapper_save_email_template.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/BoxTrapper/,\n    q/save_email_template/,\n    {\n        'email' => 'user@example.com',\n        'template' => 'blacklist',\n        'contents' => 'To: %email%\nSubject: Re: %subject%\n\nThe user %acct% does not accept mail from your address.\n\nThe headers of the message sent from your address are shown below:\n\n%headers%',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file BoxTrapper_save_email_template.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/BoxTrapper_save_email_template.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'BoxTrapper',\n    'save_email_template',\n    array (\n        'email' => 'user@example.com',\n        'template' => 'blacklist',\n        'contents' => 'To: %email%\nSubject: Re: %subject%\n\nThe user %acct% does not accept mail from your address.\n\nThe headers of the message sent from your address are shown below:\n\n%headers%',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 84"}},"/BoxTrapper/list_queued_messages":{"get":{"description":"This function returns a list of messages in the account's BoxTrapper queue.\n\n**Important:**\n\n  When you disable the [*Receive Mail* role](https://go.cpanel.net/serverroles), the system **disables**\n  this function.","operationId":"list_queued_messages","parameters":[{"description":"The email account for which to retrieve queued messages.\n\n**Important:**\n\nIf you call this function in Webmail, the system ignores this parameter and defaults to the currently authenticated email address.","in":"query","name":"email","required":true,"schema":{"example":"user@example.com","format":"email","type":"string"}},{"description":"The date for which to return queued messages.","in":"query","name":"date","required":false,"schema":{"default":"the current time","example":1556812881,"format":"unix_timestamp","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_queued_messages","type":"string"},"module":{"description":"The name of the module called.","example":"BoxTrapper","type":"string"},"result":{"properties":{"data":{"description":"Information about each queued message.","items":{"properties":{"from":{"description":"The sender's email address.","example":"user@example.com","format":"email","type":"string"},"queuefile":{"description":"The message's unique ID.","example":"example.msg","type":"string"},"subject":{"description":"The message's subject.","example":"Email Message Subject","type":"string"},"time":{"description":"The message's creation time.","example":1556812881,"format":"unix_timestamp","type":"integer"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return email account's BoxTrapper queued messages","tags":["BoxTrapper","Spam Prevention (BoxTrapper)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  BoxTrapper \\\n  list_queued_messages \\\n  email='user@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/BoxTrapper/list_queued_messages?email=user%40example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file BoxTrapper_list_queued_messages.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/BoxTrapper_list_queued_messages.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/BoxTrapper/,\n    q/list_queued_messages/,\n    {\n        'email' => 'user@example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file BoxTrapper_list_queued_messages.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/BoxTrapper_list_queued_messages.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'BoxTrapper',\n    'list_queued_messages',\n    array (\n        'email' => 'user@example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/Mysql/setup_db_and_user":{"get":{"description":"This function creates a randomly named MySQL® database and user. This allows a 3rdparty tool to create its own DB without needing any knowledge of cPanel internals such as quotas or other limits. These will simply be passed back as an error.\n\n**Important:**\n\n  When you disable the [MySQL/MariaDB role](https://go.cpanel.net/howtouseserverprofiles#roles) **and** remote MySQL is **not** already configured, the system **disables** this function.","operationId":"setup_db_and_user","parameters":[{"description":"An optional string to prepend to the randomly generated database name. This is in addition to the cPanel user which will appear prior to this. The prefix should be 6 characters or less and be only alphanumeric characters. WARNING: longer prexies lead to less entropy in the random username. Keep it short if you can!","in":"query","name":"prefix","required":false,"schema":{"example":"wp","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"setup_db_and_user","type":"string"},"module":{"description":"The name of the module called.","example":"Mysql","type":"string"},"result":{"properties":{"data":{"properties":{"database":{"description":"The randomized name of the database created. This is normally prefixed with the account username and can also be prefixed with application prefix.","oneOf":[{"example":"cpuser_wp_gwl7vpix28owo855yjomc7rsghkbjv0d0kf45kcvzip9tyxw9kdd","format":"database name","type":"string"},{"example":"cpuser_ljiupjkhrn6zs20c9glnms0xor8sx48fm4noohri07xdruj31q","format":"database name","type":"string"}]},"database_user":{"description":"The randomized username assigned to the database. This is normally prefixed with the account username and can also be prefixed with application prefix.","oneOf":[{"example":"cpuser_wp_dji1jdt7nhjiwjcjju45","format":"database username","type":"string"},{"example":"cpuser_dji1jdt7nhjiwjcjju45asd","format":"database username","type":"string"}]},"database_user_password":{"description":"A randomly generated password intended to be maximally randomized.","example":";1t/U:wnFkCRL9q68]/+<TX=.C#7]n","format":"password","type":"string"},"hostname":{"description":"The hostname to connect to from within the server to connect to the MySQL server","oneOf":[{"example":"localhost","format":"hostname","type":"string"},{"example":"mysql.remote.server.tld","format":"hostname","type":"string"}]},"port":{"description":"The port to connect to from within the server to connect to the MySQL server","example":3306,"format":"unix-port","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Create a randomly named MySQL username/database set.","tags":["Mysql","Database Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mysql \\\n  setup_db_and_user \\\n  prefix='wp'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mysql/setup_db_and_user?prefix=wp"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mysql_setup_db_and_user.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mysql_setup_db_and_user.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mysql/,\n    q/setup_db_and_user/,\n    {\n        'prefix' => 'wp',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mysql_setup_db_and_user.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mysql_setup_db_and_user.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mysql',\n    'setup_db_and_user',\n    array (\n        'prefix' => 'wp',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.116"}},"/Team/set_notes":{"get":{"description":"This function replaces the current notes field with new text.","operationId":"set_team_user_notes","parameters":[{"description":"The username of the team user.","in":"query","name":"user","required":true,"schema":{"example":"teamUser","type":"string"}},{"description":"The content of the notes field.","in":"query","name":"notes","required":true,"schema":{"example":"teamUser is a good employee","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_notes","type":"string"},"module":{"description":"The name of the module called.","example":"Team","type":"string"},"result":{"properties":{"data":{"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Set notes for a team user","tags":["Team Users"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Team \\\n  set_notes \\\n  user='teamUser' \\\n  notes='teamUser '\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Team/set_notes?user=teamUser&notes=teamUser%20"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account, where theme-name represents\n# jupiter.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Team_set_notes.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Team_set_notes.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Team/,\n    q/set_notes/,\n    {\n        'user' => 'teamUser',\n        'notes' => 'teamUser ',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account, where theme-name represents\n// jupiter.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Team_set_notes.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Team_set_notes.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Team',\n    'set_notes',\n    array (\n        'user' => 'teamUser',\n        'notes' => 'teamUser ',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}\n"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":110}},"/Team/set_locale":{"get":{"description":"This function sets locale for a team user.","operationId":"Team::set_locale","parameters":[{"description":"The username of the team user.","in":"query","name":"user","required":true,"schema":{"example":"teamuser","type":"string"}},{"description":"The new locale for the team user.","in":"query","name":"locale","required":true,"schema":{"example":"es_es","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_locale","type":"string"},"module":{"description":"The name of the module called.","example":"Team","type":"string"},"result":{"properties":{"data":{"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Set locale for a team user","tags":["Team Users"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Team \\\n  set_locale \\\n  user='teamuser' \\\n  locale='es_es'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Team/set_locale?user=teamuser&locale=es_es"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Team_set_locale.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Team_set_locale.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Team/,\n    q/set_locale/,\n    {\n        'user' => 'teamuser',\n        'locale' => 'es_es',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Team_set_locale.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Team_set_locale.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Team',\n    'set_locale',\n    array (\n        'user' => 'teamuser',\n        'locale' => 'es_es',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":108}},"/TwoFactorAuth/get_team_user_configuration":{"get":{"description":"This function retrieves a [team user's](https://go.cpanel.net/manage-team) configuration settings for two-factor authentication.","operationId":"get_team_user_configuration","parameters":[{"description":"The team user's username.\n\n**Note:**\n\nThe username will always precede the cPanel account's primary domain.","in":"query","name":"team_user","required":true,"schema":{"example":"user@example.com","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_team_user_configuration","type":"string"},"module":{"description":"The name of the module called.","example":"TwoFactorAuth","type":"string"},"result":{"properties":{"data":{"properties":{"is_enabled":{"description":"Whether two-factor authentication is enabled for the team user.\n* `1` - Enabled.\n* `0` - Disabled.","enum":[0,1],"example":1,"type":"integer"},"issuer":{"description":"The authentication code issuer's name.","example":"Example WebPros International, LLC","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return team user 2FA config","tags":["TwoFactorAuth","Two-Factor Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  TwoFactorAuth \\\n  get_team_user_configuration \\\n  team_user=teamuser\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/TwoFactorAuth/get_team_user_configuration"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file TwoFactorAuth_get_team_user_configuration.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/TwoFactorAuth_get_team_user_configuration.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/TwoFactorAuth/,\n    q/get_team_user_configuration/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file TwoFactorAuth_get_team_user_configuration.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/TwoFactorAuth_get_team_user_configuration.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'TwoFactorAuth',\n    'get_team_user_configuration'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/TwoFactorAuth/get_user_configuration":{"get":{"description":"This function retrieves the cPanel account user's configuration settings for two-factor authentication.","operationId":"get_user_configuration","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_user_configuration","type":"string"},"module":{"description":"The name of the module called.","example":"TwoFactorAuth","type":"string"},"result":{"properties":{"data":{"properties":{"is_enabled":{"description":"Whether two-factor authentication is enabled for the account.\n* `1` - Enabled.\n* `0` - Disabled.","enum":[0,1],"example":1,"type":"integer"},"issuer":{"description":"The authentication code issuer's name.","example":"Example WebPros International, LLC","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return cPanel account 2FA config","tags":["TwoFactorAuth","Two-Factor Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  TwoFactorAuth \\\n  get_user_configuration\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/TwoFactorAuth/get_user_configuration"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file TwoFactorAuth_get_user_configuration.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/TwoFactorAuth_get_user_configuration.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/TwoFactorAuth/,\n    q/get_user_configuration/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file TwoFactorAuth_get_user_configuration.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/TwoFactorAuth_get_user_configuration.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'TwoFactorAuth',\n    'get_user_configuration'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/TwoFactorAuth/set_user_configuration":{"get":{"description":"This function configures the two-factor authentication settings for an account.","operationId":"set_user_configuration","parameters":[{"description":"The 16-character string that UAPI's `TwoFactorAuth::generate_user_configuration` function generates.","in":"query","name":"secret","required":true,"schema":{"example":"JBSWY3DPEHPK3PXP","maxLength":16,"type":"string"}},{"description":"The six-digit security code that the time-based one-time password (TOTP) authentication app generates.","in":"query","name":"tfa_token","required":true,"schema":{"example":528112,"maxLength":6,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_user_configuration","type":"string"},"module":{"description":"The name of the module called.","example":"TwoFactorAuth","type":"string"},"result":{"properties":{"data":{"properties":{"tfa_configured":{"description":"Whether two-factor authentication is enabled.\n* `1` - Enabled.\n* `1` - Disabled.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Save 2FA config","tags":["TwoFactorAuth","Two-Factor Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  TwoFactorAuth \\\n  set_user_configuration \\\n  secret='JBSWY3DPEHPK3PXP' \\\n  tfa_token='528112'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/TwoFactorAuth/set_user_configuration?secret=JBSWY3DPEHPK3PXP&tfa_token=528112"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file TwoFactorAuth_set_user_configuration.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/TwoFactorAuth_set_user_configuration.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/TwoFactorAuth/,\n    q/set_user_configuration/,\n    {\n        'secret' => 'JBSWY3DPEHPK3PXP',\n        'tfa_token' => '528112',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file TwoFactorAuth_set_user_configuration.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/TwoFactorAuth_set_user_configuration.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'TwoFactorAuth',\n    'set_user_configuration',\n    array (\n        'secret' => 'JBSWY3DPEHPK3PXP',\n        'tfa_token' => '528112',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/TwoFactorAuth/remove_user_configuration":{"get":{"description":"This function removes the user from the two-factor authentication `userdata` file.","operationId":"remove_user_configuration","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"remove_user_configuration","type":"string"},"module":{"description":"The name of the module called.","example":"TwoFactorAuth","type":"string"},"result":{"properties":{"data":{"properties":{"tfa_removed":{"description":"Whether the system removed the user from the two-factor authentication `userdata` file.\n* `1` - Removed.\n\n**Note:**\n\nIf a removal fails, the system sends a failure response with the reason in the metadata.","enum":[1],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove 2FA config","tags":["TwoFactorAuth","Two-Factor Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  TwoFactorAuth \\\n  remove_user_configuration\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/TwoFactorAuth/remove_user_configuration"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file TwoFactorAuth_remove_user_configuration.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/TwoFactorAuth_remove_user_configuration.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/TwoFactorAuth/,\n    q/remove_user_configuration/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file TwoFactorAuth_remove_user_configuration.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/TwoFactorAuth_remove_user_configuration.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'TwoFactorAuth',\n    'remove_user_configuration'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/ExternalAuthentication/get_authn_links":{"get":{"description":"This function lists the external authentication links to the current cPanel account.","operationId":"get_authn_links","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_authn_links","type":"string"},"module":{"description":"The name of the module called.","example":"ExternalAuthentication","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"link_time":{"description":"When the user linked their account to the identity provider.","example":1443124604,"format":"unix_timestamp","type":"integer"},"preferred_username":{"description":"The preferred username of the account on the identity provider.","example":"username@gmail.com","type":"string"},"provider_id":{"description":"The system's unique key for the identity provider.","example":"google","type":"string"},"provider_protocol":{"description":"The identity provider's protocol.","example":"openid_connect","type":"string"},"subject_unique_identifier":{"description":"The unique identifier for the user at the identity provider.","example":123456789012346,"type":"integer"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* 1 — Success\n* 0 — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return external authentication links","tags":["ExternalAuthentication","External Authentication"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  ExternalAuthentication \\\n  get_authn_links\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/ExternalAuthentication/get_authn_links"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file ExternalAuthentication_get_authn_links.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/ExternalAuthentication_get_authn_links.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/ExternalAuthentication/,\n    q/get_authn_links/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file ExternalAuthentication_get_authn_links.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/ExternalAuthentication_get_authn_links.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'ExternalAuthentication',\n    'get_authn_links'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/UserManager/change_password":{"get":{"description":"This function updates the cPanel account's password.","operationId":"change_password","parameters":[{"description":"The current password.","in":"query","name":"oldpass","required":true,"schema":{"example":"ThisWasMyPassword!","format":"password","type":"string"}},{"description":"The new password.","in":"query","name":"newpass","required":true,"schema":{"example":"MyNewPassw0rd!","format":"password","type":"string"}},{"description":"Whether to update the cPanel account's MySQL password.\n* `1` - Update MySQL password.\n* `0` - Do not update MySQL passowrd.","in":"query","name":"enablemysql","required":false,"schema":{"default":0,"enum":[0,1],"example":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"change_password","type":"string"},"module":{"description":"The name of the module called.","example":"UserManager","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update cPanel account password","tags":["UserManager","Account Management"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  UserManager \\\n  change_password \\\n  oldpass='MyPreviousPassword' \\\n  newpass='MyUpdatedPassword'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/UserManager/change_password?oldpass=12346=newpass=ThisIs4It!"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file UserManager_change_password.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/UserManager_change_password.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/UserManager/,\n    q/change_password/,\n    {\n        'oldpass' => 'PreviousPassword',\n        'newpass' => 'B3tt3rP4ssw0rd!',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file UserManager_change_password.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/UserManager_change_password.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'UserManager',\n    'change_password',\n    array (\n        'oldpass' => 'PreviousPassword',\n        'newpass' => 'B3tt3rP4ssw0rd!',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 116"}},"/LangPHP/php_get_vhost_versions":{"get":{"description":"This function returns the PHP version of every virtual host that a reseller controls.\n\nYou can get the version of a single virtual host by providing an optional `vhost` name.\n\n**Note:**\n\n  This document **only** applies to systems that run EasyApache 4.\n\n**Important:**\n\n  When you disable the [Web Server role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.","operationId":"php_get_vhost_versions","parameters":[{"description":"The PHP Virtual Hostname.","in":"query","name":"vhost","required":false,"schema":{"example":"your-domain.test","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"php_get_vhost_versions","type":"string"},"module":{"description":"The name of the module called.","example":"LangPHP","type":"string"},"result":{"properties":{"data":{"description":"An array of objects of the virtual host's suspended\nstatus, versions, virtual hosts, and accounts.\nNote: Returns a single object when using the `vhost` parameter.","items":{"properties":{"account":{"description":"The account's name.","example":"blee","format":"username","type":"string"},"account_owner":{"description":"The account's owner.","example":"blee","format":"username","type":"string"},"documentroot":{"description":"The virtual host's document root.","example":"/home/blee/public_html","format":"path","type":"string"},"homedir":{"description":"The virtual host's home directory.","example":"/home/blee","format":"path","type":"string"},"main_domain":{"description":"Whether the virtual host is the primary domain.\n\n**Note:**\n\n* `1` - The primary domain\n* `0` - **Not** the primary domain","enum":[1,0],"example":1,"type":"integer"},"php_fpm":{"description":"Whether FPM is enabled on the virtual host.\n\n* `1` - PHP-FPM enabled.\n* `0` - PHP-FPM **not** enabled.","enum":[0,1],"example":1,"type":"integer"},"php_fpm_pool_parms":{"description":"An object containing the domain's PHP-FPM parameters.","properties":{"pm_max_children":{"description":"The maximum number of child pages per pool.","example":5,"minimum":1,"type":"integer"},"pm_max_requests":{"description":"The maximum number of requests per pool.","example":20,"minimum":1,"type":"integer"},"pm_process_idle_timeout":{"description":"A specified time of idleness before the system kills an FPM child process.","example":10,"minimum":1,"type":"integer"}},"type":"object"},"phpversion_source":{"description":"How the virtual host determines its PHP version.","items":{"properties":{"domain":{"description":"The domain the virtual host inherits its PHP version from.","example":"blee.com","format":"domain","type":"string"},"system_default":{"description":"Whether the virtual host uses the system's default PHP version.\n* `1` - Uses the system default PHP version.\n\n**Note:**\n\n  The function **only** returns this value if true.","enum":[1],"example":1,"type":"integer"}},"type":"object"},"properties":{"domain":{}},"type":"array"},"version":{"description":"The virtual host's PHP version.\n* `ea-php72`\n* `ea-php73`\n* `ea-php74`\n* Any custom PHP package name.","example":"ea-php72","type":"string"},"vhost":{"description":"The virtual host's name.","example":"blee.com","format":"domain","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return virtual host's PHP version","tags":["LangPHP","PHP Settings"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  LangPHP \\\n  php_get_vhost_versions\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/LangPHP/php_get_vhost_versions"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file LangPHP_php_get_vhost_versions.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/LangPHP_php_get_vhost_versions.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/LangPHP/,\n    q/php_get_vhost_versions/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file LangPHP_php_get_vhost_versions.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/LangPHP_php_get_vhost_versions.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'LangPHP',\n    'php_get_vhost_versions'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.52"}},"/Team/get_team_users_with_roles_count":{"get":{"description":"This function returns the current and maximum number of team users with roles.","operationId":"get_team_users_with_roles_count","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_team_users_with_roles_count","type":"string"},"module":{"description":"The name of the module called.","example":"Team","type":"string"},"result":{"properties":{"data":{"properties":{"max":{"description":"Maximum number of team users with roles.\n\n**Note:**\n\nThis value is stored in the package.","example":7,"type":"integer"},"used":{"description":"The current number of team users with roles.","example":2,"type":"integer"}}},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- `1` - Success.\n- `0` - Failed: Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Get number of team users with roles","tags":["Team Users"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Team \\\n  get_team_users_with_roles_count\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Team/get_team_users_with_roles_count"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account, where theme-name represents\n# jupiter.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Team_get_team_users_with_roles_count.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Team_get_team_users_with_roles_count.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Team/,\n    q/get_team_users_with_roles_count/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account, where theme-name represents\n// jupiter.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Team_get_team_users_with_roles_count.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Team_get_team_users_with_roles_count.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Team',\n    'get_team_users_with_roles_count'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}\n"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":118}},"/CCS/add_delegate":{"get":{"description":"This function delegates a user's calendar to another user.\n\n**Note:**\n\nYou **must** install the [Calendar and Contacts Server](https://go.cpanel.net/CalendarAndContactsServer) cPanel plugin to access this API function.","operationId":"add_delegate","parameters":[{"description":"The calendar's owner.","in":"query","name":"delegator","required":true,"schema":{"example":"delegator@cptest.test","format":"email","type":"string"}},{"description":"The user to whom you wish to delegate the calendar.","in":"query","name":"delegatee","required":true,"schema":{"example":"delegatee@cptest.test","format":"email","type":"string"}},{"description":"Whether the delegatee will only have read-only access on the calendar.\n* `1` - Read-only access.\n* `0` - Full access.","in":"query","name":"readonly","required":false,"schema":{"default":0,"enum":[1,0],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"add_delegate","type":"string"},"module":{"description":"The name of the module called.","example":"CCS","type":"string"},"result":{"properties":{"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` - Success.\n- `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add calendar delegation","tags":["CCS","Calendar and Contacts Server"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  CCS \\\n  add_delegate \\\n  delegator='delegator@cptest.test' \\\n  delegatee='delegatee@cptest.test'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/CCS/add_delegate?delegator=delegator%40cptest.test&delegatee=delegatee%40cptest.test"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file CCS_add_delegate.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/CCS_add_delegate.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/CCS/,\n    q/add_delegate/,\n    {\n        'delegator' => 'delegator@cptest.test',\n        'delegatee' => 'delegatee@cptest.test',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file CCS_add_delegate.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/CCS_add_delegate.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'CCS',\n    'add_delegate',\n    array (\n        'delegator' => 'delegator@cptest.test',\n        'delegatee' => 'delegatee@cptest.test',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 90","x-cpanel-minimum-compatible-version":80,"x-cpanel-rpm":"cpanel-ccs-calendarserver","x-cpanel-rpm-version":69}},"/Team/set_roles":{"get":{"description":"This function sets roles for a team user.\n\n**Note:**\n\n  This action may result in team users gaining access to team owner level privileges.","operationId":"set_roles","parameters":[{"description":"The username of the team user.","in":"query","name":"user","required":true,"schema":{"example":"teamuser","type":"string"}},{"description":"The role or roles to set for the team user. Current roles include admin, database, email, web.","in":"query","name":"role","required":false,"schema":{"example":"database","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_roles","type":"string"},"module":{"description":"The name of the module called.","example":"Team","type":"string"},"result":{"properties":{"data":{"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- `1` - Success\n- `0` - Failed: Check the errors field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Set roles for a team user","tags":["Team Users"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Team \\\n  set_roles \\\n  user='teamuser'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Team/set_roles?user=teamuser"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account, where theme-name represents\n# jupiter.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Team_set_roles.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Team_set_roles.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Team/,\n    q/set_roles/,\n    {\n        'user' => 'teamuser',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account, where theme-name represents\n// jupiter.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Team_set_roles.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Team_set_roles.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Team',\n    'set_roles',\n    array (\n        'user' => 'teamuser',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}\n"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":108}},"/BoxTrapper/set_blocklist":{"get":{"description":"This function sets the BoxTrapper blocklist configuration rules. BoxTrapper will delete messages that match these rules and send a notification to the sender.\n\n**Important:**\n\nWhen you disable the\n[*Receive Mail* role](https://go.cpanel.net/serverroles),\nthe system **disables** this function.","operationId":"BoxTrapper::set_blocklist","parameters":[{"description":"A valid email address on the cPanel account.\n\n**Warning:**\n\nIf you call this function in Webmail, the system overrides this parameter.\nThis parameter defaults to the current email address.","in":"query","name":"email","required":true,"schema":{"example":"user@example.com","format":"email","type":"string"}},{"description":"An array of blocklist rules.\n\n**Note:**\n\nYou can set multiple block rules, duplicate or increment the parameter name. For example,\n`rules-1`, `rules-2`, and `rules-3`.","examples":{"multiple":{"summary":"Set multiple rules.","value":"rules-1='blocklisted-email\\@domain\\.com' rules-2='from blocklisted-email2\\@domain\\.com' rules-3='to domain2\\.com'"},"multiple-alternative":{"summary":"Set multiple rules.","value":"rules='blocklisted-email\\@domain\\.com' rules='from blocklisted-email2\\@domain\\.com' rules='to domain2\\.com'"},"single":{"summary":"Set a single rule.","value":"blocklisted-email\\@domain\\.com"}},"in":"query","name":"rules","required":true,"schema":{"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_blocklist","type":"string"},"module":{"description":"The name of the module called.","example":"BoxTrapper","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update account BoxTrapper blocklist","tags":["BoxTrapper","Spam Prevention (BoxTrapper)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty --user=username BoxTrapper set_blocklist email='user@example.com' rules-1='blocklisted-email\\@domain\\.com' rules-2='from blocklisted-email2\\@domain\\.com' rules-3='to domain2\\.com'"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/BoxTrapper/set_blocklist?email=user%40example.com&rules=blocklisted-email%5c%40domain%5c.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file BoxTrapper_set_blocklist.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/BoxTrapper_set_blocklist.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/BoxTrapper/,\n    q/set_blocklist/,\n    {\n        'email' => 'user@example.com',\n        'rules' => 'blocklisted-email\\@domain\\.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file BoxTrapper_set_blocklist.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/BoxTrapper_set_blocklist.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'BoxTrapper',\n    'set_blocklist',\n    array (\n        'email' => 'user@example.com',\n        'rules' => 'blocklisted-email\\@domain\\.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 94"}},"/BoxTrapper/whitelist_messages":{"get":{"description":"This function whitelists email messages.\n\n**Important:**\n\nWhen you disable the [Receive Mail](https://go.cpanel.net/serverroles) role, the system **disables** this function.\n\n**Note:**\n\nTo retrieve email messages in the BoxTrapper queue from senders that you did not previously whitelist, use the UAPI `BoxTrapper::deliver_messages` function.","operationId":"whitelist_messages","parameters":[{"description":"The cPanel account email address for which to whitelist messages.\n\n**Warning**\n\nIf you call this function in Webmail, the system ignores this parameter and defaults to the currently-authenticated email address.","in":"query","name":"email","required":false,"schema":{"example":"user@example.com","format":"email","type":"string"}},{"description":"The filename of the email message to whitelist.\n\n**Note:**\n\nTo get a list of filenames in an account's BoxTrapper queue, use the UAPI `BoxTrapper::list_queued_messages` function.\n\n**Note:**\n\nTo whitelist multiple email messages, duplicate this parameter.","examples":{"multiple":{"summary":"Whitelist multiple messages.","value":"queuefile=ex1.msg&queuefile=ex2.msg&queuefile=ex3.msg"},"single":{"summary":"Whitelist a single message.","value":"example.msg"}},"in":"query","name":"queuefile","required":true,"schema":{"example":"example.msg","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"whitelist_messages","type":"string"},"module":{"description":"The name of the module called.","example":"BoxTrapper","type":"string"},"result":{"properties":{"data":{"description":"An array of one or more objects, depending on how many queuefiles were passed as parameters. Each object contains information about the whitelisted email message.","example":[{"email":"user@example.com","matches":["example.msg"],"operator":"whitelist"}],"items":{"properties":{"email":{"description":"A whitelisted email address.","example":"user@example.com","format":"email","type":"string"},"failed":{"default":"1","description":"The system failed to whitelist the message.\n\n* `1` — The function failed to whitelist the message. This is the only possible value.\n\n**Note:**\n\nThe function only returns this property if it failed to whitelist the message.","enum":["1"],"example":"1","type":"string"},"matches":{"description":"An array of message files that the system whitelisted.\n\n**Note:**\n\nThe function **only** returns this value if it whitelists the message.","items":{"example":"example.msg","type":"string"},"type":"array"},"operator":{"default":"whitelist","description":"The action that the system performed.","enum":["whitelist"],"example":"whitelist","type":"string"},"reason":{"description":"The reason the function skipped the message during whitelisting. The `reason` property is returned only if the function failed to whitelist the message.","example":"The cPanel user, \"user\" does not own the requested account \"user@example.com.\"","type":"string"},"warning":{"default":1,"description":"Whether the system experienced issues when it whitelisted the message.\n\n* `1` — There was an issue whitelisting the message. This is the only possible value.\n\n**Note:**\n\nThe function only returns this property if it failed to whitelist the message.","enum":[1],"example":1,"type":"integer"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add email address to BoxTrapper allowed senders","tags":["BoxTrapper","Spam Prevention (BoxTrapper)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  BoxTrapper \\\n  whitelist_messages \\\n  queuefile='example.msg'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/BoxTrapper/whitelist_messages?queuefile=example.msg"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file BoxTrapper_whitelist_messages.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/BoxTrapper_whitelist_messages.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/BoxTrapper/,\n    q/whitelist_messages/,\n    {\n        'queuefile' => 'example.msg',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file BoxTrapper_whitelist_messages.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/BoxTrapper_whitelist_messages.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'BoxTrapper',\n    'whitelist_messages',\n    array (\n        'queuefile' => 'example.msg',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/Mime/list_redirects":{"get":{"description":"This function lists the redirects in an account's .htaccess files.\n\n**Important:**\n\nWhen you disable the [Web Server role](https://go.cpanel.net/serverroles#roles), the system **disables** this function.","operationId":"list_redirects","parameters":[{"description":"A Perl regular expression that filters the results. The system matches the regular expression to the `sourceurl` return value.","in":"query","name":"regex","required":false,"schema":{"example":"\"^[a-z0-9_-]{6,18}$\"","type":"string"}},{"description":"The string with which to filter results.\n\n** Note: **\n\nThis will **only** return results that match the `destination` parameter **exactly**.","in":"query","name":"destination","required":false,"schema":{"example":"http://example.tld","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_redirects","type":"string"},"module":{"description":"The name of the module called.","example":"Mime","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"destination":{"description":"The redirect's destination URL.","example":"http://redirect.example.com/","format":"url","type":"string"},"displaydomain":{"description":"The domain to redirect.\n\n* `ALL` is the only possible value.","enum":["ALL"],"example":"ALL","type":"string"},"displaysourceurl":{"description":"The path to the file within the domain to test, relative to the home directory.","example":"/marceau.html","format":"url-path","type":"string"},"docroot":{"description":"The absolute file path to the source domain's document root.","example":"/home/example/public_html","format":"path","type":"string"},"domain":{"description":"The domain to redirect.","example":"example.com","format":"domain","type":"string"},"kind":{"description":"The kind of redirect.\n\n* `rewrite` — The request sent a redirect to another path on the server.\n* `redirect` — The request sent a redirect for the URL.\n* `redirectmatch` — The request sent a redirect based on a regular\nexpression match of the URL.","enum":["rewrite","redirect","redirectmatch"],"example":"rewrite","type":"string"},"matchwww":{"description":"Whether the redirect matches `www.` subdomains.\n* `1` — Matches.\n* `0` — Does not match.","enum":[1,0],"example":1,"type":"integer"},"matchwww_text":{"description":"Whether the [*Redirect with or without www.* option](https://go.cpanel.net/Redirects) is active.\n\n* `checked` — The *Redirect with or without www.* option is active.","enum":["checked"],"example":"checked","type":"string"},"opts":{"description":"The options that the function passes to Apache as part of\nthe [Rewrite rule](https://httpd.apache.org/docs/2.4/rewrite/flags.html#flag_l).","example":"L","type":"string"},"source":{"description":"The path to the file within the domain to test, relative to the home directory.","example":"/marceau.html","format":"url-path","type":"string"},"sourceurl":{"description":"The path to the file within the domain to test, relative to the home directory.","example":"/marceau.html","format":"url-path","type":"string"},"statuscode":{"description":"The [HTTP Status Code](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes) of the request","example":"301","type":"string"},"targeturl":{"description":"The redirect's destination URL.","example":"http://redirect.example.com/","format":"url","type":"string"},"type":{"description":"Whether the redirect is permanent or temporary.\n\n* `permanent` — The redirect is permanent.\n* `temporary` — The redirect is temporary.","enum":["permanent","temporary"],"example":"permanent","type":"string"},"urldomain":{"description":"The domain to redirect.","example":"example.com","format":"domain","type":"string"},"wildcard":{"description":"Whether the wildcard subdomains match.\n\n* `1` — Matches.\n* `0` — Does **not** match.","enum":[1,0],"example":1,"type":"integer"},"wildcard_text":{"description":"Whether the [*Wild Card Redirect*](https://go.cpanel.net/Redirects) option is active.\n\n* `checked` — The *Wild Card Redirect* option is active.","enum":["checked"],"example":"checked","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return .htaccess files' redirects","tags":["Mime","Domain Redirection"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Mime \\\n  list_redirects\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Mime/list_redirects"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Mime_list_redirects.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>\n#    to .../frontend/<theme-name>/api_examples/Mime_list_redirects.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Mime/,\n    q/list_redirects/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Mime_list_redirects.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>\n//    to .../frontend/<theme-name>/api_examples/Mime_list_redirects.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Mime',\n    'list_redirects'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Branding/get_information_for_applications":{"get":{"description":"This function retrieves an application's information from a specific\ntheme's `sitemap.json` file.","operationId":"get_information_for_applications","parameters":[{"description":"The absolute path to the directory containing the `sitemap.json` file.\nThis is the path to your theme's document root.","in":"query","name":"docroot","required":true,"schema":{"example":"/usr/local/cpanel/base/webmail/jupiter","format":"path","type":"string"}},{"description":"A comma-separated list of Appkey names. If you do **not**\nspecify this parameter, the output will include all of the applications that the\n`sitemap.json` file contains.\n\n**Note:**\n\nThis value **must** match an application's `key` value in the `sitemap.json` file.\nFor more information, read our\n[Guide to cPanel Interface Customization - Appkeys](https://go.cpanel.net/appkey)\ndocumentation.","in":"query","name":"app_keys","required":false,"schema":{"example":"email_filters","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_information_for_applications","type":"string"},"module":{"description":"The name of the module called.","example":"Branding","type":"string"},"result":{"properties":{"data":{"additionalProperties":{"description":"An object containing information about the queried `app_keys` application.\n\n**Note:**\n\nThe object's name is the value specified in the `app_keys` parameter.","properties":{"condition":{"description":"An object containing the application's conditions.","properties":{"feature":{"description":"The feature that the user must have access to in order to see the application in their cPanel *Home* interface.","example":"blockers","type":"string"},"if":{"description":"cPanel variables that determine whether to display the\nitem, if any exist.\n\nFor example, `$isreseller` indicates that the item **only**\ndisplays for reseller accounts.\n\nFor more information, read our\n[Guide to cPanel Variables](https://go.cpanel.net/guidetovariables)\ndocumentation.","example":"!$isarchiveuser","type":"string"},"module":{"description":"The name of the module that provides the application.","type":"string"}},"type":"object"},"description":{"description":"The application's display name.","example":"Email Filters","type":"string"},"icon":{"description":"The application's icon information.","properties":{"height":{"description":"The application's icon's height, in pixels.","example":32,"minimum":1,"type":"integer"},"url":{"description":"The file path or URL location of the application's icon.","example":"email_filters","format":"url-path","type":"string"},"width":{"description":"The application's icon's width, in pixels.","example":35,"minimum":1,"type":"integer"}},"type":"object"},"implements":{"description":"The module namespace for the specific application.","example":"Email_UserLevelFiltering","type":"string"},"key":{"description":"The application's Appkey name.","example":"email_filters","type":"string"},"name":{"description":"The application's name.","example":"Email Filters","type":"string"},"order":{"description":"The application's order in the `sitemap.json` file. This value represents the application's display order in cPanel's *Home* interface.","example":4,"minimum":1,"type":"integer"},"terms":{"description":"Search keywords for the application.","example":["email","filter","filters"],"items":{"type":"string"}},"type":{"description":"The application's type.\n\n`item` is the only possible value.","enum":["item"],"example":"item","type":"string"},"url":{"description":"The file path or URL to the the application's file.","example":"mail/filters/userfilters.html","format":"url-path","type":"string"}},"type":"object"},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return app's info from sitemap.json","tags":["Branding","Application Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Branding \\\n  get_information_for_applications \\\n  docroot='/usr/local/cpanel/base/webmail/jupiter'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Branding/get_information_for_applications?docroot=%2fusr%2flocal%2fcpanel%2fbase%2fwebmail%2fpaper_lantern"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Branding_get_information_for_applications.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Branding_get_information_for_applications.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Branding/,\n    q/get_information_for_applications/,\n    {\n        'docroot' => '/usr/local/cpanel/base/webmail/jupiter',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Branding_get_information_for_applications.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Branding_get_information_for_applications.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Branding',\n    'get_information_for_applications',\n    array (\n        'docroot' => '/usr/local/cpanel/base/webmail/jupiter',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.52"}},"/DAV/is_horde_enabled":{"get":{"description":"This function checks whether Horde is enabled. Since Horde is no longer installed with the product, the return value will only ever be 0.","operationId":"is_horde_enabled","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"is_horde_enabled","type":"string"},"module":{"description":"The name of the module called.","example":"DAV","type":"string"},"result":{"properties":{"data":{"properties":{"enabled":{"description":"Whether Horde is enabled. Always false because horde is no longer installed with the product.\n* `0` — Disabled.","enum":[0],"example":0,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` — Success.\n- `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return whether Horde is enabled","tags":["DAV","Calendar and Contacts (DAV)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  DAV \\\n  is_horde_enabled\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/DAV/is_horde_enabled"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file DAV_is_horde_enabled.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/DAV_is_horde_enabled.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/DAV/,\n    q/is_horde_enabled/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file DAV_is_horde_enabled.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/DAV_is_horde_enabled.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'DAV',\n    'is_horde_enabled'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.50"}},"/CPDAVD/add_delegate":{"get":{"description":"This function adds a share for the specified calendar.","operationId":"CPDAVD_add_delegate","parameters":[{"description":"The owner of the calendar, who wishes to share it to another user.","in":"query","name":"delegator","required":true,"schema":{"example":"first@example.com","type":"string"}},{"description":"The person to whom you will share the calendar.","in":"query","name":"delegatee","required":true,"schema":{"example":"second@example.com","type":"string"}},{"description":"The calendar to share.","in":"query","name":"calendar","required":true,"schema":{"example":"calendar","type":"string"}},{"description":"If set, the provided access will be read-only.","in":"query","name":"readonly","required":false,"schema":{"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"add_delegate","type":"string"},"module":{"description":"The name of the module called.","example":"CPDAVD","type":"string"},"result":{"properties":{"data":{"properties":{"shared":{"description":"Whether the sharing succeeded.\n* `1` — Shared.\n* `0` — **Not** shared.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` — Success.\n- `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Share a calendar","tags":["DAV","Calendar and Contacts (DAV)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  CPDAVD \\\n  add_delegate \\\n  delegator='first@example.com' \\\n  delegatee='second@example.com' \\\n  calendar='calendar'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/CPDAVD/add_delegate?delegator=first%40example.com&delegatee=second%40example.com&calendar=calendar"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account, where theme-name represents\n# jupiter.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file CPDAVD_add_delegate.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/CPDAVD_add_delegate.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/CPDAVD/,\n    q/add_delegate/,\n    {\n        'delegator' => 'first@example.com',\n        'delegatee' => 'second@example.com',\n        'calendar' => 'calendar',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account, where theme-name represents\n// jupiter.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file CPDAVD_add_delegate.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/CPDAVD_add_delegate.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'CPDAVD',\n    'add_delegate',\n    array (\n        'delegator' => 'first@example.com',\n        'delegatee' => 'second@example.com',\n        'calendar' => 'calendar',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}\n"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 120"}},"/Team/remove_team_user":{"get":{"description":"This function removes a team user.","operationId":"remove_team_user","parameters":[{"description":"The username of the team user.","in":"query","name":"user","required":true,"schema":{"example":"teamuser","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"remove_team_user","type":"string"},"module":{"description":"The name of the module called.","example":"Team","type":"string"},"result":{"properties":{"data":{"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove a team user","tags":["Team Users"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Team \\\n  remove_team_user \\\n  user='teamuser'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Team/remove_team_user?user=teamuser"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Team_remove_team_user.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Team_remove_team_user.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Team/,\n    q/remove_team_user/,\n    {\n        'user' => 'teamuser',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Team_remove_team_user.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Team_remove_team_user.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Team',\n    'remove_team_user',\n    array (\n        'user' => 'teamuser',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":108}},"/CPDAVD/list_delegates":{"get":{"description":"This function lists the sharing configuration in calendars for this account.","operationId":"CPDAVD_list_delegates","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_delegates","type":"string"},"module":{"description":"The name of the module called.","example":"CPDAVD","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"calendar":{"description":"The calendar id.","example":"calendar","type":"string"},"calname":{"description":"The name of the calendar.","example":"cPanel CalDAV Calendar","type":"string"},"delegatee":{"description":"The person to whom the owner of the calendar shared it.","example":"second@example.com","type":"string"},"delegator":{"description":"The owner of the calendar.","example":"first@example.com","type":"string"},"readonly":{"description":"If set to `1`, the `delegatee` only has read access to the calendar.","enum":[0,1],"example":0,"type":"integer"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` — Success.\n- `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"List calendar sharing.","tags":["DAV","Calendar and Contacts (DAV)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  CPDAVD \\\n  list_delegates\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/CPDAVD/list_delegates"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account, where theme-name represents\n# jupiter.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file CPDAVD_list_delegates.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/CPDAVD_list_delegates.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/CPDAVD/,\n    q/list_delegates/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account, where theme-name represents\n// jupiter.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file CPDAVD_list_delegates.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/CPDAVD_list_delegates.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'CPDAVD',\n    'list_delegates'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}\n"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 120"}},"/CPDAVD/list_users":{"get":{"description":"This function lists the users that are available for use with CalDAV and CardDAV","operationId":"CPDAVD_list_users","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_users","type":"string"},"module":{"description":"The name of the module called.","example":"CPDAVD","type":"string"},"result":{"properties":{"data":{"items":{"additionalProperties":{"additionalProperties":{"description":"The name of this property is the collection id.","properties":{"calendar-color":{"description":"For calendars only: The color to use for calendar events.","example":"#ee5555","type":"string"},"description":{"description":"The description of the collection.","type":"string"},"displayname":{"description":"The name of the collection.","type":"string"},"protected":{"description":"If this value is `1`, then the collection cannot be deleted through the API.","enum":[0,1],"example":1,"type":"integer"},"type":{"description":"The type of the collection.","enum":["VADDRESSBOOK","VCALENDAR","VTODO"],"example":"VCALENDAR","type":"string"}},"type":"object"},"description":"The name of this property is the principal name.","type":"object"},"example":{"someone@example.com":{"addressbook":{"description":"Default Address Book automatically created for your account.","displayname":"cPanel CardDAV Address Book","protected":1,"type":"VADDRESSBOOK"},"calendar":{"calendar-color":"#ff6c2c","description":"Default Calendar automatically created for your account.","displayname":"cPanel CalDAV Calendar","protected":1,"type":"VCALENDAR"}}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` — Success.\n- `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update calendar sharing","tags":["DAV","Calendar and Contacts (DAV)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  CPDAVD \\\n  list_users\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/CPDAVD/list_users"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account, where theme-name represents\n# jupiter.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file CPDAVD_list_users.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/CPDAVD_list_users.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/CPDAVD/,\n    q/list_users/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account, where theme-name represents\n// jupiter.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file CPDAVD_list_users.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/CPDAVD_list_users.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'CPDAVD',\n    'list_users'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}\n"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 120"}},"/CPDAVD/manage_collection":{"get":{"description":"This function creates, updates, or deletes a collection.","operationId":"CPDAVD_manage_collection","parameters":[{"description":"The owner of the calendar.","in":"query","name":"account","required":true,"schema":{"example":"user@example.com","type":"string"}},{"description":"The action to perform (create, update, or delete a collection).","in":"query","name":"action","required":true,"schema":{"enum":["create","update","delete"],"example":"delete","type":"string"}},{"description":"The path to the collection.","in":"query","name":"path","required":true,"schema":{"example":"/calendars/user@example.com/mycalendar","type":"string"}},{"description":"The collection type.","in":"query","name":"collection_type","required":true,"schema":{"enum":["calendar","tasks","addressbook"],"example":"calendar","type":"string"}},{"description":"The name of the collection. Required when creating a collection.","in":"query","name":"name","schema":{"example":"My Calendar","type":"string"}},{"description":"The description of the collection.","in":"query","name":"description","schema":{"example":"This is my calendar.","type":"string"}},{"description":"The color of the calendar, if applicable.","in":"query","name":"calendar-color","required":false,"schema":{"example":"#ee5555","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"manage_collection","type":"string"},"module":{"description":"The name of the module called.","example":"CPDAVD","type":"string"},"result":{"properties":{"data":{"properties":{"shared":{"description":"Whether the operation succeeded.\n* `1` — Operation succeeded.\n* `0` — Operation did **not** succeed.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` — Success.\n- `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Perform an operation on a calendar, task list or address book.","tags":["DAV","Calendar and Contacts (DAV)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  CPDAVD \\\n  manage_collection \\\n  account='user@example.com' \\\n  action='delete' \\\n  path='/calendars/user@example.com/mycalendar' \\\n  collection_type='calendar'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/CPDAVD/manage_collection?account=user%40example.com&action=delete&path=%2fcalendars%2fuser%40example.com%2fmycalendar&collection_type=calendar"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account, where theme-name represents\n# jupiter.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file CPDAVD_manage_collection.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/CPDAVD_manage_collection.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/CPDAVD/,\n    q/manage_collection/,\n    {\n        'account' => 'user@example.com',\n        'action' => 'delete',\n        'path' => '/calendars/user@example.com/mycalendar',\n        'collection_type' => 'calendar',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account, where theme-name represents\n// jupiter.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file CPDAVD_manage_collection.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/CPDAVD_manage_collection.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'CPDAVD',\n    'manage_collection',\n    array (\n        'account' => 'user@example.com',\n        'action' => 'delete',\n        'path' => '/calendars/user@example.com/mycalendar',\n        'collection_type' => 'calendar',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}\n"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 120"}},"/CPDAVD/remove_delegate":{"get":{"description":"This function removes a share for the specified calendar.","operationId":"CPDAVD_remove_delegate","parameters":[{"description":"The owner of the calendar, who wishes to remove the sharing.","in":"query","name":"delegator","required":true,"schema":{"example":"first@example.com","type":"string"}},{"description":"The person to whom the calendar was shared.","in":"query","name":"delegatee","required":true,"schema":{"example":"second@example.com","type":"string"}},{"description":"The calendar that was shared.","in":"query","name":"calendar","required":true,"schema":{"example":"calendar","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"remove_delegate","type":"string"},"module":{"description":"The name of the module called.","example":"CPDAVD","type":"string"},"result":{"properties":{"data":{"properties":{"shared":{"description":"Whether the sharing removal succeeded.\n* `1` — Removed.\n* `0` — **Not** removed.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` — Success.\n- `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove a share.","tags":["DAV","Calendar and Contacts (DAV)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  CPDAVD \\\n  remove_delegate \\\n  delegator='first@example.com' \\\n  delegatee='second@example.com' \\\n  calendar='calendar'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/CPDAVD/remove_delegate?delegator=first%40example.com&delegatee=second%40example.com&calendar=calendar"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account, where theme-name represents\n# jupiter.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file CPDAVD_remove_delegate.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/CPDAVD_remove_delegate.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/CPDAVD/,\n    q/remove_delegate/,\n    {\n        'delegator' => 'first@example.com',\n        'delegatee' => 'second@example.com',\n        'calendar' => 'calendar',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account, where theme-name represents\n// jupiter.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file CPDAVD_remove_delegate.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/CPDAVD_remove_delegate.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'CPDAVD',\n    'remove_delegate',\n    array (\n        'delegator' => 'first@example.com',\n        'delegatee' => 'second@example.com',\n        'calendar' => 'calendar',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}\n"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 120"}},"/CPDAVD/update_delegate":{"get":{"description":"This function updates a share for the specified calendar.","operationId":"CPDAVD_update_delegate","parameters":[{"description":"The owner of the calendar, who wishes to change the details of the sharing.","in":"query","name":"delegator","required":true,"schema":{"example":"first@example.com","type":"string"}},{"description":"The person to whom you will share the calendar.","in":"query","name":"delegatee","required":true,"schema":{"example":"second@example.com","type":"string"}},{"description":"The calendar to share.","in":"query","name":"calendar","required":true,"schema":{"example":"calendar","type":"string"}},{"description":"If set, the provided access will be read-only.","in":"query","name":"readonly","required":false,"schema":{"enum":[0,1],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"update_delegate","type":"string"},"module":{"description":"The name of the module called.","example":"CPDAVD","type":"string"},"result":{"properties":{"data":{"properties":{"shared":{"description":"Whether the sharing succeeded.\n* `1` — Shared.\n* `0` — **Not** shared.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` — Success.\n- `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update calendar sharing.","tags":["DAV","Calendar and Contacts (DAV)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  CPDAVD \\\n  update_delegate \\\n  delegator='first@example.com' \\\n  delegatee='second@example.com' \\\n  calendar='calendar'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/CPDAVD/update_delegate?delegator=first%40example.com&delegatee=second%40example.com&calendar=calendar"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account, where theme-name represents\n# jupiter.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file CPDAVD_update_delegate.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/CPDAVD_update_delegate.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/CPDAVD/,\n    q/update_delegate/,\n    {\n        'delegator' => 'first@example.com',\n        'delegatee' => 'second@example.com',\n        'calendar' => 'calendar',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account, where theme-name represents\n// jupiter.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file CPDAVD_update_delegate.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/CPDAVD_update_delegate.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'CPDAVD',\n    'update_delegate',\n    array (\n        'delegator' => 'first@example.com',\n        'delegatee' => 'second@example.com',\n        'calendar' => 'calendar',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}\n"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 120"}},"/AccountEnhancements/list":{"get":{"description":"This function lists a cPanel account's [Account Enhancements](https://go.cpanel.net/account-enhancements).","operationId":"AccountEnhancements-list","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list","type":"string"},"module":{"description":"The name of the module called.","example":"AccountEnhancements","type":"string"},"result":{"properties":{"data":{"description":"An object that contains the Account Enhancements that the cPanel account can access","items":{"properties":{"id":{"description":"The Account Enhancement's id.","example":"sample-enhancement-id","type":"string","items":{"type":"string"}},"name":{"description":"The Account Enhancement's name.","example":"Sample Enhancement","type":"string","items":{"type":"string"}}}}},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return all cPanel account's Account Enhancements","tags":["Account Enhancements"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  AccountEnhancements \\\n  list\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/AccountEnhancements/list"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file AccountEnhancements_list.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/AccountEnhancements_list.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/AccountEnhancements/,\n    q/list/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file AccountEnhancements_list.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/AccountEnhancements_list.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'AccountEnhancements',\n    'list'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 98"}},"/AccountEnhancements/has_enhancement":{"get":{"description":"This function returns whether a cPanel account has a specific [Account Enhancement](https://go.cpanel.net/account-enhancements).","operationId":"AccountEnhancements-has-enhancement","parameters":[{"in":"query","name":"id","description":"The identifier for a specific Account Enhancement.\n\n**Note:**\n\nTo retrieve a list of all Account Enhancements IDs on the server, run the WHM API 1 `list_account_enhancements` function.","required":true,"schema":{"type":"string","example":"sample-enhancement-id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list","type":"string"},"module":{"description":"The name of the module called.","example":"AccountEnhancements","type":"string"},"result":{"properties":{"data":{"description":"* `1` - The Account Enhancement is assigned to the cPanel account.\n* `0` - The Account Enhancement is not assigned to the cPanel account.","enum":[1,0],"example":1,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `reason` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Validate Account Enhancement assignment","tags":["Account Enhancements"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  AccountEnhancements \\\n  has_enhancement \\\n  id=account_enhancement\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/AccountEnhancements/has_enhancement?id=account_enhancement"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file AccountEnhancements_has_enhancement.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/AccountEnhancements_has_enhancement.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/AccountEnhancements/,\n    q/has_enhancement/,\n    q/id=account_enhancement/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file AccountEnhancements_has_enhancement.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/AccountEnhancements_has_enhancement.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'AccountEnhancements',\n    'has_enhancement',\n    array('id' => 'sample_enhancement')\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 98"}},"/Backup/fullbackup_to_ftp":{"get":{"description":"This function creates a full backup to the remote server via File Transfer Protocol (FTP). The system creates a file in the `backup-MM.DD.YYYY_HH-mm-ss.tar.gz` filename format.","operationId":"fullbackup_to_ftp","parameters":[{"description":"Whether to use the `active` or `passive` FTP variant to connect to\nthe remote server. For more information about FTP variants, read our How\nto [Enable FTP Passive Mode](https://go.cpanel.net/HowtoEnableFTPPassiveMode) documentation.\n* `active` — The FTP server responds to the connection attempt and returns a connection request from a different port to the FTP client.\n* `passive` — The FTP client initiates connection attempts.","in":"query","name":"variant","required":false,"schema":{"default":"active","enum":["active","passive"],"example":"active","type":"string"}},{"description":"The remote server account's username.","in":"query","name":"username","required":true,"schema":{"example":"username","type":"string"}},{"description":"The remote server account's password.","in":"query","name":"password","required":true,"schema":{"example":"luggage123456","type":"string"}},{"description":"The remote server's hostname or IP address.","in":"query","name":"host","required":true,"schema":{"example":"example.com","oneOf":[{"description":"A valid hostname.","format":"hostname","type":"string"},{"description":"A valid IP address.","format":"ipv4","type":"string"}],"type":"string"}},{"description":"The directory on the remote server that will store the backup.\n\n**Note:**\n\n* This value defaults to the remote server account's default login directory.\n* Enter the directory relative to the FTP user's login directory. For example, enter `/public_ftp` not `/home/username/public_ftp`.","in":"query","name":"directory","required":false,"schema":{"example":"/public_ftp","type":"string"}},{"description":"The port number to use during the transfer.","in":"query","name":"port","required":false,"schema":{"default":21,"example":21,"maximum":65535,"minimum":1,"type":"integer"}},{"description":"How to manage the home directory in the backup.\n\n* `include` — Include the home directory in the backup.\n* `skip` — Omit the home directory from the backup.","in":"query","name":"homedir","required":false,"schema":{"default":"include","enum":["include","skip"],"example":"include","type":"string"}},{"description":"The email address to receive a confirmation email when the backup completes.\n\n**Note:**\n\n The system does **not** provide confirmation if you do **not** pass this parameter.","in":"query","name":"email","required":false,"schema":{"default":null,"example":"username@example.com","format":"email","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"fullbackup_to_ftp","type":"string"},"module":{"description":"The name of the module called.","example":"Backup","type":"string"},"result":{"properties":{"data":{"properties":{"pid":{"description":"The backup's process identifier.","example":"2857","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Back up cPanel account via FTP","tags":["Backup"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Backup \\\n  fullbackup_to_ftp \\\n  username='username' \\\n  password='luggage123456' \\\n  host='example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Backup/fullbackup_to_ftp?username=username&password=luggage123456&host=example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Backup_fullbackup_to_ftp.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Backup_fullbackup_to_ftp.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Backup/,\n    q/fullbackup_to_ftp/,\n    {\n        'username' => 'username',\n        'password' => 'luggage123456',\n        'host' => 'example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Backup_fullbackup_to_ftp.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Backup_fullbackup_to_ftp.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Backup',\n    'fullbackup_to_ftp',\n    array (\n        'username' => 'username',\n        'password' => 'luggage123456',\n        'host' => 'example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 78"}},"/Backup/fullbackup_to_homedir":{"get":{"description":"This function creates a full backup to the user's home directory. The system creates a file in the `backup-MM.DD.YYYY_HH-mm-ss_username.tar.gz` filename format.","operationId":"fullbackup_to_homedir","parameters":[{"description":"The email address to receive a confirmation email when the backup process completes.\n\n**Note:**\n\nThe system does **not** provide confirmation if you do not pass this parameter.","in":"query","name":"email","required":false,"schema":{"default":null,"example":"username@example.com","format":"email","type":"string"}},{"description":"How to manage the home directory in the backup.\n\n* `include` — Include the home directory in the backup.\n* `skip` — Omit the home directory from the backup.","in":"query","name":"homedir","required":false,"schema":{"default":"include","enum":["include","skip"],"example":"include","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"fullbackup_to_homedir","type":"string"},"module":{"description":"The name of the module called.","example":"Backup","type":"string"},"result":{"properties":{"data":{"properties":{"pid":{"description":"The backup's process identifier.","example":"2857","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Back up cPanel account to home directory","tags":["Backup"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Backup \\\n  fullbackup_to_homedir\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Backup/fullbackup_to_homedir"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Backup_fullbackup_to_homedir.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Backup_fullbackup_to_homedir.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Backup/,\n    q/fullbackup_to_homedir/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Backup_fullbackup_to_homedir.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Backup_fullbackup_to_homedir.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Backup',\n    'fullbackup_to_homedir'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 78"}},"/Branding/get_application_information":{"get":{"description":"This function retrieves an application's information from the `dynamicui.conf` file.","operationId":"get_application_information","parameters":[{"description":"The application's feature name. This value **must** match a feature's `app_key` value. For a list of app_key values, read our [Guide to cPanel Interface Customization - Appkeys](https://go.cpanel.net/appkey) documentation.","in":"query","name":"app_key","required":true,"schema":{"example":"boxtrapper","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_application_information","type":"string"},"module":{"description":"The name of the module called.","example":"Branding","type":"string"},"result":{"properties":{"data":{"properties":{"feature":{"description":"The application's feature name. The `app_key` parameter's value.","example":"boxtrapper","type":"string"},"file":{"description":"The application's icon's filename.","example":"boxtrapper","type":"string"},"group":{"description":"The application's group.","example":"mail","type":"string"},"height":{"description":"The application's icon's height, in pixels.","example":32,"minimum":1,"type":"integer"},"if":{"description":"Conditional arguments that determine whether to display the item, if any exist. Conditional arguments that determine whether to display the item. For example, $isreseller indicates that the item only displays for reseller accounts. For more information, read our Guide to cPanel Variables documentation.","example":"$hasboxtrapper","type":"string"},"imgtype":{"description":"The item's image type.\n `icon` is the only possible value.","enum":["icon"],"example":"icon","type":"string"},"itemdesc":{"description":"The application's display name.","example":"BoxTrapper","type":"string"},"itemorder":{"description":"The application's order in the `dynamicui.conf` file representing the application's display order in cPanel's Home interface. For example, the first item on the cPanel Home interface has an `itemorder` value of `1`.","example":3,"minimum":1,"type":"integer"},"module":{"description":"The application's module. A valid module name.","example":"BoxTrapper","type":"string"},"searchtext":{"description":"One or more search terms. The application's icon will display when users enter these search terms in the Quick Find text box. A space-separated list of search terms.","example":"boxtrapper","type":"string"},"subtype":{"description":"The item's subtype.\n `img` is the only possible value .","enum":["img"],"example":"img","type":"string"},"type":{"description":"The application's type.\n `image` is the only possible value.","enum":["image"],"example":"image","type":"string"},"url":{"description":"The location to which the application's icon links. A valid filepath or URL.","example":"mail/boxtrapper.html","type":"string"},"width":{"description":"The application's icon's width representing an image width, in pixels.","example":35,"minimum":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success.\n- 0 - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return single app's info from dynamicui.conf","tags":["Branding","Application Information"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Branding \\\n  get_application_information \\\n  app_key='boxtrapper'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Branding/get_application_information?app_key=boxtrapper"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Branding_get_application_information.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Branding_get_application_information.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Branding/,\n    q/get_application_information/,\n    {\n        'app_key' => 'boxtrapper',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Branding_get_application_information.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Branding_get_application_information.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Branding',\n    'get_application_information',\n    array (\n        'app_key' => 'boxtrapper',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Backup/restore_email_filters":{"post":{"description":"This function restores an account's email filters.\n\n**Important:**\n\nWhen the [Receive Mail role](https://go.cpanel.net/howtouseserverprofiles#roles) is disabled, the system also **disables** this function.\n\n**Note:**\n\nYou **must** use the `backup` parameter when you call this function in one of the following formats:\n* As part of a `multipart/form-data` request body to upload and restore a backup file to the server.\n* As a query parameter to restore an existing file on the server.","operationId":"restore_email_filters","parameters":[{"description":"The email filter file to restore.\n\n**Important:**\n\n**Only** pass this parameter to restore email filter files that already exist on the server.\n\n**Note:**\n\nTo restore multiple email filter files, increment the parameter name. For example: `backup-1`, `backup-2`, and `backup-3`.","examples":{"multiple":{"summary":"Restore multiple email filter files.","value":"backup-1=/home/user/filter_info1.username.yaml.gz backup-2=/home/user/filter_info2.username.yaml.gz backup-3=/home/user/filter_info3.username.yaml.gz"},"single":{"summary":"Restore a single email filter file.","value":"/home/user/filter_info.username.yaml.gz"}},"in":"query","name":"backup","required":false,"schema":{"type":"string"}},{"description":"Whether to return additional information from the `/home/cpuser/.cpanel/logs/restore-email-filters` log files.\n* `1` - Return additional information.\n* `0` - Do not return additional information.","in":"query","name":"verbose","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"The maximum number of seconds to try to restore the file.\n* `0` - The system will not time out the file restoration.","in":"query","name":"timeout","required":false,"schema":{"default":7200,"example":3600,"minimum":0,"type":"integer"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"backup":{"format":"binary","type":"string"}},"type":"object"}}},"description":"The email filter file to upload and restore.\n\n**Important:**\n\n* **Only** pass this parameter to upload files that don't already exist on the server.\n* You can't pass this parameter on the command line.\n\n**Note:**\n\n* To upload multiple email filter files, increment the parameter name. For example: `backup-1`, `backup-2`, and `backup-3`.\n* Pass this file in a multipart/form-data structure.\n* For more information about this structure, read Mozilla's [POST Method](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST) documentation."},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"restore_email_filters","type":"string"},"module":{"description":"The name of the module called.","example":"Backup","type":"string"},"result":{"properties":{"data":{"properties":{"log_id":{"description":"The log file's restoration identification (ID). The system uses the backup restoration's date to create this ID. The ID is in [ISO-8601 Date Time](https://en.wikipedia.org/wiki/ISO_8601) format with the log's revision number appended.","example":"2019-08-13T15:10:07Z.1","type":"string"},"log_path":{"description":"The filepath to the backup restoration's log file.","example":"/home/cpuser/.cpanel/logs/restore-email-filters/2019-09-11T18:30:49Z.1.log","format":"path","type":"string"},"messages":{"description":"An array of statements about the database's restoration.","items":{"example":"The system successfully restored the email filters from the 'filter-info.user.yaml.gz' backup.","type":"string"},"type":"array"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Restore email filters","tags":["File Restoration"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --input=json --output=jsonpretty \\\n  --user=username \\\n  Backup \\\n  restore_email_filters\n"},{"label":"HTTP Request (Wire Format)","lang":"HTTP","source":"POST /cpsess##########/execute/Backup/restore_email_filters HTTP/1.1\nHost: example.com:2083\nCookie: ###################################\nContent-Type: application/json\nContent-Length: 0\n\n"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 86"}},"/Backup/fullbackup_to_scp_with_key":{"get":{"description":"This function creates a full backup to a remote server with a private SSH key via the secure copy protocol (scp) command. The system creates a file in the `backup-MM.DD.YYYY_HH-mm-ss_username.tar.gz` filename format.","operationId":"fullbackup_to_scp_with_key","parameters":[{"description":"The remote server's hostname or IP address.","in":"query","name":"host","required":true,"schema":{"example":"example.com","oneOf":[{"description":"A valid hostname.","format":"hostname","type":"string"},{"description":"A valid IP address.","format":"ipv4","type":"string"}],"type":"string"}},{"description":"The port to use during the transfer.","in":"query","name":"port","required":false,"schema":{"default":22,"example":22,"maximum":65335,"minimum":1,"type":"integer"}},{"description":"How to manage the home directory in the backup.\n\n* `include` — Include the home directory in the backup.\n* `skip` — Omit the home directory from the backup.","in":"query","name":"homedir","required":false,"schema":{"default":"include","enum":["include","skip"],"example":"include","type":"string"}},{"description":"The SSH key's name.\n\n**Notes:**\n\n* To generate a private SSH key, use the UAPI `SSL::generate_key`\nfunction.\n* To import an existing SSH key, use the cPanel API 2\n`SSH::importkey` function.","in":"query","name":"key_name","required":true,"schema":{"example":"examplesshkey","type":"string"}},{"description":"The SSH key's password.","in":"query","name":"key_passphrase","required":true,"schema":{"example":"123456luggage","minLength":4,"type":"string"}},{"description":"The directory on the remote server that will store the backup.\n\n**Note:**\n\nThis parameter defaults to the remote server account's default login directory.","in":"query","name":"directory","required":false,"schema":{"example":"/user","type":"string"}},{"description":"The email address to receive a confirmation email when the backup completes.\n\n**Note:**\n\nThe system does **not** provide confirmation if you do not pass this parameter.","in":"query","name":"email","required":false,"schema":{"default":null,"example":"username@example.com","format":"email","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"fullbackup_to_scp_with_key","type":"string"},"module":{"description":"The name of the module called.","example":"Backup","type":"string"},"result":{"properties":{"data":{"properties":{"pid":{"description":"The backup's process identifier.","example":"2857","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` — Success.\n* `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Back up cPanel account via SCP with SSH key","tags":["Backup"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Backup \\\n  fullbackup_to_scp_with_key \\\n  host='example.com' \\\n  key_name='examplesshkey' \\\n  key_passphrase='123456luggage'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Backup/fullbackup_to_scp_with_key?host=example.com&key_name=examplesshkey&key_passphrase=123456luggage"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Backup_fullbackup_to_scp_with_key.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Backup_fullbackup_to_scp_with_key.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Backup/,\n    q/fullbackup_to_scp_with_key/,\n    {\n        'host' => 'example.com',\n        'key_name' => 'examplesshkey',\n        'key_passphrase' => '123456luggage',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Backup_fullbackup_to_scp_with_key.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Backup_fullbackup_to_scp_with_key.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Backup',\n    'fullbackup_to_scp_with_key',\n    array (\n        'host' => 'example.com',\n        'key_name' => 'examplesshkey',\n        'key_passphrase' => '123456luggage',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 78"}},"/Backup/restore_files":{"post":{"description":"This function restores an account's files.\n\n**Important:**\n\nWhen the [File Storage role](https://go.cpanel.net/howtouseserverprofiles#roles) is disabled, the system also **disables** this function.\n\n**Note:**\n\nYou **must** use the `backup` parameter when you call this function in one of the following formats:\n* As part of a `multipart/form-data` request body to upload and restore a backup file to the server. For more information about this structure, read Mozilla's [POST Method](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST) documentation.\n* As a query parameter to restore an existing file on the server.","operationId":"restore_files","parameters":[{"description":"The backup file to restore.\n\n**Important:**\n\n**Only** pass this parameter to restore backup files that already exist on the server.\n\n**Note:**\n\nTo restore multiple backup files, increment the parameter name. For example: `backup-1`, `backup-2`, and `backup-3`.","examples":{"multiple":{"summary":"Restore multiple backup files.","value":"backup-1=/home/cpuser/backup-cpuser.tld-9-10-2019_1.tar.gz backup-2=/home/cpuser/backup-cpuser.tld-9-10-2019_2.tar.gz"},"single":{"summary":"Restore a single backup file.","value":"/home/cpuser/backup-cpuser.tld-9-10-2019_1.tar.gz"}},"in":"query","name":"backup","required":false,"schema":{"type":"string"}},{"description":"Whether to return additional information from the `/home/cptest/.cpanel/logs/restorefiles` log files.\n* `1` - Return additional information.\n* `0` - Do not return additional information.","in":"query","name":"verbose","required":false,"schema":{"default":0,"enum":[0,1],"example":1,"type":"integer"}},{"description":"The directory to which to restore the file. The default is the user's `home` directory.","in":"query","name":"directory","required":false,"schema":{"example":"/home/user/example","format":"path","type":"string"}},{"description":"The maximum number of seconds to try to restore the file.\n* `0` - The system will not time out the file restoration.","in":"query","name":"timeout","required":false,"schema":{"default":172800,"example":7200,"minimum":0,"type":"integer"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"backup":{"format":"binary","type":"string"}},"type":"object"}}},"description":"The backup file to upload and restore.\n\n**Important:**\n\n* **Only** pass this parameter to upload files that don't already exist on the server.\n* You can't pass this parameter on the command line.\n\n**Note:**\n\nTo upload and restore multiple backup files, increment the parameter name. For example: `backup-1`, `backup-2`, and `backup-3`."},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"restore_files","type":"string"},"module":{"description":"The name of the module called.","example":"Backup","type":"string"},"result":{"properties":{"data":{"properties":{"log_id":{"description":"The log file's restoration identification (ID). The system uses the backup restoration's date to create this ID. The ID is in [ISO-8601 Date Time](https://en.wikipedia.org/wiki/ISO_8601) format with the log's revision number appended.","example":"2019-08-13T15:10:07Z.1","type":"string"},"log_path":{"description":"The filepath to the backup restoration's log file.","example":"/home/cptest/.cpanel/logs/restorefiles/2019-08-13T15:10:07Z.1.log","format":"path","type":"string"},"messages":{"description":"An array of statements about the database's restoration.","items":{"example":"The system successfully restored the directory /home/cpuser/point2 from the backup file backup-cpuser.tld-9-10-2019_1.tar.gz","type":"string"},"type":"array"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Restore files","tags":["File Restoration"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --input=json --output=jsonpretty \\\n  --user=username \\\n  Backup \\\n  restore_files\n"},{"label":"HTTP Request (Wire Format)","lang":"HTTP","source":"POST /cpsess##########/execute/Backup/restore_files HTTP/1.1\nHost: example.com:2083\nCookie: ###################################\nContent-Type: application/json\nContent-Length: 0\n\n"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 86"}},"/Backup/list_backups":{"get":{"description":"This function lists the account's backup files.","operationId":"list_backups","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_backups","type":"string"},"module":{"description":"The name of the module called.","example":"Backup","type":"string"},"result":{"properties":{"data":{"description":"An array of the account's backup files.","items":{"example":"2014-12-02","format":"ISO-8601 Date","type":"string"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"cnt":{"description":"The number of backup files.","example":1,"type":"integer"},"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return backup files","tags":["Backup"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Backup \\\n  list_backups\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Backup/list_backups"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Backup_list_backups.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Backup_list_backups.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Backup/,\n    q/list_backups/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Backup_list_backups.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Backup_list_backups.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Backup',\n    'list_backups'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.42"}},"/Bandwidth/get_retention_periods":{"get":{"description":"This function retrieves the retention periods for bandwidth data.","operationId":"get_retention_periods","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_retention_periods","type":"string"},"module":{"description":"The name of the module called.","example":"Bandwidth","type":"string"},"result":{"properties":{"data":{"items":{"properties":{"interval":{"description":"The interval in which the system reports bandwidth data.\n- `daily`\n- `hourly`\n- `5min`","enum":["daily","hourly","5min"],"example":"5min","type":"string"},"retention":{"description":"The retention period for bandwidth data.","example":2678400,"format":"unix_timestamp","type":"integer"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- `1` — Success.\n- `0` — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return bandwidth retention period","tags":["Bandwidth"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  Bandwidth \\\n  get_retention_periods\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Bandwidth/get_retention_periods"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Bandwidth_get_retention_periods.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Bandwidth_get_retention_periods.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Bandwidth/,\n    q/get_retention_periods/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Bandwidth_get_retention_periods.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Bandwidth_get_retention_periods.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Bandwidth',\n    'get_retention_periods'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 11.52"}},"/Batch/strict":{"get":{"description":"This function combines calls for multiple UAPI functions and performs them in order.\n\n**Note:**\n\n* If a function call in the list fails, the `Batch::strict` function does not run further function calls in the list.\n* Due to the potential length of calls of this function, we recommend that you use the HTTP POST method for extremely long batch commands.","operationId":"strict","parameters":[{"content":{"application/json":{"examples":{"multiple":{"summary":"Call multiple UAPI functions.","value":["command=[\"PasswdStrength\",\"get_required_strength\",{\"app\":\"webdisk\"}]","command=[\"SSH\",\"get_port\"]"]},"multiple_indexed":{"summary":"Call multiple UAPI functions using indexed parameters.","value":["command-0=[\"PasswdStrength\",\"get_required_strength\",{\"app\":\"webdisk\"}]","command-1=[\"SSH\",\"get_port\"]"]}},"schema":{"items":{"oneOf":[{"type":"string"},{"additionalProperties":true,"type":"object"}]},"maxItems":3,"minItems":2,"type":"array"}}},"description":"A UAPI function call, encoded as a JSON array with two or three items:\n\n* The UAPI module.\n* The UAPI function.\n* A JSON object containing the parameters to pass to this function. You can omit this value if you do not pass any parameters to the function.\n\nTo submit multiple commands, duplicate the parameter name, or index all parameter names and increment the index for each one.\n\n* When using the cPanel LiveAPI PHP Library, you **must** increment the parameter name when you submit the arguments in an associative array. For example: use `command-0`, `command-1`, and `command-2`.\n* When using the cPanel LiveAPI Perl Library, you **must** increment the parameter name when you submit the arguments in a hash. For example: use `command-0`, `command-1`, and `command-2`.\n* You do **not** need to add an index to `command` parameters for query string calls of this function.","in":"query","name":"command","required":true}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"strict","type":"string"},"module":{"description":"The name of the module called.","example":"Batch","type":"string"},"result":{"properties":{"data":{"description":"An array of objects that contain function output. Each object contains the output data and metadata from one of the `command` parameter's functions.\n\nFor more information about UAPI return data and metadata, read our [UAPI - Return Data](https://go.cpanel.net/UAPIReturnData) documentation.","example":[{"data":{"strength":65},"errors":null,"messages":null,"metadata":{},"status":1,"warnings":null},{"data":{"port":22},"errors":null,"messages":null,"metadata":{},"status":1,"warnings":null}],"items":{"properties":{"data":{"additionalProperties":true,"description":"The data returned by an individual UAPI call invoked through this `Batch::strict` call.","type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Run multiple UAPI functions in order","tags":["Batch"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty --user=username Batch strict command-0='[ \"PasswdStrength\", \"get_required_strength\", { \"app\": \"webdisk\"} ]' command-1='[\"SSH\",\"get_port\"]'"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/Batch/strict?command-0=%5b%20%22PasswdStrength%22%2c%20%22get_required_strength%22%2c%20%7b%20%22app%22%3a%20%22webdisk%22%7d%20%5d&command-1=%5B%22SSH%22%2C%22get_port%22%5D"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file Batch_strict.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/Batch_strict.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/Batch/,\n    q/strict/,\n    {\n        'command-0' => '[ \"PasswdStrength\", \"get_required_strength\", { \"app\": \"webdisk\"} ]',\n        'command-1' => '[\"SSH\",\"get_port\"]',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file Batch_strict.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/Batch_strict.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'Batch',\n    'strict',\n    array (\n        'command-0' => '[ \"PasswdStrength\", \"get_required_strength\", { \"app\": \"webdisk\"} ]',\n        'command-1' => '[\"SSH\",\"get_port\"]',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 54"}},"/BoxTrapper/get_allowlist":{"get":{"description":"This function retrieves a list of BoxTrapper allowlist configuration rules. BoxTrapper will deliver emails that match these rules.\n\n**Important:**\n\nWhen you disable the\n[*Receive Mail* role](https://go.cpanel.net/serverroles),\nthe system **disables** this function.","operationId":"BoxTrapper::get_allowlist","parameters":[{"description":"A valid email address on the cPanel account.\n\n**Warning:**\n\nIf you call this function in Webmail, the system overrides this parameter.\nThis parameter defaults to the current email address.","in":"query","name":"email","required":true,"schema":{"example":"user@example.com","format":"email","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_allowlist","type":"string"},"module":{"description":"The name of the module called.","example":"BoxTrapper","type":"string"},"result":{"properties":{"data":{"description":"The allowlist configuration rules.","items":{"description":"One allowlist rule.","example":"from allowlisted-email\\@domain\\.com","type":"string"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return account BoxTrapper allowlist rules","tags":["BoxTrapper","Spam Prevention (BoxTrapper)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  BoxTrapper \\\n  get_allowlist \\\n  email='user@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/BoxTrapper/get_allowlist?email=user%40example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file BoxTrapper_get_allowlist.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/BoxTrapper_get_allowlist.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/BoxTrapper/,\n    q/get_allowlist/,\n    {\n        'email' => 'user@example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file BoxTrapper_get_allowlist.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/BoxTrapper_get_allowlist.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'BoxTrapper',\n    'get_allowlist',\n    array (\n        'email' => 'user@example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 94"}},"/BlockIP/remove_ip":{"get":{"description":"This function unblocks IP addresses from accessing domains on a cPanel account.\n\n**Important**\n\nWhen you disable the Web Server role, the system disables this function.","operationId":"blockip-remove-ip","parameters":[{"description":"The IP address or IP address range that you wish to unblock.","examples":{"cidr-ipv4":{"summary":"CIDR Format IPv4","value":"192.168.0.1/16"},"cidr-ipv6":{"summary":"CIDR Format IPv6","value":"2001:db8::/32"},"hostname":{"summary":"Add by resolving hostname","value":"example.com"},"implied-range":{"summary":"Implied Range","value":"192.168.0.1-58"},"ipv4-range":{"summary":"IPv4 Range","value":"192.168.0.1-192.168.0.58"},"ipv6-range":{"summary":"IPv6 Range","value":"2001:db8::1-2001:db8::3"},"single-ipv4":{"summary":"Single IPv4 Address","value":"192.0.2.0"},"single-ipv6":{"summary":"Single IPv6 Address","value":"2001:db8::1"},"subnet-octet":{"summary":"Subnet Range - Matches 10.*.*.*","value":"10."}},"in":"query","name":"ip","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"remove_ip","type":"string"},"module":{"description":"The name of the module called.","example":"BlockIP","type":"string"},"result":{"properties":{"data":{"description":"The IP addresses that the function removed, and the system translated.","items":{"example":"1.1.1.1","type":"string"},"nullable":true,"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Remove IP address from cPanel account's block list","tags":["BlockIP","Block IP"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  BlockIP \\\n  remove_ip \\\n  ip='192.168.0.1/16'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/BlockIP/remove_ip?ip=192.168.0.1%2f16"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file BlockIP_remove_ip.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/BlockIP_remove_ip.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/BlockIP/,\n    q/remove_ip/,\n    {\n        'ip' => '192.168.0.1/16',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file BlockIP_remove_ip.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/BlockIP_remove_ip.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'BlockIP',\n    'remove_ip',\n    array (\n        'ip' => '192.168.0.1/16',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":82}},"/BoxTrapper/get_configuration":{"get":{"description":"This function retrieves an account's BoxTrapper configuration.\n\n**Important:**\n\n  When you disable the [Receive Mail](https://go.cpanel.net/serverroles) role, the system disables this function.","operationId":"get_configuration","parameters":[{"description":"The account's email address.\n\n**Warning:**\n\nIf you call this function in Webmail, the system ignores this parameter and defaults to the currently-authenticated email address.","in":"query","name":"email","required":true,"schema":{"example":"user@example.com","format":"email","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_configuration","type":"string"},"module":{"description":"The name of the module called.","example":"BoxTrapper","type":"string"},"result":{"properties":{"data":{"properties":{"enable_auto_whitelist":{"description":"Whether whitelisting is enabled.\n* 1 - Enabled.\n* 0 - Disabled.","enum":[0,1],"example":1,"type":"integer"},"from_addresses":{"description":"The email addresses that send emails from the account. A comma-separated list of email addresses.","example":"user@example.com,user2@example.com","type":"string"},"from_name":{"description":"The name of the person who owns the email account.","example":"User","type":"string"},"queue_days":{"description":"The number of days that the system retains log files and queued messages.","example":14,"minimum":0,"type":"integer"},"spam_score":{"description":"The account's [Apache SpamAssassin](https://go.cpanel.net/cpaneldocsSpamFilters) threshold score.","example":2.5,"type":"number"},"whitelist_by_association":{"description":"Whether the system whitelisted the email addresses in a message's `To` and `From` sections, including carbon-copied (CC) recipients.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return email account's BoxTrapper configuration","tags":["BoxTrapper","Spam Prevention (BoxTrapper)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  BoxTrapper \\\n  get_configuration \\\n  email='user@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/BoxTrapper/get_configuration?email=user%40example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file BoxTrapper_get_configuration.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/BoxTrapper_get_configuration.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/BoxTrapper/,\n    q/get_configuration/,\n    {\n        'email' => 'user@example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file BoxTrapper_get_configuration.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/BoxTrapper_get_configuration.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'BoxTrapper',\n    'get_configuration',\n    array (\n        'email' => 'user@example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/BoxTrapper/get_forwarders":{"get":{"description":"This function retrieves a list of email addresses to which BoxTrapper forwards email messages.\n\n**Important:**\n\nWhen you disable the [Receive Mail](https://go.cpanel.net/serverroles) role, the system **disables** this function.","operationId":"get_forwarders","parameters":[{"description":"The account's email address.\n\n**Important:**\n\nIf you call this function in Webmail, the system ignores this parameter and defaults to the currently-authenticated email address.","in":"query","name":"email","required":true,"schema":{"example":"user@example.com","format":"email","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_forwarders","type":"string"},"module":{"description":"The name of the module called.","example":"BoxTrapper","type":"string"},"result":{"properties":{"data":{"description":"The email addresses to which BoxTrapper forwards email.","items":{"example":"user1@example.com, user2@example.com, user3@example.com","type":"string"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return all BoxTrapper forwarders","tags":["BoxTrapper","Spam Prevention (BoxTrapper)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  BoxTrapper \\\n  get_forwarders \\\n  email='user@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/BoxTrapper/get_forwarders?email=user%40example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file BoxTrapper_get_forwarders.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/BoxTrapper_get_forwarders.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/BoxTrapper/,\n    q/get_forwarders/,\n    {\n        'email' => 'user@example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file BoxTrapper_get_forwarders.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/BoxTrapper_get_forwarders.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'BoxTrapper',\n    'get_forwarders',\n    array (\n        'email' => 'user@example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 86"}},"/BoxTrapper/get_log":{"get":{"description":"This function returns the account's BoxTrapper log file and its contents.\n\n**Important:**\n\nWhen you disable the [Receive Mail role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.","operationId":"get_log","parameters":[{"description":"The account's email address.\n\n**Important:**\n\nIf you call this function in Webmail, the system ignores this parameter and defaults to the currently authenticated email address.","in":"query","name":"email","required":true,"schema":{"example":"user@example.com","format":"email","type":"string"}},{"description":"The date for which to return the log file and its contents.\n\n**Note:**\n\nThis parameter defaults to the current date.","in":"query","name":"date","required":false,"schema":{"example":1556812881,"format":"unix_timestamp","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_log","type":"string"},"module":{"description":"The name of the module called.","example":"BoxTrapper","type":"string"},"result":{"properties":{"data":{"properties":{"date":{"description":"The date for which the system returned the log.","example":1556812881,"format":"unix_timestamp","type":"integer"},"lines":{"description":"An array of lines from the log file. If the log file doesn't exist or if no log lines exist in the file, the function returns an empty array.","items":{"example":"Processing email with trusted transport method.","type":"string"},"type":"array"},"path":{"description":"The log file's filepath. If the log file doesn't exist, the function returns an empty string.","example":"/home/user/etc/example.com/user/boxtrapper/log/05-02-2019.log","type":"string"}},"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* 1 — Success.\n* 0 — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return BoxTrapper log file and contents","tags":["BoxTrapper","Spam Prevention (BoxTrapper)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  BoxTrapper \\\n  get_log \\\n  email='user@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/BoxTrapper/get_log?email=user%40example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file BoxTrapper_get_log.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/BoxTrapper_get_log.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/BoxTrapper/,\n    q/get_log/,\n    {\n        'email' => 'user@example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file BoxTrapper_get_log.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/BoxTrapper_get_log.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'BoxTrapper',\n    'get_log',\n    array (\n        'email' => 'user@example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/BoxTrapper/get_status":{"get":{"description":"This function checks whether BoxTrapper is enabled for an email account.\n\n**Important:**\n\nWhen you disable the [Receive Mail role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.","operationId":"get_status","parameters":[{"description":"The account's email address.\n\n**Important:**\n\nIf you call this function in Webmail, the system ignores this parameter.","in":"query","name":"email","required":true,"schema":{"example":"user@example.com","format":"email","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"get_status","type":"string"},"module":{"description":"The name of the module called.","example":"BoxTrapper","type":"string"},"result":{"properties":{"data":{"description":"Whether BoxTrapper is enabled for the email account.\n* `1` — Enabled.\n* `0` — Disabled.","enum":[0,1],"example":0,"type":"integer"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* 1 — Success.\n* 0 — Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return whether email account uses BoxTrapper","tags":["BoxTrapper","Spam Prevention (BoxTrapper)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  BoxTrapper \\\n  get_status \\\n  email='user@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/BoxTrapper/get_status?email=user%40example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file BoxTrapper_get_status.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/BoxTrapper_get_status.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/BoxTrapper/,\n    q/get_status/,\n    {\n        'email' => 'user@example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file BoxTrapper_get_status.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/BoxTrapper_get_status.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'BoxTrapper',\n    'get_status',\n    array (\n        'email' => 'user@example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/BoxTrapper/delete_messages":{"get":{"description":"This function deletes messages in the BoxTrapper queue.\n\n**Important:**\n\nWhen you disable the [Receive Mail](https://go.cpanel.net/serverroles) role, the system disables this function.","operationId":"delete_messages","parameters":[{"description":"The account's email address.\n\n**Warning:**\n\nIf you call this function in Webmail, the system ignores this parameter and defaults to the currently-authenticated email address.","in":"query","name":"email","required":true,"schema":{"example":"user@example.com","format":"email","type":"string"}},{"description":"The filename of the email message who's sender to delete.\n\n  **Warning:**\n\n To delete multiple email message senders, duplicate the parameter name.","examples":{"multiple":{"summary":"Delete multiple filenames.","value":"queuefile=file1.msg&queuefile=file2.msg"},"single":{"summary":"Delete a single filename.","value":"file1.msg"}},"in":"query","name":"queuefile","required":true,"schema":{"example":"example.msg","type":"string"}},{"description":"Whether to delete all messages that resemble the `queuefile` parameter's value.\n\n* `1` - Delete all messages resembling the `queuefile` parameter.\n* `0` - Do **not** delete all messages resembling the `queuefile` parameter.","in":"query","name":"all_like","required":false,"schema":{"default":0,"enum":[1,0],"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"delete_messages","type":"string"},"module":{"description":"The name of the module called.","example":"BoxTrapper","type":"string"},"result":{"properties":{"data":{"description":"An array of objects that contain information about the messages that matched the requested pattern.","items":{"properties":{"email":{"description":"The deleted email message's sender.","example":"user@example.com","format":"email","type":"string"},"failed":{"description":"Whether the system failed to delete the messages.\n\n**Note:**\n\nThe function only returns this value if it doesn't delete the message.","enum":[1],"example":1,"type":"integer"},"matches":{"description":"An array of messages that the system deleted.","items":{"example":"example.msg","type":"string"},"type":"array"},"operator":{"description":"The operation that the system performed.","enum":["delete"],"example":"delete","type":"string"},"reason":{"description":"A message about the failure or the warning.\n\n**Note:**\n\nThe function only returns this value if it doesn't delete the message or experiences issues when it deletes the message.","example":"(XID d9myfd) The system failed to locate the requested message:","type":"string"},"warning":{"description":"Whether the system experienced issues when it deleted the message.\n\n**Note:**\n\nThe function only returns this value if it experiences issues when it deletes the message.","enum":[1],"example":1,"type":"integer"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[1,0],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Delete messages in the BoxTrapper queue","tags":["BoxTrapper","Spam Prevention (BoxTrapper)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  BoxTrapper \\\n  delete_messages \\\n  email='user@example.com' \\\n  queuefile='file1.msg'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/BoxTrapper/delete_messages?email=user%40example.com&queuefile=file1.msg"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file BoxTrapper_delete_messages.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/BoxTrapper_delete_messages.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/BoxTrapper/,\n    q/delete_messages/,\n    {\n        'email' => 'user@example.com',\n        'queuefile' => 'file1.msg',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file BoxTrapper_delete_messages.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/BoxTrapper_delete_messages.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'BoxTrapper',\n    'delete_messages',\n    array (\n        'email' => 'user@example.com',\n        'queuefile' => 'file1.msg',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/BoxTrapper/list_email_templates":{"get":{"description":"This function lists the BoxTrapper email templates.\n\n**Important:**\n\nWhen you **disable** the [Receive Mail](https://go.cpanel.net/serverroles) role, the system disables this function.","operationId":"list_email_templates","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_email_templates","type":"string"},"module":{"description":"The name of the module called.","example":"BoxTrapper","type":"string"},"result":{"properties":{"data":{"description":"An array of strings representing BoxTrapper message templates.\n* `blacklist` - BoxTrapper responds with this message when a blacklisted address sends an email.\n* `verify` - BoxTrapper responds with this message when an address that does not exist on the whitelist or blacklist sends an email. This message requests a response to confirm that the sender is legitimate.\n* `verifyreleased` - BoxTrapper responds with this message when a person responds to the verify message with an email or a click on the verification link.\n* `returnverify` - BoxTrapper responds with this message when the verification process fails.","example":["blacklist","returnverify","verify","verifyreleased"],"items":{"enum":["blacklist","verify","verifyreleased","returnverify"],"example":"verify","type":"string"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Return BoxTrapper email templates","tags":["BoxTrapper","Spam Prevention (BoxTrapper)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  BoxTrapper \\\n  list_email_templates\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/BoxTrapper/list_email_templates"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file BoxTrapper_list_email_templates.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/BoxTrapper_list_email_templates.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/BoxTrapper/,\n    q/list_email_templates/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file BoxTrapper_list_email_templates.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/BoxTrapper_list_email_templates.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'BoxTrapper',\n    'list_email_templates'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 84"}},"/BoxTrapper/save_configuration":{"get":{"description":"This function modifies an account's BoxTrapper configuration.\n\n**Important:**\n\nWhen you disable the [Receive Mail](https://go.cpanel.net/serverroles) role, the system **disables** this function.","operationId":"save_configuration","parameters":[{"description":"The account's email address.\n\n**Warning:**\n\nIf you call this function in Webmail, the system ignores this parameter and defaults to the currently-authenticated email address.","in":"query","name":"email","required":true,"schema":{"example":"user@example.com","format":"email","type":"string"}},{"description":"A comma-separated list of email addresses that the system uses when it sends messages back to the original message senders.","in":"query","name":"from_addresses","required":true,"schema":{"example":"sender1@test.com,sender2@test.com","format":"email-csv","type":"string"}},{"description":"The account's Apache SpamAssassin™ threshold score. For more information about Apache SpamAssassin threshold scores, read our [Spam Filters](https://go.cpanel.net/cpaneldocsSpamFilters) documentation.\n\n**Note:**\n\nThis parameter defaults to the account's current configuration.","in":"query","name":"spam_score","required":false,"schema":{"example":2.5,"type":"number"}},{"description":"The number of days to retain log files and queued messages.","in":"query","name":"queue_days","required":true,"schema":{"example":14,"minimum":1,"type":"integer"}},{"description":"Whether to enable automatic whitelisting for the account.\n\n* `1` - Enable.\n* `0` - Disable.","in":"query","name":"enable_auto_whitelist","required":true,"schema":{"enum":[0,1],"example":1,"type":"integer"}},{"description":"Whether to whitelist the email addresses in a message's *To* and *From* sections, including carbon-copied (CC) recipients.\n\n* `1` - Whitelist.\n* `0` - Do **not** whitelist.","in":"query","name":"whitelist_by_association","required":true,"schema":{"enum":[0,1],"example":1,"type":"integer"}},{"description":"The name of the person who owns the email account.","in":"query","name":"from_name","required":false,"schema":{"example":"User","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"save_configuration","type":"string"},"module":{"description":"The name of the module called.","example":"BoxTrapper","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` - Success.\n- `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update email account's BoxTrapper configuration","tags":["BoxTrapper","Spam Prevention (BoxTrapper)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  BoxTrapper \\\n  save_configuration \\\n  email='user@example.com' \\\n  from_addresses='sender1@test.com,sender2@test.com' \\\n  queue_days='14' \\\n  enable_auto_whitelist='1' \\\n  whitelist_by_association='1'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/BoxTrapper/save_configuration?email=user%40example.com&from_addresses=sender1%40test.com%2csender2%40test.com&queue_days=14&enable_auto_whitelist=1&whitelist_by_association=1"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file BoxTrapper_save_configuration.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/BoxTrapper_save_configuration.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/BoxTrapper/,\n    q/save_configuration/,\n    {\n        'email' => 'user@example.com',\n        'from_addresses' => 'sender1@test.com,sender2@test.com',\n        'queue_days' => '14',\n        'enable_auto_whitelist' => '1',\n        'whitelist_by_association' => '1',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file BoxTrapper_save_configuration.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/BoxTrapper_save_configuration.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'BoxTrapper',\n    'save_configuration',\n    array (\n        'email' => 'user@example.com',\n        'from_addresses' => 'sender1@test.com,sender2@test.com',\n        'queue_days' => '14',\n        'enable_auto_whitelist' => '1',\n        'whitelist_by_association' => '1',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/BoxTrapper/set_forwarders":{"get":{"description":"This function adds a list of email addresses to which BoxTrapper forwards email messages.\n\n**Important:**\n\n  When you disable the [Receive Mail](https://go.cpanel.net/serverroles) role, the system **disables** this function.","operationId":"set_forwarders","parameters":[{"description":"The account's email address.\n\n**Warning:**\n\nIf you call this function\nin Webmail, the system ignores this parameter and uses the currently-authenticated\nemail address.","in":"query","name":"email","required":true,"schema":{"example":"user@example.com","type":"string"}},{"description":"The email addresses to which to forward email messages.","example":["user1@example.com"],"in":"query","name":"forwarder","required":true,"schema":{"items":{"example":"user1@example.com","format":"email"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_forwarders","type":"string"},"module":{"description":"The name of the module called.","example":"BoxTrapper","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- 1 - Success\n- 0 - Failed: Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Add email address to BoxTrapper forwarders","tags":["BoxTrapper","Spam Prevention (BoxTrapper)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  BoxTrapper \\\n  set_forwarders \\\n  email='user@example.com' \\\n  forwarder='user1@example.com'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/BoxTrapper/set_forwarders?email=user%40example.com&forwarder=user1%40example.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file BoxTrapper_set_forwarders.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/BoxTrapper_set_forwarders.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/BoxTrapper/,\n    q/set_forwarders/,\n    {\n        'email' => 'user@example.com',\n        'forwarder' => 'user1@example.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file BoxTrapper_set_forwarders.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/BoxTrapper_set_forwarders.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'BoxTrapper',\n    'set_forwarders',\n    array (\n        'email' => 'user@example.com',\n        'forwarder' => 'user1@example.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 86"}},"/BoxTrapper/set_allowlist":{"get":{"description":"This function sets the BoxTrapper allowlist configuration rules. BoxTrapper will deliver emails that match these rules.\n\n**Important:**\n\nWhen you disable the\n[*Receive Mail* role](https://go.cpanel.net/serverroles),\nthe system **disables** this function.","operationId":"BoxTrapper::set_allowlist","parameters":[{"description":"A valid email address on the cPanel account.\n\n**Warning:**\n\nIf you call this function in Webmail, the system overrides this parameter.\nThis parameter defaults to the current email address.","in":"query","name":"email","required":true,"schema":{"example":"user@example.com","format":"email","type":"string"}},{"description":"An array of allowlist rules.\n\n**Note:**\n\nYou can set multiple allowlist rules, duplicate or increment the parameter name. For example,\n`rules-1`, `rules-2`, and `rules-3`.","examples":{"multiple":{"summary":"Set multiple rules.","value":"rules-1='allowlisted-email\\@domain\\.com' rules-2='from allowlisted-email2\\@domain\\.com' rules-3='to domain2\\.com'"},"multiple-alternative":{"summary":"Set multiple rules.","value":"rules='allowlisted-email\\@domain\\.com' rules='from allowlisted-email2\\@domain\\.com' rules='to domain2\\.com'"},"single":{"summary":"Set a single rule.","value":"allowlisted-email\\@domain\\.com"}},"in":"query","name":"rules","required":true,"schema":{"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"set_allowlist","type":"string"},"module":{"description":"The name of the module called.","example":"BoxTrapper","type":"string"},"result":{"properties":{"data":{"default":null,"nullable":true,"type":"object"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"* `1` - Success.\n* `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Update account BoxTrapper allowlist","tags":["BoxTrapper","Spam Prevention (BoxTrapper)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty --user=username BoxTrapper set_allowlist email='user@example.com' rules-1='allowlisted-email\\@domain\\.com' rules-2='from allowlisted-email2\\@domain\\.com' rules-3='to domain2\\.com'"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/BoxTrapper/set_allowlist?email=user%40example.com&rules=allowlisted-email%5c%40domain%5c.com"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file BoxTrapper_set_allowlist.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/BoxTrapper_set_allowlist.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/BoxTrapper/,\n    q/set_allowlist/,\n    {\n        'email' => 'user@example.com',\n        'rules' => 'allowlisted-email\\@domain\\.com',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    # Do something with the $data\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file BoxTrapper_set_allowlist.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/BoxTrapper_set_allowlist.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'BoxTrapper',\n    'set_allowlist',\n    array (\n        'email' => 'user@example.com',\n        'rules' => 'allowlisted-email\\@domain\\.com',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    // Do something with the $data\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 94"}},"/BoxTrapper/process_messages":{"get":{"description":"This function performs a specified action on messages in the BoxTrapper queue.\n\n**Important:**\n\nWhen you disable the [*Receive Mail*](https://go.cpanel.net/serverroles#roles) role, the system **disables** this function.","operationId":"process_messages","parameters":[{"description":"The account's email address.\n\n**Warning:**\n\n* The `email` parameter is required when this function is called **outside** of Webmail.\n* If you call this function in Webmail, the `email` parameter is **not** required, and\nthe system overrides this parameter with the current authenticated user's email address.","in":"query","name":"email","schema":{"example":"user@example.com","format":"email","type":"string"}},{"description":"The filename of the email message to process. To process multiple email messages, pass this parameter multiple times.","examples":{"multiple":{"summary":"Process multiple email messages.","value":"email=example.msg email=example1.msg email=example2.msg"},"single":{"summary":"Process a single email message.","value":"example.msg"}},"in":"query","name":"queuefile","required":true,"schema":{"example":"example.msg","type":"string"}},{"description":"The action to perform on the email message file. To perform multiple actions on the specified email messages, pass this parameter multiple times.\n\n* `deliver` — Deliver a specific message.\n* `deliverall` — Deliver all messages from a sender.\n* `delete` — Delete a message.\n* `deleteall` — Delete all messages from a sender.\n* `blacklist` — Blacklist the sender of an email message.\n* `whitelist` — Whitelist the sender of an email message.\n* `ignore` — Ignore email messages from a sender.\n\n**Note:**\n\nThe function performs the actions on the email messages files in the order that you pass each action.","examples":{"multiple":{"summary":"Perform multiple actions.","value":"action=blacklist action=deleteall"},"single":{"summary":"Perform a single action.","value":"blacklist"}},"in":"query","name":"action","required":true,"schema":{"enum":["deliver","deliverall","delete","deleteall","blacklist","whitelist","ignore"],"example":"blacklist","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"function-fail":{"summary":"The function failed.","value":{"apiversion":3,"module":"BoxTrapper","result":{"data":[{"email":null,"failed":1,"matches":["example"],"reason":"(XID 2ymu8k) The system failed to locate the requested message:  example.msg"}],"errors":null,"messages":null,"metadata":{"transformed":1},"status":1,"warnings":["One or more of the operations failed."]}}},"function-success":{"summary":"The function succeeded.","value":{"apiversion":3,"data":[{"email":"user@example.com","matches":["example"],"operator":"blacklist"},{"email":"user@example.com","matches":["example"],"operator":"deleteall"}],"errors":null,"messages":null,"metadata":{"transformed":1},"module":"BoxTrapper","status":1,"warnings":null}}},"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"process_messages","type":"string"},"module":{"description":"The name of the module called.","example":"BoxTrapper","type":"string"},"result":{"properties":{"data":{"description":"An array of objects containing processed email message information.","items":{"properties":{"email":{"description":"The email address for which the system\nprocessed an email message.","format":"email","nullable":true,"type":"string"},"failed":{"description":"Whether the system failed to process the message.\n\n* `1` - The function failed to process the message. This is the only\npossible value.\n\n**Note:**\n\nThe function only returns this value if it fails to process the message.","enum":[1],"example":1,"type":"integer"},"matches":{"description":"An array of email messages that the system processed.","items":{"type":"string"},"type":"array"},"operator":{"description":"The operation that the system performed.\n* `deliver` - Delivered a specific message.\n* `deliverall` - Delivered all messages from a sender.\n* `delete` - Deleted a message.\n* `deleteall` - Deleted all messages from a sender.\n* `blacklist` - Blacklisted the sender of an email message.\n* `whitelist` - Whitelisted the sender of an email message.\n* `ignore` - Ignored email messages from a sender.\n\n**Note:**\n\nThe function only returns this value if it successfully processes the message.","enum":["deliver","deliverall","delete","deleteall","blacklist","whitelist","ignore"],"example":"delete","type":"string"},"reason":{"description":"A message about the failure or the warning.\n\n**Note:**\n\nThe function only returns this value if it fails to processes the message or experiences issues when it processes the message.","type":"string"}},"type":"object"},"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{"transformed":{"description":"Post-processing may have transformed the data.","enum":[1],"example":1,"type":"integer"}}},"status":{"description":"* `1` - Success\n* `0` - Failed. Check the errors field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}}}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"Run a specific BoxTrapper action for a message","tags":["BoxTrapper","Spam Prevention (BoxTrapper)"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  BoxTrapper \\\n  process_messages \\\n  queuefile='example.msg' \\\n  action='blacklist'\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/BoxTrapper/process_messages?queuefile=example.msg&action=blacklist"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file BoxTrapper_process_messages.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/BoxTrapper_process_messages.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/BoxTrapper/,\n    q/process_messages/,\n    {\n        'queuefile' => 'example.msg',\n        'action' => 'blacklist',\n    }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file BoxTrapper_process_messages.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/BoxTrapper_process_messages.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'BoxTrapper',\n    'process_messages',\n    array (\n        'queuefile' => 'example.msg',\n        'action' => 'blacklist',\n    )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 82"}},"/CCS/list_delegates":{"get":{"description":"This function lists all [calendar delegates](https://docs.cpanel.net/cpanel/email/calendar-delegation/) on the cPanel account.\n\n**Note:**\n\nYou **must** install the [Calendar and Contacts Server](https://go.cpanel.net/CalendarAndContactsServer) cPanel plugin to access this API function.","operationId":"list_delegates","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"apiversion":{"description":"The version of the API.","example":3,"type":"integer"},"func":{"description":"The name of the method called.","example":"list_delegates","type":"string"},"module":{"description":"The name of the module called.","example":"CCS","type":"string"},"result":{"properties":{"data":{"description":"An array of objects that contain Calendars and Contacts Server calendar delegation information.","items":{"properties":{"delegatee":{"description":"The user with delegation rights.","example":"delegatee@cptest.test","format":"email","type":"string"},"delegator":{"description":"The calendar's owner.","example":"delegator@cptest.test","format":"email","type":"string"},"read_only":{"description":"Whether the delegatee has read-only access on the calendar.\n* `1` - Read-only access.\n* `0` - Full access.","enum":[1,0],"example":1,"type":"integer"}},"type":"object"},"nullable":true,"type":"array"},"errors":{"description":"List of errors if the API failed.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"messages":{"description":"List of messages generated by the API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"},"metadata":{"properties":{}},"status":{"description":"- `1` - Success.\n- `0` - Failed. Check the `errors` field for more details.","enum":[0,1],"example":1,"type":"integer"},"warnings":{"description":"List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.","example":null,"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"HTTP Request was successful."}},"summary":"List cPanel account's calendar delegates","tags":["CCS","Calendar and Contacts Server"],"x-codeSamples":[{"label":"CLI","lang":"Shell","source":"uapi --output=jsonpretty \\\n  --user=username \\\n  CCS \\\n  list_delegates\n"},{"label":"URL","lang":"HTTP","source":"https://hostname.example.com:2083/cpsess##########/execute/CCS/list_delegates"},{"label":"LiveAPI Perl","lang":"Perl","source":"#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# <theme-name> is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file CCS_list_delegates.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend/<theme-name>/\n#    to .../frontend/<theme-name>/api_examples/CCS_list_delegates.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n    q/CCS/,\n    q/list_delegates/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n    my $data = $response->{cpanelresult}{result}{data};\n    foreach my $item (@{$data}) {\n        # Do something with the $item\n    }\n\n    # So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    # Report errors:\n    print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n    require JSON;\n    my $str = JSON->new->pretty->encode($_[0]);\n    return $str;\n}\n"},{"label":"LiveAPI PHP","lang":"PHP","source":"<?php\n//--------------------------------------------------------------------------------------\n// Instructions:\n//--------------------------------------------------------------------------------------\n// <theme-name> is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/<theme-name>\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file CCS_list_delegates.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend/<theme-name>/\n//    to .../frontend/<theme-name>/api_examples/CCS_list_delegates.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n    'CCS',\n    'list_delegates'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n    $data = $response['cpanelresult']['result']['data'];\n    foreach ($data as $item) {\n        // Do something with the $item\n    }\n\n    // So you can see the data shape we print it here.\n    print to_json($data);\n}\nelse {\n    // Report errors:\n    print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n    return json_encode($data, JSON_PRETTY_PRINT);\n}"}],"x-cpanel-api-version":"UAPI","x-cpanel-available-version":"cPanel 90"}}},"components":{"schemas":{"index_type":{"description":"The directory's indexing type.\n\n* `standard` - The directory uses directory indexing with standard formatting.\n* `disabled` - The directory doesn't use directory indexing.\n* `inherit` - The directory uses the system's default settings.\n* `fancy` - The directory uses directory indexing with Apache® `httpd`’s `FancyIndexing` directive. The directory will include additional information such as file size and the date of the file's last update.","enum":["standard","disabled","inherit","fancy"],"example":"inherit","type":"string"},"Contents":{"properties":{"all_aliases_valid":{"description":"Whether a valid SSL certificate exists on the domain's aliases.\n\n* `1` — A valid SSL certificate exists.\n* `0` — A valid SSL certificate does **not** exist.\n\n**Note:**\n\nThis return **only** appears if you set the `return_https_redirects_status` parameter to `1`.","enum":[1,0],"type":"integer"},"can_https_redirect":{"description":"Whether a valid SSL certificate exists or AutoSSL runs on the domain.\n\n* `1` — A valid SSL certificate exists or AutoSSL runs.\n* `0` — A valid SSL certificate does **not** exist and AutoSSL does **not** run.\n\n**Note:**\n\nThis return **only** appears if you set the `return_https_redirects_status` parameter to `1`.","enum":[1,0],"type":"integer"},"documentroot":{"description":"The absolute path to the domain's document root.","format":"path","type":"string"},"domain":{"description":"The domain's name.","format":"domain","type":"string"},"group":{"description":"The domain's group.","type":"string"},"hascgi":{"description":"Whether CGI is enabled for the domain.\n\n* `1` — Enabled.\n* `0` — Disabled.","enum":[1,0],"type":"integer"},"homedir":{"description":"The absolute path to the cPanel account's home directory.","format":"path","type":"string"},"ip":{"description":"The domain's IPv4 address.","format":"ipv4","type":"string"},"ipv6":{"description":"The domain's IPv6 address.\n\n* null — The account does **not** use IPv6.","format":"ipv6","nullable":true,"type":"string"},"is_https_redirecting":{"description":"Whether the domain redirects to `https`.\n\n* `1` — The domain redirects to `https`.\n* `0` — The domain does **not** redirect to `https`.\n\n**Note:**\n\nThis return **only** appears if you set the `return_https_redirects_status` parameter to `1`.","enum":[1,0],"type":"integer"},"no_cache_update":{"description":"Whether the domain is subject to cache updates.\n\n* `1` — The domain updates caches.\n* `0` — The domain does **not** update caches.","enum":[1,0],"type":"integer"},"owner":{"description":"The WHM account (`root` or a reseller) that owns the cPanel account.","type":"string"},"serveradmin":{"description":"The domain's administrator's contact email address.","format":"email","type":"string"},"serveralias":{"description":"A space-separated list of the domain's aliases.","format":"domain","type":"string"},"servername":{"description":"The domain's identifier on the server.","format":"domain","type":"string"},"type":{"description":"The type of domain:\n\n* `addon_domain` — The domain is an addon domain.\n* `sub_domain` — The domain is a subdomain.\n* `parked_domain` — The domain is a parked domain (domain alias).","enum":["addon_domain","sub_domain","parked_domains"],"type":"string"},"usecanonicalname":{"description":"The domain's Canonical Name (CNAME) setting.\n\n* `On` — Use the domain's CNAME.\n* `Off` — Do **not** use the domain's CNAME.","enum":["On","Off"],"type":"string"},"user":{"description":"The cPanel account's username.","format":"username","type":"string"},"userdirprotect":{"description":"The domain's [Apache `mod_userdir` Tweak](https://go.cpanel.net/whmdocsApachemod_userdirTweak)\nsetting.\n\n* `1` — Enabled.\n* `0` — Disabled.","enum":[1,0],"type":"integer"}}},"HashOutput":{"properties":{"addon_domains":{"description":"An array of objects containing information about each addon domain.","items":{"$ref":"#/components/schemas/Contents"}},"main_domain":{"description":"An array of objects containing information about the main domain.","items":{"$ref":"#/components/schemas/MainDomainContents"}},"parked_domains":{"description":"An array of objects containing information about each parked domain.","items":{"$ref":"#/components/schemas/Contents"}},"sub_domains":{"description":"An array of objects containing information about each subdomain.","items":{"$ref":"#/components/schemas/Contents"}}},"type":"object"},"ListOutput":{"anyOf":[{"$ref":"#/components/schemas/Contents"},{"$ref":"#/components/schemas/MainDomainContents"}]},"MainDomainContents":{"properties":{"all_aliases_valid":{"description":"Whether a valid SSL certificate exists on the domain's aliases.\n\n* `1` — A valid SSL certificate exists.\n* `0` — A valid SSL certificate does **not** exist.\n\n**Note:**\n\nThis return **only** appears if you set the `return_https_redirects_status` parameter to `1`.","enum":[1,0],"type":"integer"},"can_https_redirect":{"description":"Whether a valid SSL certificate exists or AutoSSL runs on the domain.\n\n* `1` — A valid SSL certificate exists or AutoSSL runs.\n* `0` — A valid SSL certificate does **not** exist and AutoSSL does **not** run.\n\n**Note:**\n\nThis return **only** appears if you set the `return_https_redirects_status` parameter to `1`.","enum":[1,0],"type":"integer"},"customlog":{"description":"The domain's [Apache log](http://httpd.apache.org/docs/2.2/mod/mod_log_config.html)\ninformation.","properties":{"format":{"description":"The [log file](https://httpd.apache.org/docs/2.2/mod/mod_log_config.html#logformat)'s\nformat.","type":"string"},"target":{"description":"The absolute path to the domain's log file in the `domlogs` directory.","type":"string"}},"type":"object"},"documentroot":{"description":"The absolute path to the domain's document root.","format":"path","type":"string"},"domain":{"description":"The domain's name.","format":"domain","type":"string"},"group":{"description":"The domain's group.","type":"string"},"hascgi":{"description":"Whether CGI is enabled for the domain.\n\n* `1` — Enabled.\n* `0` — Disabled.","enum":[1,0],"type":"integer"},"homedir":{"description":"The absolute path to the cPanel account's home directory.","format":"path","type":"string"},"ifmodulemodsuphpc":{"description":"Information about PHP scripts and suPHP.","properties":{"group":{"description":"If suPHP is enabled, PHP scripts run as this group.","type":"string"}},"type":"object"},"ip":{"description":"The domain's IPv4 address.","format":"ipv4","type":"string"},"ipv6":{"description":"The domain's IPv6 address.\n\n* null — The account does **not** use IPv6.","format":"ipv6","nullable":true,"type":"string"},"is_https_redirecting":{"description":"Whether the domain redirects to `https`.\n\n* `1` — The domain redirects to `https`.\n* `0` — The domain does **not** redirect to `https`.\n\n**Note:**\n\nThis return **only** appears if you set the `return_https_redirects_status` parameter to `1`.","enum":[1,0],"type":"integer"},"no_cache_update":{"description":"Whether the domain is subject to cache updates.\n\n* `1` — The domain updates caches.\n* `0` — The domain does **not** update caches.","enum":[1,0],"type":"integer"},"owner":{"description":"The WHM account (`root` or a reseller) that owns the cPanel account.","type":"string"},"scriptalias":{"description":"The domain's CGI information.","properties":{"path":{"description":"The absolute path to the domain's CGI directory.","format":"path","type":"string"},"url":{"description":"The domain's CGI directory.","format":"path","type":"string"}},"type":"object"},"serveradmin":{"description":"The domain's administrator's contact email address.","format":"email","type":"string"},"serveralias":{"description":"A space-separated list of the domain's aliases.","format":"domain","type":"string"},"servername":{"description":"The domain's identifier on the server.","format":"domain","type":"string"},"type":{"description":"The domain is the cPanel account's main domain.\n\n* `main_domain` is the only possible value.","enum":["main_domain"],"type":"string"},"usecanonicalname":{"description":"The domain's Canonical Name (CNAME) setting.\n\n* `On` — Use the domain's CNAME.\n* `Off` — Do **not** use the domain's CNAME.","enum":["On","Off"],"type":"string"},"user":{"description":"The cPanel account's username.","format":"username","type":"string"},"userdirprotect":{"description":"The domain's [Apache `mod_userdir` Tweak](https://go.cpanel.net/whmdocsApachemod_userdirTweak)\nsetting.\n\n* `1` — Enabled.\n* `0` — Disabled.","enum":[1,0],"type":"integer"}}},"trace_deliveryResponseBase":{"properties":{"address":{"description":"The email address of an email message recipient.","example":"username@example.com","format":"email","type":"string"},"type":{"description":"A type of trace node. The system returns this value to indicate the **end** of routing.\n* `bounce` - The system rejected the email's delivery.\n* `command` - The system will run a command when it receives an email.\n* `defer` - The system deferred the email.\n* `discard` - The system discarded the email.\n* `error` - The system encountered an error.\n* `local_delivery` - The system sent the email to a local mailbox.\n* `remote_delivery` - The system sent the email via Simple Mail Transfer Protocol (SMTP).\n* `routed` - The system routed the email elsewhere.\n\n**Note:**\n* The structure of the `destinations` return changes depending on the `type` return value.\n* The `routed` type can return any other type's data structure as part of the `destinations` return value.\n\nFor more information, see the return structure for each `type` return value below:","example":"local_delivery","type":"string"}}},"trace_deliveryResponseBounce":{"allOf":[{"$ref":"#/components/schemas/trace_deliveryResponseBase"},{"properties":{"destinations":{"properties":{"message":{"description":"A message that the system sends when it rejects the delivery of an email.","example":"The system rejected the message.","type":"string"},"type":{"$ref":"#/components/schemas/trace_deliveryTypeDescription"}},"type":"object"}},"type":"object"}]},"trace_deliveryResponseCommand":{"allOf":[{"$ref":"#/components/schemas/trace_deliveryResponseBase"},{"properties":{"destinations":{"properties":{"command":{"description":"A command that the system runs when it receives the email.","example":"/usr/local/cpanel/bin/autorespond user@example.com /home/cpmailuser/.autorespond","type":"string"},"type":{"$ref":"#/components/schemas/trace_deliveryTypeDescription"}},"type":"object"}},"type":"object"}]},"trace_deliveryResponseDefer":{"allOf":[{"$ref":"#/components/schemas/trace_deliveryResponseBase"},{"properties":{"destinations":{"properties":{"message":{"description":"A message that the system sends when it defers the email.","example":"The system deferred the message.","type":"string"},"type":{"$ref":"#/components/schemas/trace_deliveryTypeDescription"}},"type":"object"}},"type":"object"}]},"trace_deliveryResponseDiscard":{"allOf":[{"$ref":"#/components/schemas/trace_deliveryResponseBase"},{"properties":{"destinations":{"properties":{"aliasfile":{"description":"The file path on the system where Exim searched for the `address` return value's aliases.\n\n**Note:**\n\nThe function **only** returns this value if an alias exists for the `address` value.","example":"/etc/valiases/example.com","format":"path","type":"string"},"type":{"$ref":"#/components/schemas/trace_deliveryTypeDescription"}},"type":"object"}},"type":"object"}]},"trace_deliveryResponseError":{"allOf":[{"$ref":"#/components/schemas/trace_deliveryResponseBase"},{"properties":{"destinations":{"properties":{"message":{"description":"An error message from the system.","example":"The mail server could not deliver mail to user@example2.com. The account or domain may not exist, they may be blacklisted, or missing the proper dns entries.","type":"string"},"result":{"description":"An error message.","example":"DNS lookup of example2.com (MX) gave HOST_NOT_FOUND","type":"string"},"type":{"$ref":"#/components/schemas/trace_deliveryTypeDescription"}},"type":"object"}},"type":"object"}]},"trace_deliveryResponseLocalDelivery":{"allOf":[{"$ref":"#/components/schemas/trace_deliveryResponseBase"},{"properties":{"destinations":{"properties":{"mailbox":{"description":"The mailbox where the system sent the email.","example":"user@example.com","format":"email","type":"string"},"type":{"$ref":"#/components/schemas/trace_deliveryTypeDescription"}},"type":"object"}},"type":"object"}]},"trace_deliveryResponseRemoteDelivery":{"allOf":[{"$ref":"#/components/schemas/trace_deliveryResponseBase"},{"properties":{"destinations":{"items":{"properties":{"mx":{"description":"An array of strings containing [mail exchanger (MX) information](https://en.wikipedia.org/wiki/MX_record).\n\nEach string contains information for a single mail exchanger (MX), including:\n * The server's hostname.\n * The server's resolving IP address.\n * The MX record's priority. The lower the value, the higher its priority.\n * Whether DNSSEC is enabled for the hostname.","items":{"example":"host.example.com [10.0.0.1] MX=20 dnssec=no","type":"string"},"type":"array"},"type":{"$ref":"#/components/schemas/trace_deliveryTypeDescription"}},"type":"object"},"type":"array"}}}]},"trace_deliveryType":{"anyOf":[{"$ref":"#/components/schemas/trace_deliveryResponseBounce"},{"$ref":"#/components/schemas/trace_deliveryResponseCommand"},{"$ref":"#/components/schemas/trace_deliveryResponseDefer"},{"$ref":"#/components/schemas/trace_deliveryResponseDiscard"},{"$ref":"#/components/schemas/trace_deliveryResponseError"},{"$ref":"#/components/schemas/trace_deliveryResponseLocalDelivery"},{"$ref":"#/components/schemas/trace_deliveryResponseRemoteDelivery"}],"discriminator":{"mapping":{"bounce":"#/components/schemas/trace_deliveryResponseBounce","command":"#/components/schemas/trace_deliveryResponseCommand","defer":"#/components/schemas/trace_deliveryResponseDefer","discard":"#/components/schemas/trace_deliveryResponseDiscard","error":"#/components/schemas/trace_deliveryResponseError","local_delivery":"#/components/schemas/trace_deliveryResponseLocalDelivery","remote_delivery":"#/components/schemas/trace_deliveryResponseRemoteDelivery"},"propertyName":"type"}},"trace_deliveryTypeDescription":{"description":"A type of trace node. The system returns this value to indicate the **end** of routing.\n* `bounce` - The system rejected the email's delivery.\n* `command` - The system will run a command when it receives an email.\n* `defer` - The system deferred the email.\n* `discard` - The system discarded the email.\n* `error` - The system encountered an error.\n* `local_delivery` - The system sent the email to a local mailbox.\n* `remote_delivery` - The system sent the email via Simple Mail Transfer Protocol (SMTP).\n* `routed` - The system routed the email elsewhere.\n\n**Note:**\n* The structure of the `destinations` return changes depending on the `type` return value.\n* The `routed` type can return any other type's data structure as part of the `destinations` return value.","example":"local_delivery","type":"string"},"MarketProviderProductMetaData":{"properties":{"base_name":{"description":"The provider's base name.","nullable":true,"type":"string"},"billing_type":{"description":"The provider's billing type","example":"one-time","type":"string"},"description":{"description":"The product's description.","example":"An Extended Validation (EV) SLL Certificate. Browsers consider this to be more secure a domain validated (DV) certificate.","type":"string"},"display_name":{"description":"The product's display name.","example":"cPanel DV Certificate","type":"string"},"enabled":{"description":"Whether the product is enabled in the cPanel Market.\n* `1` - Enabled.\n* `0` - Not enabled.","enum":[0,1],"example":1,"type":"integer"},"icon":{"description":"The product's display icon.","example":"iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAKq2lDQ1BJQ0MgUHJvZmlsZQAASImV lgdQU+kWx7970xstAQEpoffeQUroofcmKiGhhBJiICDYEXEFVhQRacqCrjQFV6XIKiIWRFkUG/YF WRTUdbFgQ+Vd4BHee/N23rwzc3J/c+Z8/3vul++b+QNAvsfi81NgCQBSeRmCIA9nekRkFB33O8AC JUAC2kCFxU7nMwICfMDfxoe7AJp73jKY0/r7vv8akpy4dDYAUADCsZx0dirCp5DsZvMFGQCgkARq WRn8OS5HmCZABkT46BwnLHDPHMcu8O35npAgF4QnAMCTWSxBAgCk90idnslOQHTINISNeRwuD2FX hB3YiSwOwnkI66emps3xcYS1Y/9FJ+HfNGNFmixWgogXvmU+8K7cdH4KK/v/3I7/HakpwsV3qCJJ ThR4BiFPGWTPGpLTvEXMi/XzX2QuZ75/nhOFnqGLzE53iVpkDsvVe5GFyaGMRWYJltZyM5ghiyxI CxLpx6W7BYv045g+ohlS/EQcz3VnLnJOYkj4Imdyw/wWOT052Hupx0VUFwiDRDPHC9xF35iavjQb m7U0Q0ZiiOfSbBGiGThxrm6iOi9U1M/PcBZp8lMCRP1xKR6ienpmsGhtBnLAFjmJ5RWwpBMg2h/A AMEgFEk6CAOewBSYI4lMlRG3bu5MA5c0fraAm5CYQWcgtyaOzuSxDfXppsYmFgDM3cGFv/jd9fm7 BcnGLtWykPUrviNnkbBUi3gKwDGkJs9aqmluBkAaBUBbL1soyFyooed+MIAIxAENyCF3XA254wbI ZJbADjgBN+AF/EEIiASrARskglQgAFlgA9gK8kEh2A32gUpQAw6BBnAMnAAd4Aw4Dy6Da+AGuAMe ghEwDl6CKfABzEAQhIMoEBWSg5QhDUgPMoWsIQfIDfKBgqBIKAZKgHiQENoAbYMKoRKoEqqFGqFf oNPQeagfGoLuQ6PQJPQW+gKjYDJMgxVhTdgItoYZsDccAq+CE+C1cA6cB++Cy+E6+CjcDp+Hr8F3 4BH4JTyNAigSSgalgjJAWaNcUP6oKFQ8SoDahCpAlaHqUC2oLlQf6hZqBPUK9RmNRVPRdLQB2g7t iQ5Fs9Fr0ZvQRehKdAO6HX0RfQs9ip5Cf8dQMAoYPYwthomJwCRgsjD5mDLMEUwb5hLmDmYc8wGL xcpgtbBWWE9sJDYJux5bhD2AbcX2YIewY9hpHA4nh9PD2eP8cSxcBi4fV4E7ijuHu4kbx33Ck/DK eFO8Oz4Kz8Pn4svwTfhu/E38c/wMQYKgQbAl+BM4hGxCMeEwoYtwnTBOmCFKErWI9sQQYhJxK7Gc 2EK8RHxEfEcikVRJNqRAEpe0hVROOk66QholfSZLkXXJLuRospC8i1xP7iHfJ7+jUCiaFCdKFCWD sovSSLlAeUL5JEYVMxRjinHENotVibWL3RR7LU4Q1xBniK8WzxEvEz8pfl38lQRBQlPCRYIlsUmi SuK0xLDEtCRV0kTSXzJVskiySbJfckIKJ6Up5SbFkcqTOiR1QWqMiqKqUV2obOo26mHqJeo4DUvT ojFpSbRC2jHaIG1KWkraXDpMep10lfRZ6REZlIymDFMmRaZY5oTMXZkvyxSXMZbFLdu5rGXZzWUf ZZfLOsnGyRbItsrekf0iR5dzk0uW2yPXIfdYHi2vKx8onyV/UP6S/KvltOV2y9nLC5afWP5AAVbQ VQhSWK9wSGFAYVpRSdFDka9YoXhB8ZWSjJKTUpJSqVK30qQyVdlBmatcqnxO+QVdms6gp9DL6Rfp UyoKKp4qQpValUGVGVUt1VDVXNVW1cdqRDVrtXi1UrVetSl1ZXVf9Q3qzeoPNAga1hqJGvs1+jQ+ ampphmvu0OzQnNCS1WJq5Wg1az3Spmg7aq/VrtO+rYPVsdZJ1jmgc0MX1rXQTdSt0r2uB+tZ6nH1 DugN6WP0bfR5+nX6wwZkA4ZBpkGzwaihjKGPYa5hh+FrI3WjKKM9Rn1G340tjFOMDxs/NJEy8TLJ NekyeWuqa8o2rTK9bUYxczfbbNZp9sZczzzO/KD5PQuqha/FDotei2+WVpYCyxbLSSt1qxiraqth a5p1gHWR9RUbjI2zzWabMzafbS1tM2xP2P5lZ2CXbNdkN7FCa0XcisMrxuxV7Vn2tfYjDnSHGIef HEYcVRxZjnWOT53UnDhOR5yeM3QYSYyjjNfOxs4C5zbnjy62LhtdelxRrh6uBa6DblJuoW6Vbk/c Vd0T3JvdpzwsPNZ79HhiPL0993gOMxWZbGYjc8rLymuj10Vvsnewd6X3Ux9dH4FPly/s6+W71/eR n4Yfz6/DH/gz/ff6Pw7QClgb8GsgNjAgsCrwWZBJ0IagvmBq8JrgpuAPIc4hxSEPQ7VDhaG9YeJh 0WGNYR/DXcNLwkcijCI2RlyLlI/kRnZG4aLCoo5ETa90W7lv5Xi0RXR+9N1VWqvWrepfLb86ZfXZ NeJrWGtOxmBiwmOaYr6y/Fl1rOlYZmx17BTbhb2f/ZLjxCnlTMbZx5XEPY+3jy+Jn0iwT9ibMJno mFiW+Irrwq3kvknyTKpJ+pjsn1yfPJsSntKaik+NST3Nk+Il8y6mKaWtSxvi6/Hz+SNrbdfuWzsl 8BYcSYfSV6V3ZtAQszMg1BZuF45mOmRWZX7KCss6uU5yHW/dQLZu9s7s5znuOT+vR69nr+/doLJh 64bRjYyNtZugTbGbejerbc7bPL7FY0vDVuLW5K2/5RrnluS+3xa+rStPMW9L3th2j+3N+WL5gvzh HXY7an5A/8D9YXCn2c6Knd8LOAVXC40Lywq/FrGLrv5o8mP5j7O74ncNFlsWH9yN3c3bfXeP456G EsmSnJKxvb5720vppQWl7/et2ddfZl5Ws5+4X7h/pNynvLNCvWJ3xdfKxMo7Vc5VrdUK1TurPx7g HLh50OlgS41iTWHNl5+4P92r9ahtr9OsKzuEPZR56NnhsMN9P1v/3HhE/kjhkW/1vPqRhqCGi41W jY1NCk3FzXCzsHnyaPTRG8dcj3W2GLTUtsq0Fh4Hx4XHX/wS88vdE94nek9an2w5pXGquo3aVtAO tWe3T3Ukdox0RnYOnfY63dtl19X2q+Gv9WdUzlSdlT5b3E3szuuePZdzbrqH3/PqfML5sd41vQ8v RFy4fTHw4uAl70tXLrtfvtDH6Dt3xf7KmX7b/tNXra92XLO81j5gMdD2m8VvbYOWg+3Xra533rC5 0TW0Yqj7puPN87dcb12+zbx97Y7fnaG7oXfvDUcPj9zj3Ju4n3L/zYPMBzMPtzzCPCp4LPG47InC k7rfdX5vHbEcOTvqOjrwNPjpwzH22Ms/0v/4Op73jPKs7Lny88YJ04kzk+6TN16sfDH+kv9y5lX+ n5J/Vr/Wfn3qL6e/BqYipsbfCN7Mvi16J/eu/r35+97pgOknH1I/zHws+CT3qeGz9ee+L+Ffns9k fcV9Lf+m863ru/f3R7Ops7N8loA1bwUQZwDg+HgA3tYDQIkEgHoDAKLYgkeeD2jB188T+Dte8NHz YQnA4R4A5qwa0wmACoS1EKZuAWDOIiHWCDYzE+U/Iz3ezHRBiyyPWJOe2dm3swDgYgD4Njg7O1M+ O/utDBkW8dfn/Ba8+byP4QKg/g7AOjX9jXVbwH/EPwCGGQVDbR7I2wAAAAlwSFlzAAALEwAACxMB AJqcGAAAAgRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRv YmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDUuNC4wIj4KICAgPHJkZjpSREYgeG1sbnM6 cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAg PHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6ZXhpZj0iaHR0 cDovL25zLmFkb2JlLmNvbS9leGlmLzEuMC8iCiAgICAgICAgICAgIHhtbG5zOnRpZmY9Imh0dHA6 Ly9ucy5hZG9iZS5jb20vdGlmZi8xLjAvIj4KICAgICAgICAgPGV4aWY6UGl4ZWxZRGltZW5zaW9u PjM5MzwvZXhpZjpQaXhlbFlEaW1lbnNpb24+CiAgICAgICAgIDxleGlmOlBpeGVsWERpbWVuc2lv bj41MTU8L2V4aWY6UGl4ZWxYRGltZW5zaW9uPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4x PC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRG Pgo8L3g6eG1wbWV0YT4KxfVkQAAACgpJREFUWAmNV1lvG9cZPTMcLsN9EUmJlCzJ+9oEaZAu6WIU CVD0pb+lr31x3/oL8hKgaOOiQVugRV10SZG2dlGntqPElmzZliWLEimJkkhxEfchh5ye71LMQ2Cg HXI4w5k793zL+c53R3McZ4T/Y+M4NUrTNHUcjYYYDm11brgMaLpLnTtwoPHzv7YJrPHliV/1oIyZ AA/6XTx//CmKu3nYgyH6/QEE78rrb+HC5dehiZ3jn1dN9aVrGnSZeDK5AE32ycgJeHHnJSqlAtwe E51mHceVffQ6NTTqFRQL27j1y/ewuvIZwTWMRuNoTeZ41VECKsHUD4q76HbbaszEmIlBo9FIGbeb 38CtX/wUrUZFjZs5dRr+oB8ejwfBkIlIPIFgfA4f/eG3KB3uQdd15cirgCfXxpnU4Dozl7mR29zA Pg1pt5oYjmy4XC643W410WBg4Y8fvodWs4OF8+cxlV5QwAd7GzSoBZfhQnwqBq/P5PMWnj1+gFgy icRU+gsjJg5NwCdHuW643F40jluoVmp4uvoUhttAOBJBPJHA/OIi2rVDHOS34I/GGe4an+0TzIDH 68dxowCfPwgzOMSFqxe4X8L6sw38+oMP8KMf/wTBQFBhSRplm6RT/ZH//Bg2may5NLgNLzyayUtA q9VBu9PFxtoKuod59G0X6kUJv0PiDWhkALMLZ7D29KlKkdc0MbB6+Oc//o3l53v4zpuXUC5uwz1/ bhxJTVeYr4qEIXdUroXK2gjMOgxDg1ezkMu9RK9tMRKz+Nb3vst7OnIvPsfC6TOYnklhevYUKpUq U+bmuA5e5Kr45EUZ0zE/0o/v4b33f4ZAOIZsJouZ6TTS6TRi0RiCwSCjE4DP9MEYDGzmdJzvISVB rCwVC9h8toqdwwbOz6cxf3oej5ZX0Kx38e73r2Nl6QEuXbuKuYV5HB830LcsVkUVn9+7j93NEqw3 stg/alEbdOXM/sEunj9/hkq1gS7H+v0mkskEMplpGH/501+Ryc4gNZ1CNB5HIBjA6vOXOCqUkT01 i7m5Gdy9ex+f5i28/do5FHLb8IfCrJwen5vFTn4HAf5vVOpYnI4AzTJqlQpWn72ESQ4kOGf2VAap qZTihEGC2/aQz3dRrzfg8jj6jZer63jy6Cm2clsolcowmYJTmSnYFJlINIBHT9ZhUW9WN/IIDDs4 e+40UjMM59QUmo0mfD4fRiRaMkrSuU3uHhgs0Xari4P9A2yu57C2to7t7QKqtSqEd5KGbDYDw8s8 mAG/IsnAtrWVpcfOO+98jWXEXMWGWq8/cEL+APJPt5XAtFuzrJpjlp+blRBFeiaDWrVMHYjCzYq4 du0iljfyGlPruGmEyzDg9XhVuXY7PWxsbDEdG5TxIdOja/poOCKzbQgXmH4nkghj/7CCkdvFHM84 NZaox+dHLGLira9eQIq5K1fr6Pb6NJq5TKdU5TSbTbhIrMpxE8f1uiNixLqDQzGzbVvt/MOqcCEU DmAqEUc0GnMMqUUpr5HDKmBbklotHpRx9z99xONhjJgvP6O0eO4s5skHw+OCTo8GtgVn2ACVS+V6 UKqhzxK9/MZrqLR76PVtiszYiJEzlAJTBMdQg+3YPJDwOnuBAPKrrBULpSSFKM1Gh9qew1GFHtEr h5M0qA9dhk60/rjWQP1oh2NHiJLVsWgUnY6lyOVnSvd29tCllgw5dlz/DC+Bxl1U5hjvrlQ8foO+ QwLA+9KZVJuVUtE9hkZeiEKgUathmhGYSsaVuHg8BlLRCCKJGDQaFaAU23Sk37dQKOzig5sfolNr oUxSt6kRkgZp08IJg7vIvUaBUkI0JICgy5f4TAfoTRce0+cM+n006bmb0bSsvpLqKIGlEbXqdSQS EQST5+ANVfEV3cB6bgtrlPQgQrB6HVSKh1hfXqaEAeFYCkk6kWTJx6YS5EBUDKDbdF/CI+eOhIJW WATuk5hyTdJyjVq/ub6FK1cvYo51PTs7gw7Fp16tIBHJwGHTSqcSFJsqlj7+F+KZOWbUgS8SIFVZ nlwjCJ92Xmxi7fEjoRvi3giYgtgN3lVA45XMybmUBI3SGapyqY4LFxYRCQVUiNOsFL/XgOn1KRJG kmGs3L4NG26kZ7MUFzd+/+ePkGbFdFttusCokqzs/jB8HopdmDoQhsY0koQTcN7nKWOgTuQoBsjd TqevJHeBkpyjGH3y8R0Ut/NIZrPokPHN4gGqrR5uvv9zHLCCrr97nU+BXTMArxkg+JBz0QhZxjEK 0tAGFLkheaEiMAGVhwRepUOWVSot7A0Mc4rCdO3qeaSnkySfH8lMho0miifLT3Dnb7dZuhVs7JSw VThk81pAkVXw6dIjhMMhpQVDgo+XamMMqTjBMtSv8pM3CKowxXtVtzo6vR5CpheF7T2l4abfhxBJ GI5PsVsWcO+zxziotGhMCKn5OeS2d2Dee4jM3Cmm5A4FzlLSSyw1pxIEpkKcFh+FnGqTC/JRFvAg obcZujZzGGRJFkoHVMgjyrwPJapjqXKM7fwu1pgSf8BUHbXB5mJ3W9jObamKCZF+smISLZCoisfi oEJS/7kgcUSiFA8IOhISqGGKpV1670glcHkm205+D4uLc2rxsbu7rxqRTcUrU7qbzQaOKNE7+SLe +uabFKEeTK4XRzZXEeLNiQECr7KrrjECCk9NLz8CLhvlkmSRRYZouiZPcOuzNK12F/IG0OL60SGz q/Um7t5/iFxhDy222KNGGVeunOGiZQalZlUq+gRc/JZKkBAw/yxtkWhyQCbnKMk/zyaWihBpDJ0u 5o/xWUKiYroy5JjipDkuZGen8WB5HSOOYwPE21//Bi5fPoNc3iuzcbnHfIuyjcOg4E6mU/Oy88vG S2Icj5INa0ARojeqmchVGilkabLkNOqCpEVC17O6XNWk8cMffFtx5ezZWVykXkQpPpFIiE/wjUlW 11xzDhkt6QnKzS8sUCQUwSHISZglPF0VZnlroXCI5SRjOhbHk2ebBO1DI7Es8kOiIxGZyyRx9dJp zGeTFBifCm+AxIVBIwjqD/uVECnckx8xRD66m8vwkdTcyQ0BGHL54+bEkmu+OinS+Px+VI4OsXtQ Yo/g5Lwr7BYDfaJuAR9Ljrxh5ERocly6wa6pdaE/HOH0KsQKRqBU5Hmim14vJ1LtiI46ir0Crlqo jDoZqR4y/Li/tIIBx8diIZYe1wbMsURClRkHieqVyxXcuXOfD5toNNtclh1xHOlG4k1IILQQr3Uv u5pcFJweV6w0X02osBX4eKCLQCm24pWVJ0zFBvXeBS/zyzdBjNcdLDcSRafxD6iAS9xnZuIq9/LO MM7+JPCCLhFhmoVo8no9YNlZJ8RT6jQB51idr94Wjev2LIRCEfzmd3/H9s6hYrjX64bJpiIeyLRL D5/j5q9ucd0wTTKPu6mLTkqEtBNHxRj15f//Ah9jPXoBZ9CgAAAAAElFTkSuQmCC","format":"base64 image","type":"string"},"icon_mime_type":{"description":"The icon's file type.","example":"image/svg+xml","format":"MIME","type":"string"},"license_term":{"description":"The providers license term","example":0,"minimum":0,"type":"integer"},"max_users":{"description":"The maximum number of users.","example":5,"minimum":0,"nullable":true,"type":"integer"},"maximum_server_price":{"description":"The maximum price that the system will allow for the product.","example":500.1,"format":"currency","nullable":true,"type":"number"},"minimum_server_price":{"description":"The minimum price that the system will allow for the product.","example":3,"format":"currency","nullable":true,"type":"number"},"price":{"description":"The product's price.","example":3,"format":"currency","nullable":true,"type":"number"},"price_unit":{"description":"The currency code of the product's price.","example":"USD","format":"ISO-4217","type":"string"},"product":{"description":"The product name.","example":"Comodo EV Certificate","type":"string"},"product_category":{"description":"The product's category.","example":"N/A","type":"string"},"product_group":{"description":"The product's group.","example":"ssl_certificate","type":"string"},"product_id":{"description":"The product's ID.","example":176,"minimum":1,"type":"integer"},"provider_display_name":{"description":"The cPanel Market provider's display name.\n\n**Note:**\n\nThe `_DISPLAY_NAME` attribute in the cPanel Market provider module contains this value.","example":"cPStore","type":"string"},"provider_name":{"description":"The cPanel Market provider's name.","example":"cPStore","type":"string"},"recommended":{"description":"Whether the product is recommended.\n* `1` — We recommend the product.\n* `0` — We do not recommend the product.","enum":[0,1],"example":1,"type":"integer"},"requires_ip":{"description":"Whether the product requires an IP address.\n* `1` — Requires an IP.\n* `0` — Does **not** require an IP.","enum":[0,1],"example":1,"type":"integer"}},"type":"object"},"MarketProviderProductMetaDataType":{"anyOf":[{"$ref":"#/components/schemas/MarketProviderProductMetaData"},{"$ref":"#/components/schemas/SSLMarketProviderProductMetaData"}],"discriminator":{"mapping":{"ssl_certificate":"#/components/schemas/SSLMarketProviderProductMetaData"},"propertyName":"product_group"}},"SSLMarketProviderProductMetaData":{"allOf":[{"$ref":"#/components/schemas/MarketProviderProductMetaData"},{"properties":{"x_certificate_term":{"description":"An array that indicates the length of time and unit of time that the product secures for.","example":["1","year"],"items":{"type":"string"},"type":"array"},"x_identity_verification":{"additionalProperties":{"description":"Contains additional properties that vary between products.","x-additionalPropertiesName":"certificate_properties"},"description":"Defines a schema for identity verification information for OV and EV certificates.","properties":{"label":{"description":"The display name of the property.","example":"Dun & Bradstreet D-U-N-S (Data Universal Numbering System) Number","type":"string"},"name":{"description":"The name of the property.","example":"duns_number","type":"string"}},"type":"object"},"x_max_http_redirects":{"description":"The maximum number of HTTP redirections that the provider allows during a Domain Control Validation (DCV) check of the domain or domains in the certificate.","minimum":1,"type":"integer"},"x_payment_trigger":{"description":"Indicates whether the provider charges immediately or when they issue the Secure Sockets Layer (SSL) certificate.\n\n* `checkout` — Collect payment and finalize immediately after checkout. Any failures to issue the certificate must prompt a separate refund.\n* `issuance` — Collect payment when the provider issues the certificate to the user.\n\n**Note:**\n\nFor more information, read the _For certificate orders_ section of our [Guide to cPanel Market Provider Modules](https://go.cpanel.net/featureshowcasemarket) documentation.","enum":["checkout","issuance"],"type":"string"},"x_price_per_domain":{"description":"The product's price per domain.","example":3,"minimum":1,"type":"number"},"x_price_per_domain_maximum":{"description":"The maximum `x_price_per_domain` value.","example":30,"minimum":1,"type":"number"},"x_price_per_domain_minimum":{"description":"The minimum `x_price_per_domain` value.","example":3,"minimum":1,"type":"number"},"x_price_per_wildcard_domain":{"description":"The price per domain for a wildcard certificate.","example":99,"minimum":1,"type":"number"},"x_price_per_wildcard_domain_maximum":{"description":"The maximum `x_prive_per_wildcard_domain` value.","example":30,"minimum":1,"type":"number"},"x_price_per_wildcard_domain_minimum":{"description":"The minimum `x_prive_per_wildcard_domain` value.","example":99,"minimum":1,"type":"number"},"x_ssl_per_domain_pricing":{"description":"Whether the provider uses per-domain pricing for this certificate.\n* `1` — Uses per-domain pricing.\n* `0` — Does **not** use per-domain pricing.","enum":[0,1],"type":"integer"},"x_supports_dns_dcv":{"description":"Whether this product supports DNS-based DCV.\n* `1` — Supports DNS DCV.\n* `0` — Does `not` support DNS DCV.","enum":[0,1],"type":"integer"},"x_validation_type":{"description":"The validation type.","example":"ev","type":"string"},"x_warn_after":{"description":"A length of time, in seconds, after which the cPanel interface warns the user that a problem may exist with the order. The warning suggests that they contact the cPanel Market provider's support contact.","example":14400,"minimum":1,"type":"integer"},"x_wildcard_parent_domain_free":{"description":"Indicates if a wildcard domain includes its parent domain. For example, `*.example.com` would include the `example.com` parent domain.\n\n* `1` — The domain does include its parent domain.\n* `0` — The domain does **not** include its parent domain.","enum":[0,1],"type":"integer"}}}],"type":"object"},"CreateUserResponse":{"allOf":[{"$ref":"#/components/schemas/SubaccountBase"},{"properties":{"dismissed_merge_candidates":{"description":"An array of objects containing service candidates that the system dismissed from merges.","items":{"$ref":"#/components/schemas/SubaccountBase"},"type":"array"},"has_expired_invite":{"description":"Whether an expired account login invitation exists.\n* `1` - Expired account invitation exists.\n* `0` - Expired account invitation does **not** exist.","enum":[0,1],"example":0,"type":"integer"},"has_invite":{"description":"Whether an account login invitation exists.\n* `1` - Account invitation exists.\n* `0` - Account invitation does **not** exist.","enum":[0,1],"example":0,"type":"integer"},"invite_expiration":{"description":"When the invitation expires. A date in Unix time format.","example":1591718154,"format":"unix_timestamp","type":"integer"},"merge_candidates":{"description":"An array of objects that represents the service accounts that the system could merge for\nthis subaccount.","items":{"$ref":"#/components/schemas/SubaccountBase"},"type":"array"}},"type":"object"}]},"SubaccountBase":{"properties":{"alternate_email":{"description":"An alternate email address for the subaccount's user.","example":"user@example.com","format":"email","type":"string"},"avatar_url":{"description":"The HTTPS URL to the user's subaccount profile photo image file.","example":"https://img.example.com/avatars/example.jpg","format":"url","type":"string"},"can_delete":{"description":"Whether the cPanel account user can delete the subaccount.\n* `1` - Can delete.\n* `0` - **Cannot** delete.","enum":[0,1],"example":0,"type":"integer"},"can_set_password":{"description":"Whether the cPanel account user can change the subaccount's password.\n* `1` - Can change.\n* `0` - **Cannot** change.\n\n**Note:**\n\n  The function returns a `0` value for subaccounts that inherit their password from the cPanel account.","enum":[0,1],"example":1,"type":"integer"},"can_set_quota":{"description":"Whether the cPanel account user can change the subaccount's disk usage quota.\n* `1` - Can change.\n* `0` - **Cannot** change.","enum":[0,1],"example":0,"type":"integer"},"dismissed":{"description":"Whether the cPanel account user dismissed the merge prompt for the service account.\n\n* `1` - Dismissed.\n* `0` - Did **not** dismiss.\n\n**Note:**\n\n**Only** service accounts return this value.","enum":[0,1],"example":1,"type":"integer"},"domain":{"description":"The subaccount user's associated domain.","example":"example.com","format":"domain","type":"string"},"full_username":{"description":"The subaccount's username and domain name.","example":"user@example.com","format":"email","type":"string"},"guid":{"description":"The subaccount unique identifier.","example":"N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4","type":"string"},"has_siblings":{"description":"Whether the service account shares a `full_username` value with another service account.\n* `1` - Shares.\n* `0` - Does **not** share.","enum":[0,1],"example":0,"type":"integer"},"issues":{"description":"Information about any issues or problems with the subaccount.","items":{"properties":{"area":{"description":"The affected section of cPanel & WHM.","example":"quota","type":"string"},"limit":{"description":"The set quota megabyte (MB) limit for the affected subaccount.","example":1500,"minimum":1,"type":"integer"},"message":{"description":"The description of the issue.","example":"Your account is over quota.","type":"string"},"service":{"description":"The affected service.\n* `email`\n* `ftp`\n* `webdisk`","enum":["email","ftp","webdisk"],"example":"email","type":"string"},"type":{"description":"The type of issue.\n* `error`\n* `warning`\n* `info`","enum":["error","warning","info"],"example":"info","type":"string"},"used":{"description":"The number of megabytes (MB) that the account currently uses.","example":2000,"minimum":1,"type":"integer"}},"type":"object"},"type":"array"},"parent_type":{"description":"The type of account that could own the service account.\n* `sub` - A subaccount.\n* `hypothetical` - A hypothetical subaccount that does **not** yet exist, but the user could create as part of a merge.\n* `null` - **Not** a merge candidate.","example":"hypothetical","nullable":true,"type":"string"},"phone_number":{"description":"The subaccount user's phone number. A valid phone number that conforms to\n[ITU-T](https://en.wikipedia.org/wiki/ITU-T)'s\n[E.164](https://en.wikipedia.org/wiki/E.164)-recommended standard for the representation\nof telephone numbers.","example":"+15551234567","type":"string"},"real_name":{"description":"The name of the subaccount's user, if provided.","example":"John Doe","type":"string"},"services":{"description":"Information about the subaccount's access to email, FTP, and Web Disk.","properties":{"email":{"description":"Information about the subaccount's email status.","properties":{"enabled":{"description":"Whether the subaccount can access Webmail, POP, and IMAP services.\n* `1` - Can access.\n* `0` - **Cannot** access.","enum":[0,1],"example":1,"type":"integer"},"quota":{"description":"The maximum amount of disk space, in megabytes (MB), allocated to subaccount's email account.","example":1500,"minimum":1,"type":"integer"}},"type":"object"},"ftp":{"description":"Information about the subaccount's FTP status.","properties":{"enabled":{"description":"Whether the subaccount can access FTP.\n* `1` - Can access.\n* `0` - **Cannot** access.","enum":[0,1],"example":0,"type":"integer"},"homedir":{"description":"The subaccount's FTP home directory, relative to the cPanel account's home directory.","example":"/subaccount","format":"path","type":"string"},"quota":{"description":"The subaccount's maximum FTP disk space quota, in megabytes (MB).\n* A string containing a non-negative float.\n* `0.00` - Unlimited.","example":"0.00","type":"string"}},"type":"object"},"webdisk":{"description":"Information about the subaccount's Web Disk status.","properties":{"enabled":{"description":"Whether the subaccount can access Web Disk.\n* `1` - Can access.\n* `0` - **Cannot** access.","enum":[0,1],"example":0,"type":"integer"},"homedir":{"description":"The subaccount's Web Disk home directory, relative to the cPanel account's home directory.","example":"/bob","format":"path","type":"string"},"perms":{"description":"Whether the subaccount has read-only or read and write permissions.\n\n* `ro` - Read-only permissions.\n* `rw` - Read and write permissions.","example":"rw","type":"string"},"private":{"description":"Whether the subaccount's Web Disk directory permissions are public or private.\n\n* `1` - Private (`0700`).\n* `0` - Public (`0755`).","enum":[0,1],"example":0,"type":"integer"}},"type":"object"}},"type":"object"},"special":{"description":"Whether the account is a system-created special account that the user **cannot** remove.\n* `1` - A special account.\n* `0` - **Not** a special account.","enum":[0,1],"example":1,"type":"integer"},"sub_account_exists":{"description":"Whether a subaccount exists with the same username.\n* `1` - Exists.\n* `0` - Does not exist.\n\n**Note:**\n\nThe function returns a null value if the account is **not** a service account.","enum":[0,1],"example":0,"nullable":true,"type":"integer"},"synced_password":{"description":"Whether the user has synchronized the passwords for each of the subaccount's service accounts.\n* `1` - Synchronized.\n* `0` - **Not** synchronized.\n\n**Note:**\n\nThe function returns a null value if the account is **not** a subaccount.","enum":[0,1],"example":0,"nullable":true,"type":"integer"},"type":{"description":"The type of account.\n* `sub` - A subaccount.\n* `hypothetical` - A hypothetical subaccount that does not exist, but that the user could create as part of a merge.\n* `service` - A service account.\n* `cpanel` - The cPanel account.","enum":["sub","hypothetical","service","cpanel"],"example":"sub","type":"string"},"username":{"description":"The subaccount's username.","example":"example","type":"string"}},"type":"object"},"LookupServiceAccountSubaccountBase":{"properties":{"alternate_email":{"description":"An alternate email address for the subaccount's user.","example":"user@example.com","format":"email","type":"string"},"avatar_url":{"description":"The user's subaccount profile photo.","example":"https://img.example.com/avatars/example.jpg","format":"url","type":"string"},"can_delete":{"description":"Whether the cPanel account user can delete the subaccount.\n\n* `1` - Can delete.\n* `0` - **Cannot** delete.","enum":[0,1],"example":0,"type":"integer"},"can_set_password":{"description":"Whether the cPanel account user can change the subaccount's password.\n\n* `1` - Can change.\n* `0` - **Cannot** change.\n\n**Note:**\n\n  The function returns a `0` value for subaccounts that inherit their password from the cPanel account.","enum":[0,1],"example":1,"type":"integer"},"can_set_quota":{"description":"Whether the cPanel account user can change the subaccount's disk usage quota.\n\n* `1` - Can change.\n* `0` - **Cannot** change.","enum":[0,1],"example":0,"type":"integer"},"dismissed":{"description":"Whether the cPanel account user dismissed the merge prompt for the service account.\n\n**Note:**\n\n  **Only** service accounts return this value.\n\n* `1` - Dismissed.\n* `0` - Did **not** dismiss.","enum":[0,1],"example":1,"type":"integer"},"domain":{"description":"The Subaccount user's associated domain.\n\nA domain that the cPanel account owns.","example":"example.com","format":"domain","type":"string"},"full_username":{"description":"The subaccount's username and domain name.","example":"user@example.com","type":"string"},"guid":{"description":"The subaccount unique identifier.","example":"N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4","type":"string"},"has_expired_invite":{"description":"Whether an expired account login invitation exists.\n\n* `1` - Expired account invitation exists.\n* `0` - Expired account invitation does **not** exist.","enum":[0,1],"example":0,"type":"integer"},"has_invite":{"description":"Whether an account login invitation exists.\n\n* `1` - Account invitation exists.\n* `0` - Account invitation does **not** exist.","enum":[0,1],"example":0,"type":"integer"},"has_siblings":{"description":"Whether the service account shares a `full_username` value with another service account.\n\n* `1` - Shares.\n* `0` - Does **not** share.","enum":[0,1],"example":0,"type":"integer"},"invite_expiration":{"description":"When the invitation expires.","example":1591718154,"format":"unix_timestamp","type":"integer"},"issues":{"description":"Information about any issues or problems with the subaccount.","items":{"properties":{"area":{"description":"The affected section of cPanel & WHM.","example":"quota","type":"string"},"limit":{"description":"The set quota megabyte (MB) limit for the affected subaccount.","example":1500,"type":"integer"},"message":{"description":"The description of the issue.","example":"Your account is over quota.","type":"string"},"service":{"description":"The affected service.\n* `email`\n* `ftp`\n* `webdisk`","enum":["email","ftp","webdisk"],"example":"email","type":"string"},"type":{"description":"The type of issue.\n* `error`\n* `warning`\n* `info`","enum":["error","warning","info"],"example":"info","type":"string"},"used":{"description":"The number of megabytes (MB) that the account currently uses.","example":2000,"type":"integer"}},"type":"object"},"type":"array"},"parent_type":{"description":"The type of account that could own the service account.\n\n* `sub` - A subaccount.\n* `hypothetical` - A hypothetical subaccount that does **not** yet exist, but the user could create as part of a merge.\n* `null`- **Not** a merge candidate.","example":"hypothetical","type":"string"},"phone_number":{"description":"The subaccount user's phone number.\n\nThe number conforms to the [ITU-T](https://en.wikipedia.org/wiki/ITU-T)'s [E.164](https://en.wikipedia.org/wiki/E.164)-recommended standard for the representation of telephone numbers.","example":"+15551234567","type":"string"},"real_name":{"description":"The name of the subaccount's user.\n\n* A first name, a last name, or a first name and last name.\n* An empty string.","example":"John Doe","type":"string"},"services":{"description":"This object contains information about the subaccount's access to email, FTP, and Web Disk.","properties":{"email":{"description":"This object contains the information that indicates the subaccount's email status.","properties":{"enabled":{"description":"Whether the subaccount can access Webmail, POP, and IMAP services.\n\n* `1` - Can access.\n* `0` - **Cannot** access.","enum":[0,1],"example":1,"type":"integer"},"quota":{"description":"The maximum amount of disk space, in megabytes (MB), allocated to the subaccount's email account.\n\n**Note:**\n\n  This function will not return `0` as a value.","example":100,"type":"integer"}},"type":"object"},"ftp":{"description":"This object contains the information that indicates the subaccount's FTP status.","properties":{"enabled":{"description":"Whether the subaccount can access FTP.\n\n* `1` - Can access.\n* `0` - **Cannot** access.","enum":[0,1],"example":0,"type":"integer"},"homedir":{"description":"The subaccount's FTP home directory.","example":"/subaccount","format":"path","type":"string"},"quota":{"description":"The maximum amount disk space, in megabytes (MB), that the subaccount may use.\n\n* A positive integer between `1` and `999999`\n* `0` - Unlimited.","example":100,"type":"integer"}},"type":"object"},"webdisk":{"description":"This object contains information that indicates the subaccount's Web Disk status.","properties":{"enabled":{"description":"Whether the subaccount can access Web Disk.\n\n* `1` - Can access.\n* `0` - **Cannot** access.","enum":[0,1],"example":0,"type":"integer"},"homedir":{"description":"The subaccount's Web Disk home directory.","example":"/bob","format":"path","type":"string"},"perms":{"description":"Whether to grant write permissions to the subaccount.\n\n* `ro` - Read-only permissions.\n* `rw` - Read and write permissions.","enum":["ro","rw"],"example":"rw","type":"string"},"private":{"description":"Whether to set the Web Disk directory's permissions to public or private.\n\n* `1` - Private (`0700`).\n* `0` - Public (`0755`).","enum":[0,1],"example":0,"type":"integer"}},"type":"object"}},"type":"object"},"special":{"description":"Whether the account is a system-created special account that the user **cannot** remove.\n\n* `1` - A special account.\n* `0` - **Not** a special account.","enum":[0,1],"example":1,"type":"integer"},"sub_account_exists":{"description":"Whether a subaccount exists with the same username.\n\n* `1` - Exists.\n* `0` - Does **not** exist.\n\n**Note:**\n\n  The function returns a `null` value if the account is **not** a service account.","enum":[0,1],"example":0,"type":"integer"},"synced_password":{"description":"Whether the user has synchronized the passwords for each of the subaccount's service accounts.\n\n* `1` - Synchronized.\n* `0` - **Not** synchronized.\n\n**Note:**\n\n  The function returns a `null` value if the account is **not** a subaccount.","enum":[0,1],"example":0,"type":"integer"},"type":{"description":"The type of account.\n\n* `sub` - A subaccount.\n* `hypothetical` - A hypothetical subaccount that does **not** exist, but that the user could create as part of a merge.\n* `service` - A service account.\n* `cpanel` - The cPanel account.","example":"sub","type":"string"},"username":{"description":"The username for the subaccount.\n\n* Length - 64 characters.\n* Characters - `a-z`, `A-Z`, `0-9`, dot (`.`), hyphen (`-`), underscore (`_`).\n\n**Note:**\n\n  This value does **not** include the domain name.","example":"example","type":"string"}},"type":"object"},"LookupServiceAccountSubaccountMergeCandidates":{"properties":{"merge_candidates":{"description":"An array of objects that represents the service accounts that the system could merge for this subaccount.","items":{"allOf":[{"$ref":"#/components/schemas/LookupServiceAccountSubaccountBase"},{"$ref":"#/components/schemas/LookupServiceAccountSubaccountMergeCandidatesEmpty"}]},"type":"array"}},"type":"object"},"LookupServiceAccountSubaccountMergeCandidatesEmpty":{"properties":{"merge_candidates":{"description":"An array of objects that represents the service accounts that the system could merge for this subaccount.","items":{"type":"object"},"type":"array"}},"type":"object"},"EditUserSubaccountBase":{"properties":{"alternate_email":{"description":"An alternate email address for the subaccount's user.","example":"user@example.com","format":"email","type":"string"},"avatar_url":{"description":"The user's subaccount profile photo.","example":"https://img.example.com/avatars/example.jpg","format":"url","type":"string"},"can_delete":{"description":"Whether the cPanel account user can delete the subaccount.\n\n* `1` - Can delete.\n* `0` - **Cannot** delete.","enum":[0,1],"example":0,"type":"integer"},"can_set_password":{"description":"Whether the cPanel account user can change the subaccount's password.\n\n* `1` - Can change.\n* `0` - **Cannot** change.\n\n**Note:**\n\n  The function returns a `0` value for subaccounts that inherit their password from the cPanel account.","enum":[0,1],"example":1,"type":"integer"},"can_set_quota":{"description":"Whether the cPanel account user can change the subaccount's disk usage quota.\n\n* `1` - Can change.\n* `0` - **Cannot** change.","enum":[0,1],"example":0,"type":"integer"},"dismissed":{"description":"Whether the cPanel account user dismissed the merge prompt for the service account.\n\n**Note:**\n\n  **Only** service accounts return this value.\n\n* `1` - Dismissed.\n* `0` - Did **not** dismiss.","enum":[0,1],"example":1,"type":"integer"},"domain":{"description":"The Subaccount user's associated domain.\n\nA domain that the cPanel account owns.","example":"example.com","format":"domain","type":"string"},"full_username":{"description":"The subaccount's username and domain name.","example":"user@example.com","type":"string"},"guid":{"description":"The subaccount unique identifier.","example":"N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4","type":"string"},"has_expired_invite":{"description":"Whether an expired account login invitation exists.\n\n* `1` - Expired account invitation exists.\n* `0` - Expired account invitation does **not** exist.","enum":[0,1],"example":0,"type":"integer"},"has_invite":{"description":"Whether an account login invitation exists.\n\n* `1` - Account invitation exists.\n* `0` - Account invitation does **not** exist.","enum":[0,1],"example":0,"type":"integer"},"has_siblings":{"description":"Whether the service account shares a `full_username` value with another service account.\n\n* `1` - Shares.\n* `0` - Does **not** share.","enum":[0,1],"example":0,"type":"integer"},"invite_expiration":{"description":"When the invitation expires.","example":1591718154,"format":"unix_timestamp","type":"integer"},"issues":{"description":"Information about any issues or problems with the subaccount.","items":{"properties":{"area":{"description":"The affected section of cPanel & WHM.","example":"quota","type":"string"},"limit":{"description":"The set quota megabyte (MB) limit for the affected subaccount.","example":1500,"type":"integer"},"message":{"description":"The description of the issue.","example":"Your account is over quota.","type":"string"},"service":{"description":"The affected service.\n* `email`\n* `ftp`\n* `webdisk`","enum":["email","ftp","webdisk"],"example":"email","type":"string"},"type":{"description":"The type of issue.\n* `error`\n* `warning`\n* `info`","enum":["error","warning","info"],"example":"info","type":"string"},"used":{"description":"The number of megabytes (MB) that the account currently uses.","example":2000,"type":"integer"}},"type":"object"},"type":"array"},"parent_type":{"description":"The type of account that could own the service account.\n\n* `sub` - A subaccount.\n* `hypothetical` - A hypothetical subaccount that does **not** yet exist, but the user could create as part of a merge.\n* `null`- **Not** a merge candidate.","example":"hypothetical","type":"string"},"phone_number":{"description":"The subaccount user's phone number.\n\nThe number conforms to the [ITU-T](https://en.wikipedia.org/wiki/ITU-T)'s [E.164](https://en.wikipedia.org/wiki/E.164)-recommended standard for the representation of telephone numbers.","example":"+15551234567","type":"string"},"real_name":{"description":"The name of the subaccount's user.\n\n* A first name, a last name, or a first name and last name.\n* An empty string.","example":"John Doe","type":"string"},"services":{"description":"This object contains information about the subaccount's access to email, FTP, and Web Disk.","properties":{"email":{"description":"This object contains the information that indicates the subaccount's email status.","properties":{"enabled":{"description":"Whether the subaccount can access Webmail, POP, and IMAP services.\n\n* `1` - Can access.\n* `0` - **Cannot** access.","enum":[0,1],"example":1,"type":"integer"},"quota":{"description":"The maximum amount of disk space, in megabytes (MB), allocated to the subaccount's email account.\n\n**Note:**\n\n  This function will not return `0` as a value.","example":100,"type":"integer"}},"type":"object"},"ftp":{"description":"This object contains the information that indicates the subaccount's FTP status.","properties":{"enabled":{"description":"Whether the subaccount can access FTP.\n\n* `1` - Can access.\n* `0` - **Cannot** access.","enum":[0,1],"example":0,"type":"integer"},"homedir":{"description":"The subaccount's FTP home directory.","example":"/subaccount","format":"path","type":"string"},"quota":{"description":"The maximum amount disk space, in megabytes (MB), that the subaccount may use.\n\n* A positive integer between `1` and `999999`\n* `0` - Unlimited.","example":100,"type":"integer"}},"type":"object"},"webdisk":{"description":"This object contains information that indicates the subaccount's Web Disk status.","properties":{"enabled":{"description":"Whether the subaccount can access Web Disk.\n\n* `1` - Can access.\n* `0` - **Cannot** access.","enum":[0,1],"example":0,"type":"integer"},"homedir":{"description":"The subaccount's Web Disk home directory.","example":"/bob","format":"path","type":"string"},"perms":{"description":"Whether to grant write permissions to the subaccount.\n\n* `ro` - Read-only permissions.\n* `rw` - Read and write permissions.","enum":["ro","rw"],"example":"rw","type":"string"},"private":{"description":"Whether to set the Web Disk directory's permissions to public or private.\n\n* `1` - Private (`0700`).\n* `0` - Public (`0755`).","enum":[0,1],"example":0,"type":"integer"}},"type":"object"}},"type":"object"},"special":{"description":"Whether the account is a system-created special account that the user **cannot** remove.\n\n* `1` - A special account.\n* `0` - **Not** a special account.","enum":[0,1],"example":1,"type":"integer"},"sub_account_exists":{"description":"Whether a subaccount exists with the same username.\n\n* `1` - Exists.\n* `0` - Does **not** exist.\n\n**Note:**\n\n  The function returns a `null` value if the account is **not** a service account.","enum":[0,1],"example":0,"type":"integer"},"synced_password":{"description":"Whether the user has synchronized the passwords for each of the subaccount's service accounts.\n\n* `1` - Synchronized.\n* `0` - **Not** synchronized.\n\n**Note:**\n\n  The function returns a `null` value if the account is **not** a subaccount.","enum":[0,1],"example":0,"type":"integer"},"type":{"description":"The type of account.\n\n* `sub` - A subaccount.\n* `hypothetical` - A hypothetical subaccount that does **not** exist, but that the user could create as part of a merge.\n* `service` - A service account.\n* `cpanel` - The cPanel account.","example":"sub","type":"string"},"username":{"description":"The username for the subaccount.\n\n* Length - 64 characters.\n* Characters - `a-z`, `A-Z`, `0-9`, dot (`.`), hyphen (`-`), underscore (`_`).\n\n**Note:**\n\n  This value does **not** include the domain name.","example":"example","type":"string"}},"type":"object"},"SubaccountMergeCandidates":{"properties":{"merge_candidates":{"description":"An array of objects that represents the service accounts that the system could merge for this subaccount.","items":{"allOf":[{"$ref":"#/components/schemas/EditUserSubaccountBase"},{"$ref":"#/components/schemas/SubaccountMergeCandidatesEmpty"}]},"type":"array"}},"type":"object"},"SubaccountMergeCandidatesEmpty":{"properties":{"merge_candidates":{"description":"An array of objects that represents the service accounts that the system could merge for this subaccount.","items":{"type":"object"},"type":"array"}},"type":"object"},"ServiceAccount":{"properties":{"alternate_email":{"description":"An alternate email address for the subaccount's user.","example":"user@example.com","format":"email","nullable":true,"type":"string"},"avatar_url":{"description":"The user's subaccount profile photo.","example":"https://img.example.com/avatars/example.jpg","format":"url","nullable":true,"type":"string"},"can_delete":{"description":"Whether the cPanel account user can delete the subaccount.\n* `1` - Can delete.\n* `0` - Cannot delete.","enum":[0,1],"example":0,"type":"integer"},"can_set_password":{"description":"Whether the cPanel account user can change the subaccount's password.\n* `1` - Can change.\n* `0` - Cannot change.\n\n**Note:**\n\n  The function returns a `0` value for subaccounts that inherit their password from the cPanel account.","enum":[0,1],"example":1,"type":"integer"},"can_set_quota":{"description":"Whether the cPanel account user can change the subaccount's disk usage quota.\n* `1` - Can change.\n* `0` - Cannot change.","enum":[0,1],"example":0,"type":"integer"},"dismissed":{"description":"Whether the cPanel account user dismissed the merge prompt for the service account.\n* `1` - Dismissed.\n* `0` - Did not dismiss.\n\n**Note:**\n\n  Only service accounts return this value.","enum":[0,1],"example":1,"type":"integer"},"domain":{"description":"The subaccount user's associated domain.","example":"example.com","format":"domain","nullable":true,"type":"string"},"full_username":{"description":"The subaccount's username and domain name. A valid username, the `@` character, and the associated domain.","example":"user@example.com","type":"string"},"guid":{"description":"The subaccount unique identifier.","example":"N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4","type":"string"},"has_siblings":{"description":"Whether the service account shares a `full_username` value with another service account.\n* `1` - Shares.\n* `0` - Does not share.","enum":[0,1],"example":0,"type":"integer"},"issues":{"description":"Information about any issues or problems with the subaccount.","items":{"properties":{"area":{"description":"The affected section of cPanel & WHM.","example":"quota","type":"string"},"limit":{"description":"The set quota megabyte (MB) limit for the affected subaccount.","example":1500,"minimum":0,"type":"integer"},"message":{"description":"The description of the issue.","example":"Your account is over quota.","type":"string"},"service":{"description":"The affected service.","enum":["email","ftp","webdisk"],"example":"email","type":"string"},"type":{"description":"The type of issue.","enum":["error","info","warning"],"example":"info","type":"string"},"used":{"description":"The number of megabytes (MB) that the account currently uses.","example":2000,"minimum":0,"type":"integer"}},"type":"object"},"type":"array"},"merge_candidates":{"description":"An array of service account objects that the system could merge for this subaccount.","items":{"$ref":"#/components/schemas/ServiceAccount"},"type":"array"},"parent_type":{"description":"The type of account that could own the service account.\n* `sub` - A subaccount.\n* `hypothetical` - A hypothetical subaccount that does not yet exist, but the user could create as part of a merge.\n* `null` - Not a merge candidate.","enum":["sub","hypothetical"],"example":"hypothetical","nullable":true,"type":"string"},"phone_number":{"description":"The subaccount user's phone number. A valid phone number that conforms to [ITU-T's E.164-recommended standard](https://en.wikipedia.org/wiki/ITU-T) for the representation of telephone numbers.","example":"+15551234567","nullable":true,"type":"string"},"real_name":{"description":"The name of the subaccount's user.\n* A first name, a last name, or a first name and last name.\n* An empty or null string.","example":"John Doe","nullable":true,"type":"string"},"services":{"description":"Information about the subaccount's access to email, FTP, and Web Disk.","properties":{"email":{"description":"Information that indicates the subaccount's email status.","properties":{"enabled":{"description":"Whether the subaccount can access Webmail, POP, and IMAP services.\n* `1` - Can access.\n* `0` - Cannot access.","enum":[0,1],"example":1,"type":"integer"},"quota":{"description":"The maximum amount of disk space allocated to subaccount's email account, in megabytes (MB).","example":100,"minimum":0,"type":"integer"}},"type":"object"},"ftp":{"description":"This object contains the information that indicates the subaccount's FTP status.","properties":{"enabled":{"description":"Whether the subaccount can access FTP.\n* `1` - Can access.\n* `0` - Cannot access.","enum":[0,1],"example":0,"type":"integer"},"homedir":{"description":"The subaccount's FTP home directory, relative to the cPanel account's home directory.","example":"/subaccount","format":"path","type":"string"},"quota":{"description":"The subaccount's FTP disk space quota.\n* `1` to `999999` - The maximum disk space that the subaccount may use, in megabytes (MB).\n* `0` - Unlimited.","example":100,"maximum":999999,"minimum":0,"type":"integer"}},"type":"object"},"special":{"description":"Whether the account is a system-created special account that the user cannot remove.\n* `1` - A special account.\n* `0` - Not a special account.","enum":[0,1],"example":1,"type":"integer"},"webdisk":{"description":"This object contains information that indicates the subaccount's Web Disk status.","properties":{"enabled":{"description":"Whether the subaccount can access Web Disk.\n* `1` - Can access.\n* `0` - Cannot access.","enum":[0,1],"example":0,"type":"integer"},"enabledigest":{"description":"Whether the subaccount's Web Disk service has enabled Digest Authentication.\n* `1` - Digest Authentication is enabled.\n* `0` - Digest Authentication is not enabled.","enum":[0,1],"example":0,"type":"integer"},"homedir":{"description":"The subaccount's Web Disk home directory, relative to the cPanel account's home directory.","example":"/bob","format":"path","type":"string"},"perms":{"description":"Whether to grant write permissions to the subaccount.\n* `ro` - Read-only permissions.\n* `rw` - Read and write permissions.","enum":["ro","rw"],"example":"rw","type":"string"},"private":{"description":"Whether to set the Web Disk directory's permissions to public or private.\n* `1` - Private (0700).\n* `0` - Public (0755).","enum":[0,1],"example":0,"type":"integer"}},"type":"object"}},"type":"object"},"special":{"description":"Whether the account is a system-created special account that the user **cannot** remove.\n* `1` - A special account.\n* `0` - Not a special account.","enum":[0,1],"example":0,"type":"integer"},"sub_account_exists":{"description":"Whether a subaccount exists with the same username.\n* `1` - Exists.\n* `0` - Does not exist.\n\n**Note:**\n\n  The function returns a null value if the account is not a service account.","enum":[0,1],"example":0,"type":"integer"},"synced_password":{"description":"Whether the user has synchronized the passwords for each of the subaccount's service accounts.\n* `1` - Synchronized.\n* `0` - Not synchronized.\n\n**Note:**\n\n  The function returns a null value if the account is not a subaccount.","enum":[0,1],"example":0,"type":"integer"},"type":{"description":"The type of account.\n* `cpanel` - The cPanel account.\n* `hypothetical` - A hypothetical subaccount that does not exist, but that the user could create as part of a merge.\n* `service` - A service account.\n* `sub` - A subaccount.","enum":["cpanel","hypothetical","service","sub"],"example":"sub","type":"string"},"username":{"description":"The username for the subaccount.","example":"example","format":"username","type":"string"}},"type":"object"},"RestoreInProgress":{"properties":{"any_running":{"description":"Whether the system is processing a backup restoration.\n\n* `1` - Restoration in progress. This is the only possible value.","enum":[1],"type":"integer"},"sites":{"description":"Information about the site that the system is actively restoring.\n\n**Note:**\n\nWe have not implemented this return.","items":{"properties":{"id":{"description":"The restore process's unique ID.\n\n* `null` is the only possible value.\n* We have not implemented this return.","enum":[null],"nullable":true,"type":"string"},"site":{"description":"The WordPress site's URL without the protocol prefix.","format":"domain","type":"string"},"type":{"description":"The active process type.\n\n* `restore` is the only possible value.","enum":["restore"],"type":"string"}},"type":"object"},"type":"array"}}},"RestoreNotInProgress":{"properties":{"any_running":{"description":"Whether the system is processing a backup restoration.\n\n* `0` - No restoration in progress. This is the only possible value.","enum":[0],"type":"integer"},"last_outcome":{"description":"The status of the last backup restoration.","properties":{"error":{"description":"Where the system encountered an error during the last backup restoration.\n\n* The error message from the restoration log database.\n* `null` - No occur occurred.","nullable":true,"type":"string"},"have_outcome":{"description":"Whether the restoration log shows a successful attempt previously occurred,\nsuccessfully or unsuccessfully.\n\n* `1` - Restoration attempt occurred.\n* `0` - No restoration attempt occurred.","enum":[0,1],"type":"integer"},"site":{"description":"The WordPress site's URL without the protocol prefix.","format":"domain","type":"string"},"status":{"description":"The previous restoration attempt's result.\n\n* `success` - Successful restoration.\n* `error` - The attempted restoration resulted in an error.\n* `terminated` - The system stopped the restoration process.\n* `timeout` - The restoration process exceeded the allowed time limit.\n* `low-disk` - The server's disk space was insufficient to complete the restoration.\n* `low-quota` - The cPanel account's quota was insufficient to complete the restoration.","enum":["success","error","terminated","timeout","low-disk","low-quota"],"type":"string"}}},"sites":{"description":"Information about the site that the system is actively restoring.\n\n**Note:**\n\n* This function returns an empty array when there is **not** an active\nbackup restoration. This is the only possible value.\n* We have not implemented this return.","type":"object"}}},"Payload":{"description":"The zone’s content.","items":{"discriminator":{"mapping":{"comment":"#/components/schemas/ResponseComment","control":"#/components/schemas/ResponseControl","record":"#/components/schemas/ResponseRR"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/ResponseRR"},{"$ref":"#/components/schemas/ResponseControl"},{"$ref":"#/components/schemas/ResponseComment"}]},"type":"array"},"ResponseBase":{"properties":{"line_index":{"description":"The line’s index in the zone file.","example":22,"minimum":0,"type":"integer"},"type":{"description":"The type of object in the zone file:\n\n* `record` - A resource record.\n* `control` - A control statement.\n* `comment` - A line comment.","enum":["record","control","comment"],"type":"string"}},"type":"object"},"ResponseComment":{"allOf":[{"$ref":"#/components/schemas/ResponseControlOrComment"}],"title":"Comment"},"ResponseControl":{"allOf":[{"$ref":"#/components/schemas/ResponseControlOrComment"}],"title":"Control"},"ResponseControlOrComment":{"allOf":[{"$ref":"#/components/schemas/ResponseBase"},{"properties":{"text_b64":{"description":"The line’s text, encoded to base64.","example":"OyBab25lIGZpbGUgZm9yIHRleGFzLmNvbQ==","format":"base64","type":"string"}},"type":"object"}]},"ResponseRR":{"allOf":[{"$ref":"#/components/schemas/ResponseBase"},{"properties":{"data_b64":{"description":"The resource record’s content, encoded to base64.","items":{"example":"dGV4YXMuY29tLg==","format":"base64","type":"string"},"type":"array"},"dname_b64":{"description":"The resource record’s owner, encoded to base64. A base64-decoded owner that lacks a trailing period (`.`) is a subdomain of the zone.","example":"dGV4YXMuY29tLg==","format":"base64","type":"string"},"record_type":{"description":"The resource record’s type.","example":"MX","type":"string"},"ttl":{"description":"The resource record’s TTL (Time-to-Live).","example":14400,"minimum":0,"type":"integer"}},"type":"object"}],"title":"Resource Record"},"FeatureDescriptions":{"properties":{"features":{"description":"The list of features in a role.","example":["Backup","MySQL® Databases","PHP"],"items":{"type":"string"},"type":"array"},"id":{"description":"The role's ID.","example":"database","type":"string"},"title":{"description":"The role's title.","example":"Database","type":"string"}}},"TeamArray":{"items":{"properties":{"contact-email":{"example":"team_user@example.com","type":"string","format":"email"},"created":{"example":1650036110,"type":"integer","format":"unix_timestamp"},"expire_date":{"example":1674575562,"type":"integer","format":"unix_timestamp"},"expire_reason":{"example":"team user 1 year","type":"string"},"lastlogin":{"example":1650046110,"type":"integer","format":"unix_timestamp"},"locale":{"example":"en","type":"string"},"notes":{"example":"This is a note about team user.","type":"string"},"password":{"example":"encryptedpassword","type":"string"},"roles":{"items":{"example":"email,web","type":"string"},"type":"array"},"secondary-contact-email":{"example":"team_user_backup@example.com","type":"string","format":"email"},"services":{"$ref":"#/components/schemas/Services"},"suspend_date":{"example":1650046210,"type":"integer","format":"unix-timestamp"},"suspend_reason":{"example":"team user is on vacation","type":"string"},"username":{"example":"teamuser","type":"string"}}},"type":"array"},"Services":{"properties":{"email":{"example":"500*2**20","type":"string"},"ftp":{"example":1,"type":"integer"},"webdisk":{"example":"rw","type":"string"}},"type":"object"},"TeamHash":{"properties":{"owner":{"example":"cPanelUser","type":"string"},"users":{"properties":{"username":{"example":"teamuser","type":"string"},"info":{"properties":{"contact-email":{"example":"team_user@example.com","type":"string","format":"email"},"created":{"example":1650036110,"type":"integer","format":"unix_timestamp"},"expire_date":{"example":1674575562,"type":"integer","format":"unix_timestamp"},"expire_reason":{"example":"team user 1 year","type":"string"},"lastlogin":{"example":1650046110,"type":"integer","format":"unix_timestamp"},"locale":{"example":"en","type":"string"},"notes":{"example":"This is a note about team_user.","type":"string"},"password":{"example":"encryptedpassword","type":"string"},"roles":{"items":{"example":"email,web","type":"string"},"type":"array"},"secondary-contact-email":{"example":"team_user_backup@example.com","type":"string","format":"email"},"services":{"$ref":"#/components/schemas/Services"},"suspend_date":{"type":"string"},"suspend_reason":{"example":"teamUser is on vacation","type":"string"}}}}}},"type":"object"}},"securitySchemes":{"BasicAuth":{"scheme":"basic","type":"http"}}},"x-tagGroups":[{"name":"API Development Tools","tags":["API Token Management","Batch","SSE Task Management","URL Parsing"]},{"name":"Authentication","tags":["External Authentication","Two-Factor Settings"]},{"name":"Block Ip Addresses","tags":["Block IP"]},{"name":"Commerce Integration","tags":["Market Integration","SSL Certificates"]},{"name":"Contact Information","tags":["Contact Information"]},{"name":"cPanel Account","tags":["Account Enhancements","Account Information","Account Management","AuditLog","Contact Information","cPanel Features","Disk Quotas","Personalization","Resource Usage and Statistics","Subaccount Management","Team Roles","Team Users"]},{"name":"cPanel Account Backups","tags":["Backup","File Restoration"]},{"name":"cPanel Theme Management","tags":["Application Information","Brand Management","Browser Cache Management","Language","Theme Settings"]},{"name":"Directory Management","tags":["Directory Indexes","Directory Privacy","Directory Protection"]},{"name":"DNS","tags":["DNS","DNS Information","DNS Security","Dynamic DNS","Email DNS Settings"]},{"name":"Domain Management","tags":["Direct Link Protection (Hotlink)","Domain Information","Domain Redirection","SubDomain","Virtual Host Information"]},{"name":"Email","tags":["Email Accounts","Email Filtering","Email Forwarding","Email Server Information","Email Suspensions","Mail Server Information","Mailbox Management","Mailing Lists","Signing and Encryption (GnuPG Keys)","Spam Filtering (Greylisting)","Spam Management","Spam Prevention (BoxTrapper)","Webmail Applications","Webmail Sessions"]},{"name":"Files","tags":["FTP Accounts","FTP Server Settings","Image Tools","Manage Files","WebDisk Settings"]},{"name":"GIT Management","tags":["Deployment Settings","Repository Management"]},{"name":"MySQL and MariaDB","tags":["Database Information","Database Management","Remote Databases","User Management"]},{"name":"Notifications","tags":["Pushbullet"]},{"name":"NVData","tags":["NVData"]},{"name":"Optional Applications","tags":["Antivirus Protection (ClamAV)","Calendar and Contacts (DAV)","Calendar and Contacts Server","cPanel Addons (cPAddons)","WordPress Manager Backups","WordPress Manager Settings"]},{"name":"PostgreSQL","tags":["PostgreSQL Database Management","PostgreSQL User Management"]},{"name":"Retrieve bandwidth information","tags":["Bandwidth"]},{"name":"Security","tags":["Known SSH Hosts Management","Login Information"]},{"name":"Server Information","tags":["cPanel Server Information","Notifications","Password Strength","SSH"]},{"name":"ServiceProxy","tags":["ServiceProxy"]},{"name":"SSL Certificates","tags":["Auto-generated SSL Certificates","cPanel Account SSL Management","SNI Email Settings","SSL Certificate Management","Verify Domain Ownership"]},{"name":"Statistics","tags":["Domain Statistics","Weblog Settings"]},{"name":"Web Server Configuration","tags":["EA4","EasyApache Settings","PHP"]},{"name":"Web Server Management","tags":["Application Manager","ModSecurity","NginxCaching","PHP Settings"]},{"name":"Website Configuration","tags":["Handler Management","Logs","Mime Type Management","Site Information","Site Installation","Site Publisher Management"]}]}},"searchIndex":{"store":["tag/API-Token-Management","tag/API-Token-Management/operation/create_full_access","tag/API-Token-Management/operation/Tokens-list","tag/API-Token-Management/operation/rename","tag/API-Token-Management/operation/revoke","tag/Batch","tag/Batch/operation/strict","tag/SSE-Task-Management","tag/SSE-Task-Management/operation/UserTasks::delete","tag/SSE-Task-Management/operation/retrieve","tag/URL-Parsing","tag/URL-Parsing/operation/fetch_url","tag/URL-Parsing/operation/firstfile_relative_uri","tag/External-Authentication","tag/External-Authentication/operation/add_authn_link","tag/External-Authentication/operation/configured_modules","tag/External-Authentication/operation/has_external_auth_modules_configured","tag/External-Authentication/operation/remove_authn_link","tag/External-Authentication/operation/get_authn_links","tag/Two-Factor-Settings","tag/Two-Factor-Settings/operation/generate_user_configuration","tag/Two-Factor-Settings/operation/get_team_user_configuration","tag/Two-Factor-Settings/operation/get_user_configuration","tag/Two-Factor-Settings/operation/set_user_configuration","tag/Two-Factor-Settings/operation/remove_user_configuration","tag/Block-IP","tag/Block-IP/operation/blockip-add-ip","tag/Block-IP/operation/blockip-remove-ip","tag/Market-Integration","tag/Market-Integration/operation/Market-get_all_products","tag/Market-Integration/operation/create_shopping_cart","tag/Market-Integration/operation/get_login_url","tag/Market-Integration/operation/Market-get_providers_list","tag/Market-Integration/operation/set_status_of_pending_queue_items","tag/Market-Integration/operation/set_url_after_checkout","tag/Market-Integration/operation/validate_login_token","tag/SSL-Certificates","tag/SSL-Certificates/operation/cancel_pending_ssl_certificate","tag/SSL-Certificates/operation/get_certificate_status_details","tag/SSL-Certificates/operation/get_pending_ssl_certificates","tag/SSL-Certificates/operation/get_ssl_certificate_if_available","tag/SSL-Certificates/operation/Market-get_provider_specific_dcv_constraints","tag/SSL-Certificates/operation/request_ssl_certificates","tag/SSL-Certificates/operation/process_ssl_pending_queue","tag/Contact-Information","tag/Contact-Information/operation/contactinformation-unset_email_addresses","tag/Contact-Information/operation/contactinformation-set_email_addresses","tag/Contact-Information/operation/is_enabled","tag/Account-Enhancements","tag/Account-Enhancements/operation/AccountEnhancements-list","tag/Account-Enhancements/operation/AccountEnhancements-has-enhancement","tag/Account-Information","tag/Account-Information/operation/list_accounts","tag/Account-Information/operation/Variables-get_user_information","tag/Account-Management","tag/Account-Management/operation/change_password","tag/AuditLog","tag/Contact-Information","tag/Contact-Information/operation/contactinformation-unset_email_addresses","tag/Contact-Information/operation/contactinformation-set_email_addresses","tag/Contact-Information/operation/is_enabled","tag/cPanel-Features","tag/cPanel-Features/operation/has_feature","tag/cPanel-Features/operation/list_features","tag/cPanel-Features/operation/get_feature_metadata","tag/Disk-Quotas","tag/Disk-Quotas/operation/get_local_quota_info","tag/Disk-Quotas/operation/get_quota_info","tag/Personalization","tag/Personalization/operation/Personalization::get","tag/Personalization/operation/Personalization-set","tag/Resource-Usage-and-Statistics","tag/Resource-Usage-and-Statistics/operation/get_usages","tag/Resource-Usage-and-Statistics/operation/get_stats","tag/Subaccount-Management","tag/Subaccount-Management/operation/UserManager::create_user","tag/Subaccount-Management/operation/UserManager::delete_user","tag/Subaccount-Management/operation/check_account_conflicts","tag/Subaccount-Management/operation/dismiss_merge","tag/Subaccount-Management/operation/lookup_service_account","tag/Subaccount-Management/operation/edit_user","tag/Subaccount-Management/operation/lookup_user","tag/Subaccount-Management/operation/unlink_service_account","tag/Subaccount-Management/operation/merge_service_account","tag/Subaccount-Management/operation/UserManager-list_users","tag/Team-Roles","tag/Team-Roles/operation/list_feature_descriptions","tag/Team-Users","tag/Team-Users/operation/cancel_expire","tag/Team-Users/operation/reinstate_team_user","tag/Team-Users/operation/set_expire","tag/Team-Users/operation/add_roles","tag/Team-Users/operation/password_reset_request","tag/Team-Users/operation/set_team_user_contact_email","tag/Team-Users/operation/set_team_user_password","tag/Team-Users/operation/remove_roles","tag/Team-Users/operation/add_team_user","tag/Team-Users/operation/list_team","tag/Team-Users/operation/suspend_team_user","tag/Team-Users/operation/edit_team_user","tag/Team-Users/operation/set_team_user_notes","tag/Team-Users/operation/Team::set_locale","tag/Team-Users/operation/get_team_users_with_roles_count","tag/Team-Users/operation/set_roles","tag/Team-Users/operation/remove_team_user","tag/Backup","tag/Backup/operation/fullbackup_to_scp_with_password","tag/Backup/operation/fullbackup_to_ftp","tag/Backup/operation/fullbackup_to_homedir","tag/Backup/operation/fullbackup_to_scp_with_key","tag/Backup/operation/list_backups","tag/File-Restoration","tag/File-Restoration/operation/directory_listing","tag/File-Restoration/operation/get_users","tag/File-Restoration/operation/query_file_info","tag/File-Restoration/operation/restore_file","tag/File-Restoration/operation/restore_databases","tag/File-Restoration/operation/restore_email_forwarders","tag/File-Restoration/operation/restore_email_filters","tag/File-Restoration/operation/restore_files","tag/Application-Information","tag/Application-Information/operation/get_applications","tag/Application-Information/operation/get_available_applications","tag/Application-Information/operation/get_information_for_applications","tag/Application-Information/operation/get_application_information","tag/Brand-Management","tag/Brand-Management/operation/get_dom","tag/Browser-Cache-Management","tag/Browser-Cache-Management/operation/update","tag/Browser-Cache-Management/operation/CacheBuster-read","tag/Language","tag/Language/operation/set_locale","tag/Language/operation/list_locales","tag/Language/operation/get_attributes","tag/Theme-Settings","tag/Theme-Settings/operation/get_theme_base","tag/Theme-Settings/operation/Themes::update","tag/Theme-Settings/operation/Themes::list","tag/Directory-Indexes","tag/Directory-Indexes/operation/get_indexing","tag/Directory-Indexes/operation/DirectoryIndexes-list_directories","tag/Directory-Indexes/operation/set_indexing","tag/Directory-Privacy","tag/Directory-Privacy/operation/is_directory_protected","tag/Directory-Privacy/operation/DirectoryPrivacy::list_users","tag/Directory-Privacy/operation/DirectoryPrivacy-list_directories","tag/Directory-Privacy/operation/configure_directory_protection","tag/Directory-Privacy/operation/delete_user","tag/Directory-Privacy/operation/add_user","tag/Directory-Protection","tag/Directory-Protection/operation/DirectoryProtection-list_directories","tag/DNS","tag/DNS/operation/ensure_domains_reside_only_locally","tag/DNS/operation/DNS::is_alias_available","tag/DNS/operation/dns-lookup","tag/DNS/operation/dns-parse_zone","tag/DNS/operation/dns-mass_edit_zone","tag/DNS/operation/DNS-swap_ip_in_zones","tag/DNS/operation/has_local_authority","tag/DNS-Information","tag/DNS-Information/operation/ensure_domains_reside_only_locally","tag/DNS-Information/operation/DNS::is_alias_available","tag/DNS-Information/operation/dns-lookup","tag/DNS-Information/operation/dns-parse_zone","tag/DNS-Information/operation/dns-mass_edit_zone","tag/DNS-Information/operation/has_local_authority","tag/DNS-Security","tag/DNS-Security/operation/unset_nsec3","tag/DNS-Security/operation/export_zone_key","tag/DNS-Security/operation/enable_dnssec","tag/DNS-Security/operation/import_zone_key","tag/DNS-Security/operation/export_zone_dnskey","tag/DNS-Security/operation/fetch_ds_records","tag/DNS-Security/operation/remove_zone_key","tag/DNS-Security/operation/deactivate_zone_key","tag/DNS-Security/operation/disable_dnssec","tag/DNS-Security/operation/add_zone_key","tag/DNS-Security/operation/set_nsec3","tag/DNS-Security/operation/activate_zone_key","tag/Dynamic-DNS","tag/Dynamic-DNS/operation/dynamicdns-create","tag/Dynamic-DNS/operation/dynamicdns-list","tag/Dynamic-DNS/operation/dynamicdns-delete","tag/Dynamic-DNS/operation/dynamicdns-recreate","tag/Dynamic-DNS/operation/dynamicdns-set_description","tag/Email-DNS-Settings","tag/Email-DNS-Settings/operation/add_mx","tag/Email-DNS-Settings/operation/change_mx","tag/Email-DNS-Settings/operation/delete_mx","tag/Email-DNS-Settings/operation/EmailAuth::apply_dmarc","tag/Email-DNS-Settings/operation/EmailAuth::remove_dmarc","tag/Email-DNS-Settings/operation/EmailAuth::validate_current_dmarcs","tag/Email-DNS-Settings/operation/list_mxs","tag/Email-DNS-Settings/operation/enable_dkim","tag/Email-DNS-Settings/operation/ensure_dkim_keys_exist","tag/Email-DNS-Settings/operation/fetch_dkim_private_keys","tag/Email-DNS-Settings/operation/install_dkim_private_keys","tag/Email-DNS-Settings/operation/install_spf_records","tag/Email-DNS-Settings/operation/validate_current_dkims","tag/Email-DNS-Settings/operation/validate_current_ptrs","tag/Email-DNS-Settings/operation/disable_dkim","tag/Email-DNS-Settings/operation/validate_current_spfs","tag/Direct-Link-Protection-(Hotlink)","tag/Direct-Link-Protection-(Hotlink)/operation/delete_hotlink","tag/Direct-Link-Protection-(Hotlink)/operation/add_hotlink","tag/Direct-Link-Protection-(Hotlink)/operation/list_hotlinks","tag/Domain-Information","tag/Domain-Information/operation/domains_data","tag/Domain-Information/operation/list_domains","tag/Domain-Information/operation/single_domain_data","tag/Domain-Information/operation/main_domain_builtin_subdomain_aliases","tag/Domain-Redirection","tag/Domain-Redirection/operation/add_redirect","tag/Domain-Redirection/operation/delete_redirect","tag/Domain-Redirection/operation/get_redirect","tag/Domain-Redirection/operation/list_redirects","tag/SubDomain","tag/SubDomain/operation/addsubdomain","tag/Virtual-Host-Information","tag/Virtual-Host-Information/operation/WebVhosts::list_domains","tag/Virtual-Host-Information/operation/list_ssl_capable_domains","tag/Email-Accounts","tag/Email-Accounts/operation/account_name","tag/Email-Accounts/operation/browse_mailbox","tag/Email-Accounts/operation/add_pop","tag/Email-Accounts/operation/count_auto_responders","tag/Email-Accounts/operation/count_pops","tag/Email-Accounts/operation/delete_held_messages","tag/Email-Accounts/operation/edit_pop_quota","tag/Email-Accounts/operation/dispatch_client_settings","tag/Email-Accounts/operation/hold_outgoing","tag/Email-Accounts/operation/get_auto_responder","tag/Email-Accounts/operation/get_client_settings","tag/Email-Accounts/operation/get_default_email_quota","tag/Email-Accounts/operation/get_disk_usage","tag/Email-Accounts/operation/get_default_email_quota_mib","tag/Email-Accounts/operation/get_main_account_disk_usage","tag/Email-Accounts/operation/get_held_message_count","tag/Email-Accounts/operation/get_main_account_disk_usage_bytes","tag/Email-Accounts/operation/get_max_email_quota","tag/Email-Accounts/operation/get_max_email_quota_mib","tag/Email-Accounts/operation/get_pop_quota","tag/Email-Accounts/operation/get_webmail_settings","tag/Email-Accounts/operation/list_auto_responders","tag/Email-Accounts/operation/list_default_address","tag/Email-Accounts/operation/list_mail_domains","tag/Email-Accounts/operation/list_pops","tag/Email-Accounts/operation/list_pops_with_disk","tag/Email-Accounts/operation/passwd_pop","tag/Email-Accounts/operation/release_outgoing","tag/Email-Accounts/operation/set_default_address","tag/Email-Accounts/operation/trace_delivery","tag/Email-Accounts/operation/verify_password","tag/Email-Accounts/operation/delete_auto_responder","tag/Email-Accounts/operation/delete_pop","tag/Email-Accounts/operation/add_auto_responder","tag/Email-Accounts/operation/CSVImport::doimport","tag/Email-Accounts/operation/set_manual_mx_redirects","tag/Email-Accounts/operation/unset_manual_mx_redirects","tag/Email-Accounts/operation/email-terminate_mailbox_sessions","tag/Email-Filtering","tag/Email-Filtering/operation/count_filters","tag/Email-Filtering/operation/disable_filter","tag/Email-Filtering/operation/enable_filter","tag/Email-Filtering/operation/get_filter","tag/Email-Filtering/operation/list_filters","tag/Email-Filtering/operation/list_filters_backups","tag/Email-Filtering/operation/list_system_filter_info","tag/Email-Filtering/operation/reorder_filters","tag/Email-Filtering/operation/store_filter","tag/Email-Filtering/operation/trace_filter","tag/Email-Filtering/operation/delete_filter","tag/Email-Forwarding","tag/Email-Forwarding/operation/add_domain_forwarder","tag/Email-Forwarding/operation/add_forwarder","tag/Email-Forwarding/operation/delete_domain_forwarder","tag/Email-Forwarding/operation/count_forwarders","tag/Email-Forwarding/operation/delete_forwarder","tag/Email-Forwarding/operation/list_domain_forwarders","tag/Email-Forwarding/operation/list_forwarders","tag/Email-Forwarding/operation/list_forwarders_backups","tag/Email-Server-Information","tag/Email-Server-Information/operation/check_fastmail","tag/Email-Server-Information/operation/disable_mailbox_autocreate","tag/Email-Server-Information/operation/enable_mailbox_autocreate","tag/Email-Server-Information/operation/fetch_charmaps","tag/Email-Server-Information/operation/fts_rescan_mailbox","tag/Email-Server-Information/operation/get_charsets","tag/Email-Server-Information/operation/get_mailbox_autocreate","tag/Email-Server-Information/operation/has_plaintext_authentication","tag/Email-Server-Information/operation/set_always_accept","tag/Email-Server-Information/operation/stats_db_status","tag/Email-Suspensions","tag/Email-Suspensions/operation/suspend_incoming","tag/Email-Suspensions/operation/suspend_login","tag/Email-Suspensions/operation/unsuspend_login","tag/Email-Suspensions/operation/suspend_outgoing","tag/Email-Suspensions/operation/unsuspend_incoming","tag/Email-Suspensions/operation/unsuspend_outgoing","tag/Mail-Server-Information","tag/Mail-Server-Information/operation/get_exim_ports_ssl","tag/Mail-Server-Information/operation/get_exim_ports","tag/Mailbox-Management","tag/Mailbox-Management/operation/get_mailbox_status_list","tag/Mailbox-Management/operation/expunge_mailbox_messages","tag/Mailbox-Management/operation/expunge_messages_for_mailbox_guid","tag/Mailbox-Management/operation/has_utf8_mailbox_names","tag/Mailbox-Management/operation/set_utf8_mailbox_names","tag/Mailing-Lists","tag/Mailing-Lists/operation/add_mailman_delegates","tag/Mailing-Lists/operation/count_lists","tag/Mailing-Lists/operation/export_lists","tag/Mailing-Lists/operation/delete_list","tag/Mailing-Lists/operation/generate_mailman_otp","tag/Mailing-Lists/operation/get_lists_total_disk_usage","tag/Mailing-Lists/operation/get_mailman_delegates","tag/Mailing-Lists/operation/passwd_list","tag/Mailing-Lists/operation/has_delegated_mailman_lists","tag/Mailing-Lists/operation/list_lists","tag/Mailing-Lists/operation/remove_mailman_delegates","tag/Mailing-Lists/operation/set_list_privacy_options","tag/Mailing-Lists/operation/add_list","tag/Signing-and-Encryption-(GnuPG-Keys)","tag/Signing-and-Encryption-(GnuPG-Keys)/operation/delete_keypair","tag/Signing-and-Encryption-(GnuPG-Keys)/operation/export_public_key","tag/Signing-and-Encryption-(GnuPG-Keys)/operation/export_secret_key","tag/Signing-and-Encryption-(GnuPG-Keys)/operation/import_key","tag/Signing-and-Encryption-(GnuPG-Keys)/operation/list_public_keys","tag/Signing-and-Encryption-(GnuPG-Keys)/operation/list_secret_keys","tag/Signing-and-Encryption-(GnuPG-Keys)/operation/generate_key","tag/Spam-Filtering-(Greylisting)","tag/Spam-Filtering-(Greylisting)/operation/has_greylisting_enabled","tag/Spam-Filtering-(Greylisting)/operation/cPGreyList-enable_all_domains","tag/Spam-Filtering-(Greylisting)/operation/cPGreyList-disable_all_domains","tag/Spam-Filtering-(Greylisting)/operation/cPGreyList-disable_domains","tag/Spam-Filtering-(Greylisting)/operation/cPGreyList::list_domains","tag/Spam-Filtering-(Greylisting)/operation/cPGreyList-enable_domains","tag/Spam-Management","tag/Spam-Management/operation/disable_spam_assassin","tag/Spam-Management/operation/disable_spam_autodelete","tag/Spam-Management/operation/disable_spam_box","tag/Spam-Management/operation/enable_spam_box","tag/Spam-Management/operation/enable_spam_assassin","tag/Spam-Management/operation/get_spam_settings","tag/Spam-Management/operation/clear_spam_box","tag/Spam-Management/operation/get_symbolic_test_names","tag/Spam-Management/operation/update_user_preference","tag/Spam-Management/operation/get_user_preferences","tag/Spam-Management/operation/add_spam_filter","tag/Spam-Prevention-(BoxTrapper)","tag/Spam-Prevention-(BoxTrapper)/operation/set_status","tag/Spam-Prevention-(BoxTrapper)/operation/blacklist_messages","tag/Spam-Prevention-(BoxTrapper)/operation/deliver_messages","tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::get_blocklist","tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::get_ignorelist","tag/Spam-Prevention-(BoxTrapper)/operation/get_message","tag/Spam-Prevention-(BoxTrapper)/operation/get_email_template","tag/Spam-Prevention-(BoxTrapper)/operation/ignore_messages","tag/Spam-Prevention-(BoxTrapper)/operation/reset_email_template","tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::set_ignorelist","tag/Spam-Prevention-(BoxTrapper)/operation/save_email_template","tag/Spam-Prevention-(BoxTrapper)/operation/list_queued_messages","tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::set_blocklist","tag/Spam-Prevention-(BoxTrapper)/operation/whitelist_messages","tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::get_allowlist","tag/Spam-Prevention-(BoxTrapper)/operation/get_configuration","tag/Spam-Prevention-(BoxTrapper)/operation/get_forwarders","tag/Spam-Prevention-(BoxTrapper)/operation/get_log","tag/Spam-Prevention-(BoxTrapper)/operation/get_status","tag/Spam-Prevention-(BoxTrapper)/operation/delete_messages","tag/Spam-Prevention-(BoxTrapper)/operation/list_email_templates","tag/Spam-Prevention-(BoxTrapper)/operation/save_configuration","tag/Spam-Prevention-(BoxTrapper)/operation/set_forwarders","tag/Spam-Prevention-(BoxTrapper)/operation/BoxTrapper::set_allowlist","tag/Spam-Prevention-(BoxTrapper)/operation/process_messages","tag/Webmail-Applications","tag/Webmail-Applications/operation/list_webmail_apps","tag/Webmail-Sessions","tag/Webmail-Sessions/operation/create_webmail_session_for_mail_user_check_password","tag/Webmail-Sessions/operation/create_webmail_session_for_self","tag/Webmail-Sessions/operation/create_webmail_session_for_mail_user","tag/Webmail-Sessions/operation/create_temp_user","tag/FTP-Accounts","tag/FTP-Accounts/operation/add_ftp","tag/FTP-Accounts/operation/delete_ftp","tag/FTP-Accounts/operation/ftp_exists","tag/FTP-Accounts/operation/get_quota","tag/FTP-Accounts/operation/get_welcome_message","tag/FTP-Accounts/operation/list_ftp_with_disk","tag/FTP-Accounts/operation/passwd","tag/FTP-Accounts/operation/set_homedir","tag/FTP-Accounts/operation/set_quota","tag/FTP-Accounts/operation/list_ftp","tag/FTP-Accounts/operation/set_welcome_message","tag/FTP-Server-Settings","tag/FTP-Server-Settings/operation/allows_anonymous_ftp","tag/FTP-Server-Settings/operation/allows_anonymous_ftp_incoming","tag/FTP-Server-Settings/operation/get_ftp_daemon_info","tag/FTP-Server-Settings/operation/get_port","tag/FTP-Server-Settings/operation/kill_session","tag/FTP-Server-Settings/operation/list_sessions","tag/FTP-Server-Settings/operation/set_anonymous_ftp","tag/FTP-Server-Settings/operation/server_name","tag/FTP-Server-Settings/operation/set_anonymous_ftp_incoming","tag/Image-Tools","tag/Image-Tools/operation/convert_file","tag/Image-Tools/operation/create_thumbnails","tag/Image-Tools/operation/get_dimensions","tag/Image-Tools/operation/resize_image","tag/Manage-Files","tag/Manage-Files/operation/autocompletedir","tag/Manage-Files/operation/empty_trash","tag/Manage-Files/operation/get_file_content","tag/Manage-Files/operation/get_file_information","tag/Manage-Files/operation/transcode","tag/Manage-Files/operation/list_files","tag/Manage-Files/operation/save_file_content","tag/Manage-Files/operation/upload_files","tag/WebDisk-Settings","tag/WebDisk-Settings/operation/WebDisk::delete_user","tag/WebDisk-Settings/operation/WebDisk::set_password","tag/WebDisk-Settings/operation/WebDisk::set_homedir","tag/WebDisk-Settings/operation/set_permissions","tag/Deployment-Settings","tag/Deployment-Settings/operation/VersionControlDeployment::create","tag/Deployment-Settings/operation/delete","tag/Deployment-Settings/operation/VersionControlDeployment::retrieve","tag/Repository-Management","tag/Repository-Management/operation/VersionControl::create","tag/Repository-Management/operation/VersionControl::update","tag/Repository-Management/operation/VersionControl::delete","tag/Repository-Management/operation/VersionControl::retrieve","tag/Database-Information","tag/Database-Information/operation/get_server_information","tag/Database-Information/operation/locate_server","tag/Database-Management","tag/Database-Management/operation/Mysql-update_privileges","tag/Database-Management/operation/Mysql-check_database","tag/Database-Management/operation/create_database","tag/Database-Management/operation/dump_database_schema","tag/Database-Management/operation/delete_database","tag/Database-Management/operation/list_databases","tag/Database-Management/operation/Mysql-rename_database","tag/Database-Management/operation/repair_database","tag/Database-Management/operation/setup_db_and_user","tag/Remote-Databases","tag/Remote-Databases/operation/Mysql-add_host_note","tag/Remote-Databases/operation/add_host","tag/Remote-Databases/operation/get_host_notes","tag/Remote-Databases/operation/delete_host","tag/User-Management","tag/User-Management/operation/Mysql-create_user","tag/User-Management/operation/Mysql::delete_user","tag/User-Management/operation/get_restrictions","tag/User-Management/operation/list_routines","tag/User-Management/operation/Mysql-list_users","tag/User-Management/operation/rename_user","tag/User-Management/operation/Mysql-get_privileges_on_database","tag/User-Management/operation/revoke_access_to_database","tag/User-Management/operation/set_privileges_on_database","tag/User-Management/operation/Mysql-set_password","tag/Pushbullet","tag/Pushbullet/operation/send_test_message","tag/NVData","tag/Antivirus-Protection-(ClamAV)","tag/Antivirus-Protection-(ClamAV)/operation/ClamScanner::get_scan_paths","tag/Antivirus-Protection-(ClamAV)/operation/ClamScanner::start_scan","tag/Antivirus-Protection-(ClamAV)/operation/ClamScanner::list_infected_files","tag/Antivirus-Protection-(ClamAV)/operation/ClamScanner::get_scan_status","tag/Antivirus-Protection-(ClamAV)/operation/disinfect_files","tag/Antivirus-Protection-(ClamAV)/operation/ClamScanner::check_disinfection_status","tag/Calendar-and-Contacts-(DAV)","tag/Calendar-and-Contacts-(DAV)/operation/enable_shared_global_addressbook","tag/Calendar-and-Contacts-(DAV)/operation/has_shared_global_addressbook","tag/Calendar-and-Contacts-(DAV)/operation/disable_shared_global_addressbook","tag/Calendar-and-Contacts-(DAV)/operation/get_calendar_contacts_config","tag/Calendar-and-Contacts-(DAV)/operation/is_dav_service_enabled","tag/Calendar-and-Contacts-(DAV)/operation/is_horde_enabled","tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_add_delegate","tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_list_delegates","tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_list_users","tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_manage_collection","tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_remove_delegate","tag/Calendar-and-Contacts-(DAV)/operation/CPDAVD_update_delegate","tag/Calendar-and-Contacts-Server","tag/Calendar-and-Contacts-Server/operation/remove_delegate","tag/Calendar-and-Contacts-Server/operation/list_users","tag/Calendar-and-Contacts-Server/operation/update_delegate","tag/Calendar-and-Contacts-Server/operation/add_delegate","tag/Calendar-and-Contacts-Server/operation/list_delegates","tag/cPanel-Addons-(cPAddons)","tag/cPanel-Addons-(cPAddons)/operation/get_available_addons","tag/cPanel-Addons-(cPAddons)/operation/get_instance_settings","tag/cPanel-Addons-(cPAddons)/operation/list_addon_instances","tag/WordPress-Manager-Backups","tag/WordPress-Manager-Backups/operation/cancel","tag/WordPress-Manager-Backups/operation/any_running","tag/WordPress-Manager-Backups/operation/cleanup","tag/WordPress-Manager-Backups/operation/get_available_backups","tag/WordPress-Manager-Backups/operation/is_running","tag/WordPress-Manager-Backups/operation/start","tag/WordPress-Manager-Backups/operation/WordPressRestore-start","tag/WordPress-Manager-Backups/operation/WordPressRestore::any_running","tag/WordPress-Manager-Backups/operation/WordPressRestore-cleanup","tag/WordPress-Manager-Settings","tag/WordPress-Manager-Settings/operation/change_admin_password","tag/WordPress-Manager-Settings/operation/cleanup_scan","tag/WordPress-Manager-Settings/operation/configure_autoupdate","tag/WordPress-Manager-Settings/operation/get_api_version","tag/WordPress-Manager-Settings/operation/get_instances","tag/WordPress-Manager-Settings/operation/get_latest_wordpress_version_from_wordpress_org","tag/WordPress-Manager-Settings/operation/get_instance_by_id","tag/WordPress-Manager-Settings/operation/get_scan_results","tag/WordPress-Manager-Settings/operation/is_installable_addon_available","tag/WordPress-Manager-Settings/operation/WordPressInstanceManager-start_scan","tag/WordPress-Manager-Settings/operation/cancel_scan","tag/PostgreSQL-Database-Management","tag/PostgreSQL-Database-Management/operation/Postgresql::create_database","tag/PostgreSQL-Database-Management/operation/Postgresql::get_restrictions","tag/PostgreSQL-Database-Management/operation/Postgresql::delete_database","tag/PostgreSQL-Database-Management/operation/Postgresql-list_databases","tag/PostgreSQL-Database-Management/operation/rename_database","tag/PostgreSQL-User-Management","tag/PostgreSQL-User-Management/operation/Postgresql-update_privileges","tag/PostgreSQL-User-Management/operation/create_user","tag/PostgreSQL-User-Management/operation/Postgresql::delete_user","tag/PostgreSQL-User-Management/operation/grant_all_privileges","tag/PostgreSQL-User-Management/operation/Postgresql::list_users","tag/PostgreSQL-User-Management/operation/rename_user_no_password","tag/PostgreSQL-User-Management/operation/revoke_all_privileges","tag/PostgreSQL-User-Management/operation/set_password","tag/PostgreSQL-User-Management/operation/Postgresql::rename_user","tag/Bandwidth","tag/Bandwidth/operation/get_enabled_protocols","tag/Bandwidth/operation/query","tag/Bandwidth/operation/get_retention_periods","tag/Known-SSH-Hosts-Management","tag/Known-SSH-Hosts-Management/operation/create","tag/Known-SSH-Hosts-Management/operation/KnownHosts::delete","tag/Known-SSH-Hosts-Management/operation/KnownHosts::update","tag/Known-SSH-Hosts-Management/operation/verify","tag/Login-Information","tag/Login-Information/operation/get_last_or_current_logged_in_ip","tag/Login-Information/operation/get_session_information","tag/cPanel-Server-Information","tag/cPanel-Server-Information/operation/get_information","tag/cPanel-Server-Information/operation/Variables-get_server_information","tag/Notifications","tag/Notifications/operation/get_notifications_count","tag/Password-Strength","tag/Password-Strength/operation/get_required_strength","tag/SSH","tag/SSH/operation/SSH-get_port","tag/ServiceProxy","tag/ServiceProxy/operation/serviceproxy-get_service_proxy_backends","tag/ServiceProxy/operation/serviceproxy-unset_all_service_proxy_backends","tag/ServiceProxy/operation/serviceproxy-set_service_proxy_backends","tag/Auto-generated-SSL-Certificates","tag/Auto-generated-SSL-Certificates/operation/add_autossl_excluded_domains","tag/Auto-generated-SSL-Certificates/operation/get_autossl_excluded_domains","tag/Auto-generated-SSL-Certificates/operation/get_autossl_problems","tag/Auto-generated-SSL-Certificates/operation/is_autossl_check_in_progress","tag/Auto-generated-SSL-Certificates/operation/remove_autossl_excluded_domains","tag/Auto-generated-SSL-Certificates/operation/set_autossl_excluded_domains","tag/Auto-generated-SSL-Certificates/operation/start_autossl_check","tag/cPanel-Account-SSL-Management","tag/cPanel-Account-SSL-Management/operation/can_ssl_redirect","tag/cPanel-Account-SSL-Management/operation/delete_ssl","tag/cPanel-Account-SSL-Management/operation/check_shared_cert","tag/cPanel-Account-SSL-Management/operation/fetch_best_for_domain","tag/cPanel-Account-SSL-Management/operation/fetch_cert_info","tag/cPanel-Account-SSL-Management/operation/fetch_certificates_for_fqdns","tag/cPanel-Account-SSL-Management/operation/find_certificates_for_key","tag/cPanel-Account-SSL-Management/operation/fetch_key_and_cabundle_for_certificate","tag/cPanel-Account-SSL-Management/operation/find_csrs_for_key","tag/cPanel-Account-SSL-Management/operation/get_cabundle","tag/cPanel-Account-SSL-Management/operation/get_cn_name","tag/cPanel-Account-SSL-Management/operation/installed_host","tag/cPanel-Account-SSL-Management/operation/installed_hosts","tag/cPanel-Account-SSL-Management/operation/list_certs","tag/cPanel-Account-SSL-Management/operation/list_keys","tag/cPanel-Account-SSL-Management/operation/list_ssl_items","tag/cPanel-Account-SSL-Management/operation/list_csrs","tag/cPanel-Account-SSL-Management/operation/rebuildssldb","tag/cPanel-Account-SSL-Management/operation/toggle_ssl_redirect_for_domains","tag/cPanel-Account-SSL-Management/operation/SSL::set_default_key_type","tag/SNI-Email-Settings","tag/SNI-Email-Settings/operation/enable_mail_sni","tag/SNI-Email-Settings/operation/disable_mail_sni","tag/SNI-Email-Settings/operation/is_mail_sni_supported","tag/SNI-Email-Settings/operation/is_sni_supported","tag/SNI-Email-Settings/operation/mail_sni_status","tag/SNI-Email-Settings/operation/rebuild_mail_sni_config","tag/SSL-Certificate-Management","tag/SSL-Certificate-Management/operation/install_ssl","tag/SSL-Certificate-Management/operation/delete_csr","tag/SSL-Certificate-Management/operation/delete_key","tag/SSL-Certificate-Management/operation/delete_cert","tag/SSL-Certificate-Management/operation/generate_cert","tag/SSL-Certificate-Management/operation/SSL-generate_key","tag/SSL-Certificate-Management/operation/generate_csr","tag/SSL-Certificate-Management/operation/set_cert_friendly_name","tag/SSL-Certificate-Management/operation/set_csr_friendly_name","tag/SSL-Certificate-Management/operation/set_key_friendly_name","tag/SSL-Certificate-Management/operation/set_primary_ssl","tag/SSL-Certificate-Management/operation/show_cert","tag/SSL-Certificate-Management/operation/show_key","tag/SSL-Certificate-Management/operation/show_csr","tag/SSL-Certificate-Management/operation/upload_cert","tag/SSL-Certificate-Management/operation/upload_key","tag/Verify-Domain-Ownership","tag/Verify-Domain-Ownership/operation/check_domains_via_dns","tag/Verify-Domain-Ownership/operation/check_domains_via_http","tag/Verify-Domain-Ownership/operation/ensure_domains_can_pass_dcv","tag/Domain-Statistics","tag/Domain-Statistics/operation/get_site_errors","tag/Domain-Statistics/operation/get_bandwidth","tag/Domain-Statistics/operation/list_sites","tag/Domain-Statistics/operation/list_stats_by_domain","tag/Weblog-Settings","tag/Weblog-Settings/operation/stats_manager_get_configuration","tag/Weblog-Settings/operation/stats_manager_save_configuration","tag/EA4","tag/EA4/operation/get_recommendations","tag/EasyApache-Settings","tag/PHP","tag/PHP/operation/EA4::get_php_recommendations","tag/Application-Manager","tag/Application-Manager/operation/edit_application","tag/Application-Manager/operation/disable_application","tag/Application-Manager/operation/enable_application","tag/Application-Manager/operation/list_applications","tag/Application-Manager/operation/ensure_deps","tag/Application-Manager/operation/register_application","tag/Application-Manager/operation/unregister_application","tag/ModSecurity","tag/ModSecurity/operation/disable_all_domains","tag/ModSecurity/operation/disable_domains","tag/ModSecurity/operation/enable_all_domains","tag/ModSecurity/operation/enable_domains","tag/ModSecurity/operation/has_modsecurity_installed","tag/ModSecurity/operation/ModSecurity-list_domains","tag/NginxCaching","tag/NginxCaching/operation/enable_cache","tag/NginxCaching/operation/clear_cache","tag/NginxCaching/operation/reset_cache_config","tag/NginxCaching/operation/disable_cache","tag/PHP-Settings","tag/PHP-Settings/operation/php_get_domain_handler","tag/PHP-Settings/operation/php_get_impacted_domains","tag/PHP-Settings/operation/php_get_installed_versions","tag/PHP-Settings/operation/php_ini_get_user_content","tag/PHP-Settings/operation/php_get_system_default_version","tag/PHP-Settings/operation/php_ini_get_user_basic_directives","tag/PHP-Settings/operation/php_ini_get_user_paths","tag/PHP-Settings/operation/php_ini_set_user_basic_directives","tag/PHP-Settings/operation/php_ini_set_user_content","tag/PHP-Settings/operation/php_set_vhost_versions","tag/PHP-Settings/operation/php_get_vhost_versions","tag/Handler-Management","tag/Handler-Management/operation/add_handler","tag/Handler-Management/operation/delete_handler","tag/Handler-Management/operation/list_handlers","tag/Handler-Management/operation/redirect_info","tag/Logs","tag/Logs/operation/LogManager_delete_archive","tag/Logs/operation/LogManager_get_settings","tag/Logs/operation/LogManager_list_archives","tag/Logs/operation/LogManager_set_settings","tag/Mime-Type-Management","tag/Mime-Type-Management/operation/add_mime","tag/Mime-Type-Management/operation/delete_mime","tag/Mime-Type-Management/operation/list_mime","tag/Site-Information","tag/Site-Information/operation/WordPressSite::retrieve","tag/Site-Installation","tag/Site-Installation/operation/WordPressSite::create","tag/Site-Publisher-Management","tag/Site-Publisher-Management/operation/list_site_templates","tag/Site-Publisher-Management/operation/publish","tag/Site-Publisher-Management/operation/list_user_settings"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,2.86,1,4.151,2,2.63]],["description/0",[0,4.26,1,4.966,2,3.147,3,6.7,4,6.209,5,1.874]],["title/1",[0,2.568,1,3.727,6,2.103,7,1.113]],["description/1",[0,2.174,1,5.345,6,1.78,7,0.942,8,0.142,9,2.892,10,3.945,11,4.158,12,1.216,13,5.345,14,1.339,15,4.086,16,1.005,17,3.265,18,0.617,19,1.558,20,5.188,21,5.188,22,5.188]],["title/2",[0,2.568,1,3.727,7,1.113,23,0.741]],["description/2",[0,3.321,1,4.821,7,1.439,8,0.218,12,1.858,23,0.958,24,1.992,25,7.926]],["title/3",[0,2.33,7,1.01,26,1.953,27,5.561,28,2.918]],["description/3",[0,3.321,1,4.821,7,1.439,8,0.218,12,1.858,29,6.027,30,4.068,31,7.926]],["title/4",[0,2.568,1,3.727,7,1.113,32,2.587]],["description/4",[0,3.422,1,4.966,7,1.483,8,0.224,16,1.581,32,3.447,33,8.166]],["title/5",[34,7.247]],["description/5",[34,7.621,35,5.319,36,3.981]],["title/6",[8,0.153,36,2.384,37,2.918,38,3.884,39,3.278]],["description/6",[5,1.491,8,0.272,14,1.106,24,1.633,34,3.514,36,1.836,37,2.247,38,2.991,39,2.525,40,4.283,41,4.081,42,3.514,43,2.799,44,4.283,45,4.283,46,3.257,47,3.926,48,3.069,49,2.799,50,1.333,51,2.921,52,2.991,53,3.514,54,4.283,55,3.69,56,3.374,57,4.283]],["title/7",[2,2.63,58,5.88,59,4.375]],["description/7",[0,3.422,2,3.147,3,6.7,4,6.209,5,1.874,58,7.035,59,5.234]],["title/8",[32,2.587,59,3.928,60,4.517,61,3.216]],["description/8",[5,1.909,7,0.961,8,0.145,16,0.638,17,2.072,19,0.989,39,1.941,50,1.647,59,4.869,61,3.986,62,1.191,63,3.53,64,2.368,65,1.912,66,2.701,67,2.593,68,1.747,69,3.017,70,2.426,71,0.937,72,3.119,73,2.949,74,3.017,75,2.036,76,1.86,77,2.151,78,3.017,79,2.072,80,2.002,81,3.017,82,1.411,83,0.937,84,1.468,85,3.017,86,1.445,87,3.292]],["title/9",[23,0.741,59,3.928,61,3.216,83,1.744]],["description/9",[5,1.886,7,1.185,8,0.142,12,0.753,16,0.622,17,2.022,19,0.965,39,1.894,50,1.615,59,4.801,61,3.93,63,2.144,64,2.34,65,1.867,66,2.637,67,2.531,68,1.706,69,2.946,70,2.369,71,0.915,72,3.059,73,2.893,74,2.946,75,1.987,76,1.815,77,2.1,78,2.946,79,2.022,80,1.954,81,2.946,82,1.378,83,1.477,84,1.433,85,2.946,86,1.41,88,1.116,89,3.214]],["title/10",[90,4.35,91,5.855]],["description/10",[0,3.528,3,6.909,4,6.403,5,1.932,90,4.757,91,6.403]],["title/11",[23,0.741,90,3.462,92,4.66,93,2.932]],["description/11",[8,0.231,23,1.018,90,4.757,92,6.403,93,4.028,94,8.42]],["title/12",[23,0.741,95,3.462,96,5.617,97,5.617]],["description/12",[7,1.359,8,0.206,96,6.862,97,6.862,98,4.995,99,5.693,100,6.862,101,6.862,102,2.964,103,7.487]],["title/13",[104,5.032,105,3.995]],["description/13",[5,2.06,104,5.869,105,5.59]],["title/14",[104,4.005,105,3.18,106,2.853,107,3.928]],["description/14",[8,0.218,16,1.535,104,5.18,105,4.113,106,3.69,107,5.08,108,6.027,109,7.926]],["title/15",[23,0.672,104,3.634,105,2.885,110,3.278,111,3.185]],["description/15",[8,0.19,24,1.737,35,3.959,83,1.967,104,4.518,105,3.587,110,4.075,111,3.959,112,5.095,113,3.51,114,2.4,115,6.336,116,6.913]],["title/16",[23,0.672,64,1.583,104,3.634,105,2.885,117,2.612]],["description/16",[8,0.211,35,4.41,64,2.192,104,5.033,105,3.995,118,5.675,119,3.091,120,2.613,121,7.701]],["title/17",[32,2.587,104,4.005,105,3.18,107,3.928]],["description/17",[8,0.211,16,1.491,32,3.251,104,5.033,105,3.995,107,4.936,111,4.41,115,7.058,122,7.701]],["title/18",[23,0.741,104,4.005,105,3.18,107,3.928]],["description/18",[7,1.398,8,0.211,16,1.491,24,1.935,104,5.033,105,3.995,107,4.936,123,4.186,124,7.701]],["title/19",[125,5.675,126,2.245]],["description/19",[5,2.06,105,4.659,125,6.618,126,2.619]],["title/20",[6,2.103,105,3.18,127,4.828,128,5.028]],["description/20",[8,0.211,105,5.083,114,2.673,120,2.613,125,5.675,128,6.318,129,5.137,130,7.701]],["title/21",[23,0.672,64,1.583,127,4.38,131,2.612,132,4.563]],["description/21",[8,0.211,88,2.673,105,3.995,114,2.673,125,5.675,126,2.245,131,3.617,133,7.701,134,7.701]],["title/22",[7,1.01,16,1.077,23,0.672,127,4.38,132,4.563]],["description/22",[7,1.359,8,0.206,16,1.45,88,2.599,105,3.885,114,2.599,125,5.518,126,2.183,135,3.312,136,7.487]],["title/23",[127,5.376,132,5.6,137,4.295]],["description/23",[8,0.224,16,1.581,105,4.237,114,2.835,125,6.018,126,2.381,138,8.166]],["title/24",[32,2.881,127,5.376,132,5.6]],["description/24",[8,0.218,19,2.381,32,3.346,64,2.256,105,4.113,125,5.842,139,7.926,140,7.926]],["title/25",[141,5.855,142,4.683]],["description/25",[5,1.932,141,7.878,142,6.301,143,3.477]],["title/26",[7,0.852,12,1.1,24,1.179,106,2.184,141,3.568,142,2.854,143,1.937]],["description/26",[7,1.139,8,0.235,11,2.709,16,1.214,18,1.017,71,1.785,141,4.768,142,3.814,143,2.589,144,1.528,145,0.83,146,2.116,147,2.668,148,0.78,149,6.271]],["title/27",[7,0.852,12,1.1,24,1.179,32,1.981,141,3.568,142,2.854,143,1.937]],["description/27",[7,1.139,8,0.235,11,2.709,16,1.214,18,1.017,71,1.785,142,3.814,143,2.589,144,1.528,145,0.83,146,2.116,147,2.668,148,0.78,150,6.271,151,6.271]],["title/28",[92,5.855,152,5.252]],["description/28",[5,1.994,92,8.032,152,5.927,153,7.966]],["title/29",[23,0.741,113,3.112,154,4.517,155,5.28]],["description/29",[7,1.359,8,0.206,24,1.882,111,4.288,113,3.802,120,2.541,152,5.106,155,6.451,156,6.451,157,7.487]],["title/30",[6,2.342,158,6.256,159,6.256]],["description/30",[6,1.969,7,1.042,8,0.221,39,4.743,148,1.001,158,7.375,159,7.375,160,4.486,161,4.52,162,5.739,163,2.319,164,2.169,165,5.739,166,5.739,167,5.739]],["title/31",[23,0.741,90,3.462,154,4.517,168,3.857]],["description/31",[7,1.439,8,0.218,88,2.752,90,4.478,111,4.539,152,5.406,168,4.988,169,7.926]],["title/32",[23,0.825,111,3.909,120,2.316]],["description/32",[7,1.439,8,0.218,24,1.992,28,4.159,111,4.539,120,2.69,152,5.406,170,7.926]],["title/33",[26,1.953,60,4.099,61,2.918,117,2.612,171,4.099]],["description/33",[7,1.359,8,0.206,60,7.092,61,3.928,117,3.517,126,2.183,152,5.106,171,5.518,172,7.487]],["title/34",[26,2.397,90,3.856,173,6.825]],["description/34",[8,0.211,26,2.705,64,2.192,90,4.35,111,4.41,160,4.293,174,3.585,175,7.058,176,7.701]],["title/35",[1,4.151,168,4.295,177,3.541]],["description/35",[1,5.75,7,1.323,8,0.2,11,3.147,23,0.881,111,4.172,152,4.969,168,4.585,177,3.78,178,7.285]],["title/36",[163,3.112,164,2.91]],["description/36",[5,1.994,92,6.609,153,7.966,163,3.513,164,3.285]],["title/37",[39,4.539,62,2.786]],["description/37",[8,0.218,32,3.346,39,4.672,164,2.996,171,5.842,179,6.503,180,7.265,181,7.926]],["title/38",[23,0.615,117,2.391,154,3.751,163,2.057,164,1.924,182,2.612]],["description/38",[8,0.206,23,1.163,63,3.461,64,1.477,65,3.013,90,2.931,93,2.482,117,2.437,145,0.686,163,2.097,164,1.961,177,2.692,182,2.662,183,3.208,184,3.461,185,5.188,186,3.058,187,3.325,188,5.188,189,4.755,190,5.188,191,5.188]],["title/39",[23,0.672,154,4.099,163,2.248,164,2.102,171,4.099]],["description/39",[7,1.288,8,0.195,24,1.783,111,4.063,123,3.856,148,0.883,152,4.838,163,2.867,164,2.681,171,5.228,180,6.502,192,7.094]],["title/40",[23,0.672,113,2.824,154,4.099,163,2.248,164,2.102]],["description/40",[7,1.398,8,0.211,88,2.673,111,4.41,113,3.91,152,5.252,163,3.112,164,2.91,193,7.701]],["title/41",[23,0.672,154,4.099,194,4.38,195,4.099,196,3.439]],["description/41",[8,0.2,23,0.881,77,4.761,144,1.775,154,5.369,174,3.391,177,3.78,194,5.739,195,5.369,196,4.505,197,7.285]],["title/42",[39,3.613,163,2.477,164,2.316,182,3.145]],["description/42",[7,1.398,8,0.211,39,4.539,111,4.41,152,5.252,164,2.91,182,3.952,198,7.701,199,7.701]],["title/43",[63,3.396,163,2.057,164,1.924,171,3.751,200,2.957,201,5.09]],["description/43",[7,1.323,8,0.2,61,3.823,63,4.86,163,2.944,164,2.754,171,5.369,182,3.739,202,5.369,203,7.285,204,7.285]],["title/44",[83,2.192,205,3.069]],["description/44",[5,1.994,7,1.578,16,1.683,83,2.474,205,3.464]],["title/45",[143,2.531,205,2.443,206,4.66,207,1.377]],["description/45",[8,0.185,16,1.305,41,3.138,50,2.098,126,1.965,143,2.783,205,3.58,206,5.125,207,2.018,208,5.125,209,6.178,210,6.178]],["title/46",[126,1.787,205,2.443,207,1.377,208,4.66]],["description/46",[8,0.185,12,1.58,41,3.138,50,2.098,126,1.965,143,2.783,205,3.58,206,5.125,207,2.018,208,5.125,211,6.178,212,6.178]],["title/47",[23,0.672,119,2.232,120,1.887,205,2.217,213,3.439]],["description/47",[7,1.717,8,0.2,16,1.411,75,4.505,111,4.172,119,2.924,174,3.391,205,2.904,214,3.624,215,6.677]],["title/48",[16,1.491,216,6.318]],["description/48",[16,1.739,35,5.143,36,3.849,216,7.368]],["title/49",[7,1.01,12,1.303,16,1.077,23,0.672,216,4.563]],["description/49",[7,1.483,8,0.224,12,1.914,16,1.581,24,2.052,217,8.166,218,8.166]],["title/50",[16,1.187,177,3.18,216,5.028,219,5.028]],["description/50",[7,1.398,8,0.211,16,1.897,23,0.931,119,3.091,220,5.252,221,7.701,222,7.701]],["title/51",[16,1.491,83,2.192]],["description/51",[5,1.994,7,1.578,16,2.046,83,2.474]],["title/52",[7,1.113,16,1.187,23,0.741,223,4.828]],["description/52",[7,1.529,8,0.231,16,1.631,24,2.116,223,6.633,224,8.42]],["title/53",[7,1.01,12,1.303,23,0.672,114,1.931,126,1.622]],["description/53",[8,0.224,16,1.581,88,2.835,114,2.835,126,2.381,135,3.613,225,8.166]],["title/54",[2,2.968,16,1.491]],["description/54",[2,3.349,5,1.994,7,1.578,16,2.046]],["title/55",[7,1.113,16,1.187,26,2.152,226,2.905]],["description/55",[7,1.529,8,0.231,12,1.974,26,2.957,226,3.991,227,8.42]],["title/56",[228,8.096]],["description/56",[35,5.319,36,3.981,228,8.513]],["title/57",[83,2.192,205,3.069]],["description/57",[5,1.994,7,1.578,16,1.683,83,2.474,205,3.464]],["title/58",[143,2.531,205,2.443,206,4.66,207,1.377]],["description/58",[8,0.185,16,1.305,41,3.138,50,2.098,126,1.965,143,2.783,205,3.58,206,5.125,207,2.018,208,5.125,209,6.178,210,6.178]],["title/59",[126,1.787,205,2.443,207,1.377,208,4.66]],["description/59",[8,0.185,12,1.58,41,3.138,50,2.098,126,1.965,143,2.783,205,3.58,206,5.125,207,2.018,208,5.125,211,6.178,212,6.178]],["title/60",[23,0.672,119,2.232,120,1.887,205,2.217,213,3.439]],["description/60",[7,1.717,8,0.2,16,1.411,75,4.505,111,4.172,119,2.924,174,3.391,205,2.904,214,3.624,215,6.677]],["title/61",[7,1.398,13,4.683]],["description/61",[5,1.994,7,1.918,13,5.286,16,1.683]],["title/62",[7,1.01,11,2.402,12,1.303,13,3.382,177,2.885]],["description/62",[7,1.439,8,0.218,11,3.424,16,1.535,119,3.181,174,3.69,229,7.926,230,7.926]],["title/63",[7,1.113,12,1.437,13,3.727,23,0.741]],["description/63",[7,1.529,8,0.231,12,1.974,13,5.121,24,2.116,231,8.42]],["title/64",[7,1.01,12,1.303,13,3.382,23,0.672,232,3.985]],["description/64",[7,1.398,8,0.211,12,1.805,13,4.683,24,2.462,113,3.91,233,6.634,234,7.701]],["title/65",[235,3.048,236,4.238]],["description/65",[5,1.994,7,1.578,16,1.683,235,3.44,236,4.783]],["title/66",[23,0.672,83,1.583,235,2.201,236,3.061,237,3.185]],["description/66",[7,1.566,8,0.237,12,1.488,14,1.072,17,2.613,36,1.78,37,3.33,50,1.292,71,2.193,88,2.203,135,1.837,236,4.748,237,2.378,238,3.577,239,4.152,240,4.152,241,4.152,242,4.152,243,4.152,244,4.152,245,4.152,246,2.975,247,4.152,248,2.975,249,4.152]],["title/67",[23,0.741,83,1.744,235,2.426,236,3.373]],["description/67",[7,1.529,8,0.231,12,1.974,88,2.923,236,4.634,250,8.42]],["title/68",[251,8.096]],["description/68",[35,5.319,36,3.981,251,8.513]],["title/69",[19,1.841,88,2.128,186,3.613,252,4.66]],["description/69",[5,0.999,7,1.194,8,0.12,14,1.124,19,1.307,38,3.04,50,1.355,88,1.511,95,2.459,114,1.511,126,1.918,183,2.691,186,2.566,235,1.723,252,6.03,253,3.989,254,2.79,255,3.75,256,3.989,257,3.989,258,2.844,259,2.968,260,2.691,261,2.21,262,1.711,263,2.566,264,3.309,265,3.989,266,3.989,267,3.428,268,3.989,269,4.352]],["title/70",[19,1.841,137,3.857,186,3.613,252,4.66]],["description/70",[5,0.999,7,1.194,8,0.12,14,1.124,19,1.307,38,3.04,50,1.355,95,2.459,114,1.511,126,1.918,137,2.739,183,2.691,186,2.566,235,1.723,252,6.03,253,3.989,254,2.79,255,3.75,256,3.989,257,3.989,258,2.844,259,2.968,260,2.691,261,2.21,262,1.711,263,2.566,264,3.309,265,3.989,266,3.989,267,3.428,268,3.989,270,4.352]],["title/71",[271,5.03,272,4.46,273,4.295]],["description/71",[5,1.932,7,1.529,16,1.631,271,6.206,272,5.503,273,5.299]],["title/72",[23,0.672,259,3.793,271,4.099,272,3.634,273,3.5]],["description/72",[7,1.359,8,0.206,16,1.45,64,2.131,88,2.599,259,5.106,271,5.518,272,4.893,273,4.712,274,7.487]],["title/73",[7,1.113,16,1.187,23,0.741,273,3.857]],["description/73",[7,1.529,8,0.231,12,1.974,88,2.923,273,5.299,275,8.42]],["title/74",[2,2.968,276,4.609]],["description/74",[2,3.349,5,1.994,7,1.578,16,1.683,276,5.202]],["title/75",[6,2.643,276,4.609]],["description/75",[6,3.082,8,0.247,276,5.375,277,8.98]],["title/76",[62,2.786,276,4.609]],["description/76",[5,1.65,8,0.218,12,0.703,14,0.774,16,1.536,23,0.869,30,1.54,50,1.938,62,1.085,68,1.592,82,2.103,83,0.854,144,1.933,232,3.516,276,4.305,278,4.278,279,5.469,280,5.083,281,4.497,282,6.225,283,3,284,1.463,285,2.095,286,3]],["title/77",[16,1.077,23,0.672,276,3.329,278,2.794,287,5.097]],["description/77",[8,0.218,14,1.451,16,1.536,23,1.111,24,1.412,38,3.924,68,2.982,82,2.409,263,3.312,276,3.363,278,2.824,280,3.602,284,2.74,287,5.15,288,4.026,289,4.61,290,4.61,291,5.619]],["title/78",[16,1.077,32,2.348,107,3.564,182,2.854,278,2.794]],["description/78",[5,2.235,6,1.403,8,0.172,14,1.056,16,0.792,32,2.648,50,1.953,64,1.785,68,2.17,75,2.529,76,2.31,107,4.891,148,0.509,213,2.529,276,3.755,278,2.055,292,4.089,293,3.221,294,4.089,295,4.089,296,3.748,297,3.748,298,2.487,299,2.31,300,4.089,301,4.089,302,4.089,303,4.089]],["title/79",[12,1.437,23,0.741,83,1.744,278,3.08]],["description/79",[8,0.231,12,1.974,24,2.116,83,2.397,278,4.231,304,8.42]],["title/80",[26,2.397,126,1.99,276,4.085]],["description/80",[8,0.247,276,5.375,305,6.828,306,8.98]],["title/81",[23,0.825,83,1.943,307,6.256]],["description/81",[8,0.231,24,2.116,83,2.397,307,7.717,308,5.881,309,8.42]],["title/82",[16,1.187,276,3.668,278,3.08,310,5.28]],["description/82",[8,0.231,16,1.631,276,5.04,278,4.231,311,8.42,312,8.42]],["title/83",[16,1.187,276,3.668,278,3.08,313,4.828]],["description/83",[5,1.784,6,1.447,8,0.116,14,1.089,16,1.684,30,2.164,38,2.945,50,1.313,68,3.408,107,4.985,144,1.028,145,0.558,146,1.423,207,0.947,235,1.669,276,3.844,278,3.908,279,3.206,280,2.703,298,2.564,299,2.382,314,1.85,315,4.217,316,4.217,317,4.217,318,2.564,319,4.217]],["title/84",[7,1.113,12,1.437,23,0.741,276,3.668]],["description/84",[7,1.529,8,0.231,12,1.974,24,2.116,276,5.04,320,8.42]],["title/85",[131,3.617,147,3.275]],["description/85",[35,5.143,36,3.849,131,4.218,147,3.82]],["title/86",[13,3.727,24,1.54,147,2.607,321,5.28]],["description/86",[8,0.218,13,4.821,24,1.992,131,3.723,147,3.372,183,4.901,322,6.503,323,7.926]],["title/87",[64,2.192,131,3.617]],["description/87",[35,5.143,36,3.849,64,2.556,131,4.218]],["title/88",[64,1.744,131,2.879,324,4.517,325,4.66]],["description/88",[8,0.231,64,2.397,131,3.955,324,6.206,325,6.403,326,8.42]],["title/89",[64,1.943,131,3.206,327,6.256]],["description/89",[8,0.195,32,2.995,64,2.019,131,3.332,325,5.394,327,6.502,328,4.636,329,7.094,330,5.228,331,5.588,332,6.112,333,7.094]],["title/90",[64,1.744,126,1.787,131,2.879,325,4.66]],["description/90",[8,0.165,9,3.341,64,2.361,126,1.748,131,3.896,284,2.922,288,4.294,325,6.307,330,4.417,334,5.993,335,3.298,336,8.294,337,5.993,338,4.557,339,5.993]],["title/91",[64,1.744,106,2.853,131,2.879,147,2.607]],["description/91",[8,0.172,11,2.709,14,1.619,64,2.435,106,2.919,131,4.575,147,2.668,184,4.184,340,4.94,341,5.403,342,5.145,343,5.145,344,3.496,345,6.271]],["title/92",[64,1.335,107,3.007,131,2.204,160,2.616,182,2.408,226,2.224,346,3.696]],["description/92",[8,0.195,64,2.019,107,4.547,120,2.407,131,3.332,160,3.955,182,3.641,226,4.404,346,7.319,347,7.094]],["title/93",[64,1.449,126,1.484,131,2.391,143,2.102,205,2.029,207,1.143]],["description/93",[8,0.218,126,2.311,143,3.273,207,1.781,348,4.068,349,6.027,350,7.926,351,7.926]],["title/94",[64,1.744,126,1.787,131,2.879,226,2.905]],["description/94",[8,0.224,9,4.552,68,4.334,123,4.439,226,3.871,338,6.209,352,8.166]],["title/95",[32,2.587,64,1.744,131,2.879,147,2.607]],["description/95",[8,0.231,32,3.555,64,2.397,131,3.955,147,3.582,353,8.42]],["title/96",[64,1.943,106,3.177,131,3.206]],["description/96",[6,2.103,8,0.168,9,3.417,11,2.648,14,1.582,64,2.397,106,2.853,131,4.52,184,4.089,340,4.828,341,5.28,342,5.029,343,5.029,344,3.417,354,6.129]],["title/97",[24,1.715,64,1.943,131,3.206]],["description/97",[7,1.224,8,0.185,16,1.305,24,2.258,64,1.918,131,3.166,290,5.53,355,4.168,356,7.076,357,4.242,358,6.178,359,6.74]],["title/98",[64,1.943,131,3.206,328,4.46]],["description/98",[8,0.231,64,2.397,131,3.955,328,5.503,360,7.717,361,8.42]],["title/99",[64,1.943,131,3.206,305,5.19]],["description/99",[8,0.239,64,2.474,131,4.082,362,6.07,363,8.691]],["title/100",[14,1.582,64,1.744,126,1.787,131,2.879]],["description/100",[8,0.218,9,4.419,14,2.046,123,4.308,331,6.244,338,6.027,364,7.926,365,7.926]],["title/101",[64,1.744,126,1.787,131,2.879,237,3.51]],["description/101",[8,0.231,64,2.397,126,2.455,131,3.955,237,4.822,366,8.42]],["title/102",[64,1.744,131,2.879,147,2.607,367,4.089]],["description/102",[8,0.211,23,0.931,64,2.192,123,4.186,131,3.617,147,3.276,367,5.137,368,6.634,369,7.701]],["title/103",[64,1.744,126,1.787,131,2.879,147,2.607]],["description/103",[8,0.172,11,2.709,14,1.619,64,2.435,126,1.829,131,4.575,147,2.668,184,4.184,340,4.94,341,5.403,342,5.145,343,5.145,344,3.496,370,6.271]],["title/104",[32,2.881,64,1.943,131,3.206]],["description/104",[8,0.239,32,3.669,64,2.474,131,4.082,371,8.691]],["title/105",[372,4.076]],["description/105",[35,5.319,36,3.981,372,4.286]],["title/106",[7,0.852,16,0.909,80,2.854,226,2.224,373,3.568,374,3.277,375,3.85]],["description/106",[6,2.803,8,0.161,10,4.458,19,1.761,56,4.618,71,1.669,80,3.566,148,0.729,195,4.321,226,2.779,372,2.705,375,4.81,376,2.779,377,3.076,378,5.374,379,4.81,380,5.374,381,3.626,382,5.863]],["title/107",[7,0.924,16,0.986,80,3.095,314,2.234,373,3.87,374,3.555]],["description/107",[6,2.891,8,0.168,10,4.66,19,2.53,71,1.744,80,3.727,148,0.763,195,4.517,314,2.69,372,2.828,376,2.905,379,5.029,380,5.617,381,3.79,383,4.828,384,6.129]],["title/108",[7,0.924,16,0.986,76,2.875,102,2.015,373,3.87,374,3.555]],["description/108",[6,3.083,8,0.185,10,5.125,19,2.025,76,3.808,102,2.668,135,2.982,148,0.839,195,4.968,372,3.11,381,4.168,385,6.178,386,6.74]],["title/109",[7,0.79,16,0.843,80,2.647,262,1.711,373,3.309,374,3.039,375,3.571,387,3.039]],["description/109",[6,2.721,8,0.154,10,4.273,19,1.688,56,4.426,71,1.599,80,3.417,148,0.699,195,4.141,262,2.209,372,2.593,375,4.61,376,2.664,377,2.948,378,5.15,379,4.61,381,3.475,385,5.15,387,3.924,388,3.093,389,5.619]],["title/110",[19,2.05,23,0.825,372,3.149]],["description/110",[8,0.231,12,1.974,19,2.529,24,2.116,372,3.885,390,8.42]],["title/111",[19,2.313,391,4.293]],["description/111",[5,1.932,7,1.529,16,1.631,19,2.529,372,3.885,391,4.694]],["title/112",[23,0.741,76,3.462,102,2.426,372,2.828]],["description/112",[8,0.235,18,1.017,19,2.57,24,1.576,76,3.543,102,3.387,135,2.774,145,0.83,148,0.78,254,4.019,372,2.894,392,1.535,393,6.271]],["title/113",[7,1.01,16,1.077,23,0.672,232,3.985,372,2.566]],["description/113",[8,0.239,14,1.657,18,1.034,19,1.929,24,1.614,30,3.295,64,1.827,148,0.799,223,5.057,232,4.6,254,4.115,372,2.962,392,1.571,394,6.42]],["title/114",[23,0.741,254,3.928,372,2.828,395,4.517]],["description/114",[8,0.231,18,1.001,19,2.53,24,1.54,60,4.517,102,2.426,145,0.811,148,0.763,254,3.928,372,2.828,395,4.517,396,6.129,397,6.129,398,3.373,399,6.129]],["title/115",[19,2.05,102,2.702,391,3.805]],["description/115",[8,0.231,18,1.001,19,2.891,102,2.426,145,0.811,148,0.763,254,3.928,372,2.828,391,3.417,395,4.517,398,3.373,400,4.66,401,5.28,402,6.129]],["title/116",[391,4.293,403,3.112]],["description/116",[8,0.228,14,1.547,18,0.986,19,2.491,145,0.793,148,0.746,299,3.385,372,3.827,391,3.341,404,5.163,405,2.439,406,4.294,407,3.043,408,4.557,409,5.993]],["title/117",[207,1.533,391,3.805,410,3.71]],["description/117",[5,1.317,8,0.195,12,0.855,14,0.942,18,0.682,19,1.724,30,1.872,41,1.698,50,1.135,52,2.547,68,1.936,71,1.634,82,1.563,83,1.038,84,1.627,86,1.601,145,0.483,148,0.454,182,1.872,207,0.819,298,2.218,299,3.243,372,2.649,381,2.256,391,3.956,407,1.852,410,1.983,411,0.977,412,0.812,413,3.142,414,3.142,415,2.688,416,2.614,417,3.343,418,3.142,419,3.343,420,2.774,421,3.648]],["title/118",[207,1.533,391,3.805,422,3.328]],["description/118",[5,1.439,8,0.21,12,0.958,14,1.056,18,0.746,19,1.884,30,2.099,41,1.903,50,1.273,68,2.17,71,1.785,145,0.541,148,0.509,182,2.099,207,0.919,298,2.487,299,3.544,372,2.894,381,2.529,391,4.254,407,2.076,411,1.095,412,0.911,413,3.523,414,3.523,415,3.014,416,2.93,420,3.109,422,1.994,423,4.089]],["title/119",[19,2.313,391,4.293]],["description/119",[5,1.331,8,0.197,12,0.867,14,0.955,18,0.69,19,2.436,30,1.898,41,1.721,50,1.151,52,2.582,68,1.962,71,1.651,82,1.585,83,1.052,84,1.649,86,1.623,145,0.489,148,0.46,182,1.898,254,2.37,298,2.249,299,3.277,372,2.677,381,2.286,391,3.991,407,1.877,413,3.185,414,3.185,415,2.725,416,2.649,417,3.389,418,3.185,419,3.389,420,2.811,424,3.697]],["title/120",[83,2.192,93,3.684]],["description/120",[2,3.245,5,1.932,7,1.529,83,2.397,93,4.028,260,5.207]],["title/121",[23,0.672,38,3.884,425,5.561,426,4.563,427,4.563]],["description/121",[8,0.211,19,2.313,83,2.192,88,2.673,220,5.252,427,6.318,428,6.318,429,7.058,430,7.701]],["title/122",[7,0.924,23,0.615,93,2.435,123,2.767,135,2.252,233,4.385]],["description/122",[7,1.359,8,0.206,75,4.63,83,2.131,88,2.599,93,3.582,105,3.885,135,3.312,431,7.487,432,7.487]],["title/123",[23,0.741,426,5.028,433,5.617,434,5.617]],["description/123",[8,0.211,19,2.313,83,2.192,88,2.673,220,5.252,428,6.318,429,7.058,434,7.058,435,7.701]],["title/124",[23,0.672,308,3.884,426,4.563,427,4.563,433,5.097]],["description/124",[8,0.224,19,2.453,83,2.324,88,2.835,427,6.7,428,6.7,436,8.166]],["title/125",[2,2.968,437,7.058]],["description/125",[2,3.993,5,1.932,7,1.529,260,5.207,437,7.717]],["title/126",[7,0.924,23,0.615,260,3.147,438,4.665,439,4.665,440,4.665]],["description/126",[6,2.257,7,1.194,8,0.181,23,0.795,50,2.047,260,4.067,279,5.001,438,6.027,439,6.027,440,8.099,441,6.027,442,6.576,443,5.18,444,6.576]],["title/127",[2,2.63,445,5.376,446,4.221]],["description/127",[2,3.918,5,1.874,7,1.483,260,5.05,445,6.432,446,5.05]],["title/128",[6,1.61,19,1.41,146,1.583,445,3.696,446,2.902,447,4.301,448,2.808]],["description/128",[8,0.185,50,2.098,129,4.497,255,5.807,446,4.168,448,5.377,449,6.74,450,6.74,451,6.178,452,5.309,453,6.74,454,6.74,455,6.74]],["title/129",[19,1.41,23,0.567,146,1.583,445,3.696,446,2.902,447,4.301,448,2.808]],["description/129",[8,0.147,9,1.858,11,1.44,14,0.86,17,2.097,23,0.403,26,2.941,30,1.71,41,1.551,50,1.663,71,1.521,73,1.858,90,3.778,93,2.556,123,1.812,146,1.125,148,0.415,271,6.171,298,2.027,335,1.834,445,5.267,446,2.061,448,4.003,451,3.054,456,5.343,457,4.897,458,4.897,459,2.734,460,3.333,461,3.333,462,3.333,463,3.333,464,3.333,465,3.333]],["title/130",[466,7.247]],["description/130",[2,3.349,5,1.994,7,1.578,260,5.374,466,7.131]],["title/131",[7,1.113,16,1.187,26,2.152,237,3.51]],["description/131",[8,0.239,12,2.037,126,2.534,237,4.977,467,8.691]],["title/132",[23,0.825,113,3.466,237,3.909]],["description/132",[8,0.224,12,1.914,24,2.052,75,5.05,113,4.146,466,6.7,468,8.166]],["title/133",[23,0.741,123,3.331,126,1.787,237,3.51]],["description/133",[8,0.218,83,2.256,88,2.752,123,4.308,126,2.311,135,3.507,237,4.539,469,7.926]],["title/134",[126,2.245,260,4.762]],["description/134",[2,3.245,5,1.932,7,1.529,126,2.455,260,6.407]],["title/135",[23,0.825,123,3.71,260,4.221]],["description/135",[8,0.231,23,1.018,50,2.621,470,7.717,471,6.034,472,8.42]],["title/136",[26,2.397,123,3.71,260,4.221]],["description/136",[7,1.02,8,0.154,9,3.133,14,1.451,16,1.088,71,1.599,75,3.475,82,2.409,83,1.599,84,2.506,86,2.466,260,4.903,362,3.924,473,3.536,474,5.15,475,4.61,476,3.475,477,4.61,478,5.15,479,5.15,480,5.619]],["title/137",[23,0.825,113,3.466,260,4.221]],["description/137",[8,0.158,14,1.481,16,1.111,24,1.442,71,1.633,82,2.46,83,1.633,84,2.56,86,2.518,113,2.914,260,4.976,362,4.008,474,5.26,475,4.708,476,3.549,477,4.708,478,5.26,479,5.26,481,5.739,482,5.739]],["title/138",[102,3.048,483,5.675]],["description/138",[2,3.349,5,1.994,102,4.181,483,6.405]],["title/139",[23,0.741,102,2.426,126,1.787,483,4.517]],["description/139",[7,1.359,8,0.206,16,1.45,23,0.905,102,3.809,126,2.183,483,5.518,484,5.229,485,7.487]],["title/140",[23,0.672,102,2.201,126,1.622,483,4.099,484,3.884]],["description/140",[8,0.218,23,0.958,102,3.95,126,2.311,484,5.536,486,7.265,487,7.926]],["title/141",[26,2.152,102,2.426,126,1.787,483,4.517]],["description/141",[7,1.398,8,0.211,16,1.491,102,3.878,114,2.673,126,2.245,486,7.058,488,7.701]],["title/142",[102,3.048,489,5.855]],["description/142",[2,3.349,5,1.994,102,4.181,489,6.609]],["title/143",[23,0.615,50,1.584,102,2.015,119,2.043,226,2.413,490,2.801]],["description/143",[8,0.218,50,2.467,102,3.138,119,3.181,226,3.757,490,4.362,491,7.265,492,7.926]],["title/144",[23,0.672,64,1.583,102,2.201,108,4.229,490,3.061]],["description/144",[7,1.398,8,0.211,11,3.326,16,1.491,23,0.931,64,2.192,102,3.048,493,7.701,494,7.701]],["title/145",[23,0.741,117,2.879,484,4.28,489,4.66]],["description/145",[8,0.224,23,0.987,102,3.232,117,3.836,484,5.703,489,6.209,495,8.166]],["title/146",[18,0.729,102,2.426,120,2.08,490,3.373]],["description/146",[7,1.398,8,0.211,16,1.491,18,0.915,102,3.048,120,2.613,226,3.65,490,4.238,496,7.701]],["title/147",[62,2.012,64,1.583,102,2.201,108,4.229,490,3.061]],["description/147",[7,1.398,8,0.211,11,3.326,16,1.491,62,2.786,64,2.192,102,3.048,490,4.238,497,7.701]],["title/148",[64,1.583,102,2.201,106,2.589,108,4.229,490,3.061]],["description/148",[7,1.398,8,0.211,11,3.326,16,1.491,64,2.192,102,3.048,106,3.585,490,4.238,498,7.701]],["title/149",[102,3.048,490,4.238]],["description/149",[2,3.349,5,1.994,102,4.181,490,4.783]],["title/150",[23,0.741,102,2.426,126,1.787,490,3.373]],["description/150",[8,0.218,23,0.958,102,3.138,126,2.311,484,5.536,499,7.926,500,7.926,501,7.926]],["title/151",[502,3.496]],["description/151",[35,5.319,36,3.981,502,3.677]],["title/152",[23,0.672,119,2.232,144,1.355,237,3.185,503,3.985]],["description/152",[8,0.211,12,1.805,71,2.192,119,3.091,144,1.877,503,5.518,504,6.318,505,7.058,506,7.058]],["title/153",[5,1.077,23,0.567,113,2.383,502,1.857,503,3.362,507,3.696,508,2.043]],["description/153",[8,0.161,23,0.709,30,3.009,37,3.076,82,2.513,83,1.669,84,2.615,113,2.977,119,2.353,126,1.71,263,3.456,503,4.201,507,6.434,508,2.553,509,5.374,510,5.374,511,5.374,512,5.374,513,5.374]],["title/154",[23,0.741,83,1.744,502,2.426,514,3.253]],["description/154",[8,0.224,23,0.987,83,2.324,144,1.99,502,3.232,515,5.234,516,7.484]],["title/155",[23,0.741,91,4.66,502,2.426,515,3.928]],["description/155",[8,0.13,91,3.599,93,2.265,145,0.626,220,3.228,285,3.306,356,3.729,471,3.392,502,3.3,515,5.344,517,4.777,518,4.338,519,4.338,520,4.078,521,4.338,522,4.338,523,6.035,524,3.599,525,4.338,526,3.392,527,4.078,528,4.338,529,3.306,530,3.228,531,4.338]],["title/156",[26,2.397,502,2.702,515,4.375]],["description/156",[8,0.148,26,1.895,32,3.252,41,2.511,65,3.134,67,4.249,106,2.511,279,4.102,305,6.832,308,3.768,356,4.249,367,3.599,477,4.426,502,2.136,508,3.354,515,3.458,532,4.945,533,4.102,534,3.768,535,4.945]],["title/157",[19,1.671,26,1.953,142,3.382,143,2.296,515,3.564]],["description/157",[8,0.19,19,2.077,143,3.772,284,3.371,338,5.256,502,2.736,514,3.669,515,4.431,536,8.372,537,6.913,538,6.913]],["title/158",[23,0.615,71,1.449,119,2.043,237,2.915,502,2.015,539,4.009]],["description/158",[8,0.206,71,2.131,119,3.005,174,3.485,237,4.288,502,2.964,508,3.26,514,3.974,539,5.898,540,6.862]],["title/159",[83,2.192,502,3.048]],["description/159",[5,2.06,83,2.556,502,4.265]],["title/160",[23,0.672,119,2.232,144,1.355,237,3.185,503,3.985]],["description/160",[8,0.211,12,1.805,71,2.192,119,3.091,144,1.877,503,5.518,504,6.318,505,7.058,506,7.058]],["title/161",[5,1.077,23,0.567,113,2.383,502,1.857,503,3.362,507,3.696,508,2.043]],["description/161",[8,0.161,23,0.709,30,3.009,37,3.076,82,2.513,83,1.669,84,2.615,113,2.977,119,2.353,126,1.71,263,3.456,503,4.201,507,6.434,508,2.553,509,5.374,510,5.374,511,5.374,512,5.374,513,5.374]],["title/162",[23,0.741,83,1.744,502,2.426,514,3.253]],["description/162",[8,0.224,23,0.987,83,2.324,144,1.99,502,3.232,515,5.234,516,7.484]],["title/163",[23,0.741,91,4.66,502,2.426,515,3.928]],["description/163",[8,0.13,91,3.599,93,2.265,145,0.626,220,3.228,285,3.306,356,3.729,471,3.392,502,3.3,515,5.344,517,4.777,518,4.338,519,4.338,520,4.078,521,4.338,522,4.338,523,6.035,524,3.599,525,4.338,526,3.392,527,4.078,528,4.338,529,3.306,530,3.228,531,4.338]],["title/164",[26,2.397,502,2.702,515,4.375]],["description/164",[8,0.148,26,1.895,32,3.252,41,2.511,65,3.134,67,4.249,106,2.511,279,4.102,305,6.832,308,3.768,356,4.249,367,3.599,477,4.426,502,2.136,508,3.354,515,3.458,532,4.945,533,4.102,534,3.768,535,4.945]],["title/165",[23,0.615,71,1.449,119,2.043,237,2.915,502,2.015,539,4.009]],["description/165",[8,0.206,71,2.131,119,3.005,174,3.485,237,4.288,502,2.964,508,3.26,514,3.974,539,5.898,540,6.862]],["title/166",[377,4.04,502,3.048]],["description/166",[5,2.06,377,4.712,502,4.265]],["title/167",[26,2.152,50,1.908,144,1.494,541,5.617]],["description/167",[8,0.212,18,0.916,50,1.679,114,1.873,144,1.315,145,0.714,148,0.671,248,3.866,377,4.042,392,1.32,502,2.136,508,2.349,541,4.945,542,7.06,543,5.395,544,7.06,545,3.866,546,4.648,547,5.395]],["title/168",[262,2.41,377,3.216,548,3.928,549,3.727]],["description/168",[8,0.251,18,1.086,145,0.915,147,2.94,148,0.86,262,2.718,377,3.627,548,4.431,549,4.204,550,6.913,551,6.913]],["title/169",[120,2.613,549,4.683]],["description/169",[5,1.547,8,0.185,14,1.161,18,0.961,62,1.627,106,2.094,120,2.288,144,1.643,145,0.595,148,0.56,262,2.651,348,2.308,362,3.141,377,3.538,392,1.101,502,2.669,508,1.958,549,5.464,552,3.875,553,3.314,554,4.122,555,4.497]],["title/170",[106,2.853,262,2.41,377,3.216,549,3.727]],["description/170",[8,0.251,18,1.086,145,1.209,148,0.86,262,2.718,377,3.627,392,1.692,502,2.736,549,4.204,556,6.913]],["title/171",[263,3.613,508,2.668,548,3.928,557,5.617]],["description/171",[8,0.247,18,1.068,145,0.892,148,0.839,263,3.973,392,1.65,508,2.935,514,3.577,548,4.32,557,6.178,558,5.125,559,6.74]],["title/172",[23,0.741,508,2.668,514,3.253,560,5.28]],["description/172",[8,0.243,18,1.05,145,0.87,148,0.818,392,1.61,457,6.027,502,2.603,508,2.863,514,3.49,560,5.666,561,4.712,562,3.936,563,6.576]],["title/173",[32,2.587,262,2.41,377,3.216,549,3.727]],["description/173",[8,0.251,18,1.086,32,2.918,145,0.915,148,0.86,262,2.718,377,3.627,392,1.692,502,2.736,549,4.204,564,6.913]],["title/174",[18,0.729,262,2.41,377,3.216,549,3.727]],["description/174",[8,0.251,18,1.086,145,0.915,148,0.86,262,2.718,377,3.627,392,1.692,502,2.736,549,4.204,565,6.913,566,6.913]],["title/175",[18,0.915,549,4.683]],["description/175",[5,1.547,8,0.185,10,3.42,18,1.144,32,1.899,88,1.561,144,1.643,145,0.595,148,0.56,184,3,262,1.768,372,2.075,392,1.101,502,2.669,508,1.958,549,4.919,552,3.875,567,2.781,568,4.497,569,4.497,570,3.542,571,4.122,572,3.875,573,4.497]],["title/176",[6,2.103,262,2.41,377,3.216,549,3.727]],["description/176",[5,1.509,8,0.181,14,1.124,18,0.943,62,1.575,106,2.026,120,1.477,129,2.904,144,1.603,145,0.576,148,0.542,262,3.118,348,2.234,362,3.04,377,3.451,392,1.065,502,1.723,508,1.895,515,2.79,549,5.375,552,3.75,553,3.208,554,3.989,560,3.75,574,4.352]],["title/177",[26,2.152,50,1.908,144,1.494,546,5.28]],["description/177",[8,0.231,18,1.001,50,1.908,114,2.128,144,1.494,145,0.811,148,0.763,377,3.216,407,3.112,502,2.426,508,2.668,542,5.617,544,5.617,546,5.28,575,6.129,576,6.129]],["title/178",[120,2.08,262,2.41,377,3.216,549,3.727]],["description/178",[8,0.251,18,1.086,145,0.915,148,0.86,262,2.718,377,3.627,392,1.692,502,2.736,549,4.204,577,5.095,578,6.913]],["title/179",[187,4.936,502,3.048]],["description/179",[5,2.06,187,5.756,502,4.265]],["title/180",[6,2.103,144,1.494,187,3.928,502,2.426]],["description/180",[6,2.313,8,0.247,18,1.068,144,1.643,145,0.892,148,0.839,187,4.32,392,1.65,502,2.668,558,5.125,579,5.309,580,6.74]],["title/181",[23,0.741,144,1.494,187,3.928,502,2.426]],["description/181",[8,0.243,18,1.05,24,1.653,144,1.603,145,0.87,148,0.818,187,4.215,392,1.61,502,2.603,558,5.001,579,5.18,581,5.666,582,6.576]],["title/182",[62,2.218,144,1.494,187,3.928,502,2.426]],["description/182",[8,0.243,18,1.05,30,3.375,62,2.38,144,1.603,145,0.87,148,0.818,187,4.215,392,1.61,502,2.603,558,5.001,579,5.18,583,6.576]],["title/183",[26,1.953,144,1.355,187,3.564,448,3.329,502,2.201]],["description/183",[8,0.231,9,3.417,18,1.001,30,3.145,144,1.494,145,0.811,148,0.763,187,3.928,322,5.029,392,1.5,448,3.668,502,2.426,558,4.66,579,4.828,584,6.129,585,6.129]],["title/184",[26,1.953,144,1.355,187,3.564,321,4.791,502,2.201]],["description/184",[8,0.239,18,1.034,126,1.872,144,1.565,145,0.849,148,0.799,187,4.115,321,5.531,392,1.571,502,2.541,558,4.882,579,5.057,581,5.531,586,6.42]],["title/185",[126,1.99,207,1.533,502,2.702]],["description/185",[5,1.994,126,2.534,207,1.952,502,4.181]],["title/186",[6,2.103,412,1.365,508,2.668,587,4.005]],["description/186",[6,1.815,8,0.209,18,0.903,82,2.267,83,1.505,84,2.359,86,2.321,126,1.542,145,0.7,148,0.658,207,1.188,392,1.295,411,1.416,412,1.692,508,3.307,587,3.457,588,5.304,589,4.166,590,4.557,591,5.289]],["title/187",[26,2.152,412,1.365,508,2.668,587,4.005]],["description/187",[6,1.815,8,0.209,18,0.903,82,2.267,83,1.505,84,2.359,86,2.321,126,1.542,145,0.7,148,0.658,207,1.188,392,1.295,411,1.416,412,1.692,508,3.307,587,3.457,588,5.304,589,4.166,590,4.557,592,5.289]],["title/188",[62,2.218,412,1.365,508,2.668,587,4.005]],["description/188",[8,0.212,18,0.916,62,1.952,82,2.312,83,1.535,84,2.406,86,2.368,126,1.573,145,0.714,148,0.671,207,1.212,392,1.32,412,1.202,502,2.136,508,3.354,587,3.526,588,5.38,589,4.249,590,4.648,593,5.395]],["title/189",[144,1.494,473,3.857,508,2.668,594,4.66]],["description/189",[8,0.224,284,3.982,473,5.139,508,3.555,594,6.209,595,7.484,596,8.166]],["title/190",[32,2.587,508,2.668,594,4.66,595,5.617]],["description/190",[8,0.231,32,3.555,144,2.052,508,3.666,594,6.403,597,8.42]],["title/191",[144,1.494,177,3.18,508,2.668,594,4.66]],["description/191",[8,0.206,68,3.974,82,3.209,123,4.07,144,1.825,174,3.485,177,3.885,508,3.26,594,5.693,598,7.487]],["title/192",[23,0.741,412,1.365,508,2.668,587,4.005]],["description/192",[8,0.247,18,1.068,24,1.694,145,0.892,148,0.839,392,1.65,412,1.501,502,2.668,508,2.935,587,4.405,588,4.707,599,6.74]],["title/193",[120,2.08,144,1.494,508,2.668,600,4.005]],["description/193",[8,0.215,9,3.069,14,1.421,30,2.825,68,2.922,71,2.224,82,2.36,120,1.868,144,1.342,412,1.226,502,2.179,508,3.955,600,5.937,601,4.336,602,4.057,603,2.378,604,5.505]],["title/194",[144,1.355,177,2.885,262,2.186,388,3.061,600,3.634]],["description/194",[5,1.528,6,1.518,8,0.121,9,2.466,14,1.142,30,4.11,68,2.348,82,1.896,110,2.608,144,1.623,148,0.829,177,2.295,196,2.735,262,3.758,338,3.364,377,2.321,412,0.985,491,4.054,600,5.823,601,3.484,602,3.26,605,3.811,606,4.424]],["title/195",[23,0.672,144,1.355,262,2.186,388,3.061,600,3.634]],["description/195",[8,0.14,23,0.615,49,3.327,207,1.143,262,3.419,381,3.148,388,4.786,412,1.134,490,2.801,514,2.702,562,3.047,567,3.148,600,4.828,603,2.199,607,5.09,608,5.09,609,4.385,610,5.09,611,4.665,612,5.09,613,3.327,614,5.09]],["title/196",[106,2.589,144,1.355,262,2.186,508,2.421,600,3.634]],["description/196",[5,1.547,8,0.212,14,0.871,26,1.895,30,1.732,34,2.769,36,2.89,41,1.571,49,2.205,50,2.398,71,0.96,110,3.181,129,2.251,148,0.42,237,3.862,262,2.122,412,0.752,502,3.335,508,3.668,514,1.791,539,2.658,600,3.527,601,2.658,602,2.487,603,1.458,615,2.418,616,5.396,617,3.374,618,3.374]],["title/197",[106,2.853,144,1.494,508,2.668,619,5.028]],["description/197",[8,0.2,71,2.074,144,1.775,502,2.884,508,3.172,603,3.147,613,4.761,619,5.978,620,6.677,621,6.677,622,7.285]],["title/198",[144,1.494,177,3.18,508,2.668,600,4.005]],["description/198",[8,0.195,68,3.765,82,3.041,88,2.463,144,1.729,174,3.302,412,1.58,508,3.089,600,4.636,601,5.588,602,5.228,623,7.094]],["title/199",[144,1.494,177,3.18,508,2.668,624,5.617]],["description/199",[8,0.159,12,0.867,65,4.159,67,2.912,68,1.962,88,1.284,118,2.725,142,4.931,143,3.638,144,1.414,160,3.234,177,3.715,373,2.811,412,1.292,508,3.835,514,3.079,536,3.389,624,6.562,625,3.697,626,3.697,627,5.802,628,5.317,629,3.697]],["title/200",[32,2.587,144,1.494,508,2.668,600,4.005]],["description/200",[8,0.19,32,2.918,68,3.669,71,1.967,82,2.963,144,1.685,412,1.54,502,2.736,508,3.01,600,4.518,601,5.445,602,5.095,630,6.913]],["title/201",[144,1.494,177,3.18,508,2.668,619,5.028]],["description/201",[8,0.2,68,3.867,82,3.123,88,2.529,144,1.775,508,3.172,613,4.761,619,5.978,620,6.677,621,6.677,631,7.285]],["title/202",[107,3.928,490,3.373,632,4.66,633,4.392]],["description/202",[2,3.147,5,1.874,107,5.234,144,1.99,490,4.494,632,6.209,633,5.851]],["title/203",[18,0.811,490,3.756,633,4.891]],["description/203",[8,0.251,18,1.086,32,2.918,145,0.915,146,2.333,147,2.94,148,0.86,490,3.805,633,4.953,634,5.672,635,6.913]],["title/204",[120,2.316,490,3.756,633,4.891]],["description/204",[8,0.206,18,0.89,19,1.558,64,1.477,70,3.823,90,4.231,106,2.415,145,0.686,148,0.645,284,2.53,392,1.27,476,3.208,490,4.122,633,5.367,636,2.394,637,2.931,638,5.188,639,4.755,640,5.188,641,2.786,642,5.188]],["title/205",[23,0.741,144,1.494,490,3.373,633,4.392]],["description/205",[8,0.247,18,1.068,24,1.694,144,1.643,145,0.892,146,2.274,147,2.867,148,0.839,490,3.71,633,4.83,634,5.53,643,6.74]],["title/206",[83,2.192,144,1.877]],["description/206",[2,3.349,5,1.994,83,2.474,144,2.574]],["title/207",[23,0.741,114,2.128,144,1.494,214,3.048]],["description/207",[7,1.306,8,0.197,12,1.15,14,1.266,16,0.95,19,1.474,23,0.593,24,1.807,64,2.047,86,2.153,88,1.703,144,2.075,186,4.239,280,3.144,330,3.615,471,3.515,517,3.346,644,4.226,645,4.609,646,4.226,647,4.905]],["title/208",[7,1.113,12,1.437,23,0.741,144,1.494]],["description/208",[7,0.891,8,0.234,12,1.15,14,1.266,19,1.474,23,1.029,24,1.233,64,1.396,105,2.545,144,1.195,263,2.892,280,3.144,645,3.144,648,3.426,649,4.905,650,4.226,651,4.496,652,5.664,653,5.022,654,4.496,655,4.905,656,2.17,657,4.905]],["title/209",[23,0.741,114,2.128,214,3.048,514,3.253]],["description/209",[5,1.251,7,0.62,8,0.187,16,0.662,19,2.043,23,0.413,24,1.37,46,2.598,50,1.064,64,2.208,83,1.551,86,1.5,88,1.892,144,2.066,145,0.452,186,4.574,280,2.19,284,1.666,420,2.598,471,2.448,507,2.691,517,2.33,524,2.598,570,2.691,644,2.944,645,3.494,646,2.944,658,4.696,659,3.417,660,2.518,661,2.944,662,3.417,663,3.417]],["title/210",[23,0.741,658,5.28,664,5.617,665,4.66]],["description/210",[7,0.875,8,0.195,12,1.129,14,1.244,16,0.933,19,1.447,23,0.858,24,1.211,64,1.371,86,2.114,88,1.673,144,2.053,186,2.84,280,3.088,330,3.551,471,3.452,517,3.286,644,4.151,645,4.548,646,4.151,658,4.151,660,3.551,664,4.416,665,3.663,666,4.818]],["title/211",[144,1.877,637,4.35]],["description/211",[2,3.349,5,1.994,144,2.574,637,4.91]],["title/212",[106,3.177,144,1.663,637,3.856]],["description/212",[8,0.251,18,1.086,71,1.967,106,3.218,144,1.685,145,0.915,146,2.333,148,0.86,392,1.692,637,3.905,667,6.913]],["title/213",[32,2.881,144,1.663,637,3.856]],["description/213",[8,0.251,18,1.086,32,2.918,71,1.967,144,1.685,145,0.915,146,2.333,148,0.86,398,3.805,637,3.905,668,6.913]],["title/214",[23,0.741,90,3.462,144,1.494,637,3.462]],["description/214",[8,0.231,88,2.923,90,4.757,144,2.052,637,4.757,669,8.42]],["title/215",[19,1.841,23,0.741,637,3.462,670,5.617]],["description/215",[8,0.243,12,1.541,18,1.05,19,1.975,24,1.653,71,1.872,145,0.87,146,2.219,148,0.818,398,3.619,637,3.715,670,6.027,671,6.576]],["title/216",[665,6.716]],["description/216",[35,5.319,36,3.981,665,7.063]],["title/217",[6,2.643,665,5.855]],["description/217",[6,2.435,8,0.255,18,1.105,71,2.019,145,0.939,146,2.394,148,0.883,398,3.904,665,5.394,672,7.094]],["title/218",[83,1.943,214,3.395,673,4.151]],["description/218",[2,3.245,5,1.932,83,2.397,144,2.052,214,4.188,673,5.121]],["title/219",[23,0.672,28,2.918,144,1.355,214,2.766,673,3.382]],["description/219",[8,0.218,24,1.992,28,4.159,65,4.604,144,1.932,214,3.942,673,4.821,674,7.926]],["title/220",[23,0.615,144,1.24,163,2.057,164,1.924,476,3.147,675,4.665]],["description/220",[8,0.168,24,1.54,93,2.932,144,2.053,163,3.404,164,3.184,183,3.79,278,3.08,377,3.216,520,5.28,675,5.617,676,6.129,677,6.129,678,6.129,679,6.129]],["title/221",[16,1.491,207,1.73]],["description/221",[5,2.06,16,1.739,207,2.42]],["title/222",[16,1.077,23,0.672,28,2.918,123,3.023,135,2.46]],["description/222",[8,0.266,11,1.976,14,1.181,16,0.886,18,0.812,23,0.553,41,2.129,64,1.302,75,2.828,90,2.583,95,2.583,111,2.619,112,3.371,145,0.605,148,0.849,186,4.024,207,1.027,263,2.696,289,3.752,392,1.119,411,1.224,412,1.019,452,3.602,680,4.192,681,1.848,682,4.573]],["title/223",[19,1.671,23,0.672,400,4.229,412,1.239,484,3.884]],["description/223",[7,0.891,8,0.234,12,1.15,14,1.266,18,0.855,19,1.474,23,0.593,24,1.807,50,1.527,60,3.615,102,1.942,145,0.649,148,0.61,299,2.771,398,2.7,400,3.73,411,1.313,412,1.896,484,3.426,660,3.615,683,3.515,684,4.496,685,4.905]],["title/224",[6,2.342,143,2.818,207,1.533]],["description/224",[5,1.837,6,2.285,8,0.262,18,0.792,36,1.896,49,2.891,50,2.073,143,2.75,145,0.585,148,0.55,207,1.496,226,2.097,248,3.17,263,2.608,346,3.484,392,1.083,411,1.184,412,0.985,686,4.424,687,4.424,688,4.424,689,4.424,690,4.424,691,4.424]],["title/225",[7,1.01,12,1.303,23,0.672,246,3.985,692,3.884]],["description/225",[7,1.139,8,0.235,16,1.214,18,1.017,23,0.758,143,2.589,145,0.83,148,0.78,207,1.409,367,4.184,398,3.451,411,1.679,412,1.397,693,6.271,694,6.271]],["title/226",[7,0.924,12,1.193,16,0.986,23,0.615,207,1.143,246,3.647]],["description/226",[7,1.166,8,0.239,16,1.243,18,1.034,23,0.776,145,0.849,148,0.799,207,1.442,367,4.283,398,3.533,411,1.719,412,1.43,695,6.42,696,6.42]],["title/227",[12,1.303,62,2.012,207,1.249,656,2.46,697,3.634]],["description/227",[8,0.224,16,1.135,18,0.971,61,3.076,62,2.121,145,0.776,148,0.729,207,1.835,284,2.859,392,1.435,411,1.57,412,1.82,656,2.594,698,5.374,699,5.374,700,5.863]],["title/228",[12,1.437,26,2.152,207,1.377,236,3.373]],["description/228",[8,0.231,207,1.891,236,4.634,348,4.321,701,7.717,702,8.42]],["title/229",[126,1.484,143,2.102,160,2.837,207,1.659,406,3.647]],["description/229",[8,0.235,12,1.47,18,1.017,126,1.829,143,2.589,145,0.83,148,0.78,160,3.496,207,1.922,392,1.535,406,4.494,411,1.679,412,1.397,703,6.271]],["title/230",[12,1.303,207,1.249,324,4.099,412,1.239,697,3.634]],["description/230",[5,1.819,8,0.243,14,1.124,16,0.843,36,2.82,50,2.048,61,4.161,126,1.269,160,3.667,207,0.978,237,2.493,412,2.114,697,5.182,704,3.208,705,4.352,706,3.571,707,3.989,708,3.989,709,3.989,710,4.352]],["title/231",[12,1.303,23,0.672,83,1.583,207,1.249,692,3.884]],["description/231",[8,0.251,18,1.086,83,1.967,88,2.4,145,0.915,148,0.86,392,1.692,411,1.851,412,1.54,692,4.828,711,6.913]],["title/232",[12,1.303,23,0.672,126,1.622,207,1.249,406,3.985]],["description/232",[8,0.243,12,1.541,18,1.05,88,2.283,126,1.918,145,0.87,148,0.818,207,1.477,392,1.61,406,4.712,411,1.761,412,1.465,712,6.576]],["title/233",[12,1.193,23,0.615,207,1.659,236,2.801,357,3.203]],["description/233",[8,0.231,12,1.437,18,1.001,88,2.128,145,0.811,147,2.607,148,0.763,207,1.377,236,3.373,267,4.828,357,3.857,381,3.79,411,1.641,713,4.517,714,3.56,715,6.129]],["title/234",[12,1.303,23,0.672,207,1.249,235,2.201,272,3.634]],["description/234",[8,0.239,16,1.243,18,1.034,50,1.999,88,2.229,145,0.849,148,0.799,207,1.442,235,2.541,392,1.571,411,1.719,412,1.43,716,5.531,717,6.42]],["title/235",[12,1.1,23,0.567,207,1.563,236,2.582,357,2.953,718,4.043]],["description/235",[8,0.231,12,1.437,18,1.001,88,2.128,145,0.811,147,2.607,148,0.763,207,1.377,236,3.373,357,3.857,411,1.641,713,4.517,714,3.56,718,5.28,719,6.129,720,6.129]],["title/236",[12,1.193,23,0.615,207,1.143,235,2.015,272,3.326,349,3.87]],["description/236",[8,0.239,16,1.243,18,1.034,23,0.776,50,1.999,145,0.849,148,0.799,235,2.541,392,1.571,411,1.719,412,1.43,660,4.732,716,5.531,721,6.42]],["title/237",[12,1.193,23,0.615,207,1.143,656,2.252,697,3.326,722,4.665]],["description/237",[8,0.221,16,1.111,18,0.957,23,0.694,61,3.011,145,0.759,148,0.714,207,1.808,284,2.798,392,1.405,411,1.536,412,1.792,656,2.539,698,5.26,699,5.26,722,5.26,723,5.739]],["title/238",[12,1.1,23,0.567,207,1.054,235,1.857,267,3.696,272,3.066,349,3.568]],["description/238",[7,1.166,8,0.239,16,1.243,18,1.034,23,0.776,50,1.999,145,0.849,147,2.731,148,0.799,235,2.541,411,1.719,714,3.729,716,5.531,724,6.42]],["title/239",[12,1.193,23,0.615,207,1.143,236,2.801,713,3.751,725,4.665]],["description/239",[8,0.231,12,1.437,18,1.001,88,2.128,145,0.811,147,2.607,148,0.763,207,1.377,236,3.373,267,4.828,368,5.28,381,3.79,411,1.641,713,4.517,714,3.56,726,6.129]],["title/240",[12,1.1,23,0.567,207,1.054,236,2.582,713,3.458,718,4.043,725,4.301]],["description/240",[8,0.224,12,1.374,16,1.135,18,0.971,88,2.035,145,0.776,148,0.729,207,1.317,236,3.227,368,5.051,381,3.626,407,2.977,411,1.57,412,1.306,713,4.321,727,5.863,728,5.863,729,5.863]],["title/241",[12,1.437,23,0.741,207,1.377,236,3.373]],["description/241",[8,0.247,12,1.58,18,1.068,88,2.34,145,0.892,147,2.867,148,0.839,207,1.514,236,3.71,411,1.805,714,3.915,730,6.74]],["title/242",[12,1.303,23,0.672,126,1.622,207,1.249,681,2.248]],["description/242",[8,0.243,12,1.541,18,1.05,88,2.283,126,1.918,145,0.87,148,0.818,207,1.477,392,1.61,681,2.658,731,5.001,732,5.18,733,6.576]],["title/243",[23,0.825,514,3.622,692,4.767]],["description/243",[8,0.251,18,1.086,24,1.737,145,0.915,148,0.86,392,1.692,411,1.851,412,1.54,514,3.669,692,4.828,734,6.913]],["title/244",[23,0.672,143,2.296,207,1.249,357,3.5,514,2.952]],["description/244",[8,0.247,18,1.068,88,2.34,143,2.783,145,0.892,148,0.839,357,4.242,392,1.65,411,1.805,412,1.501,514,3.577,735,6.74]],["title/245",[7,1.01,12,1.303,23,0.672,144,1.355,412,1.239]],["description/245",[8,0.252,12,1.858,14,1.451,18,0.943,23,0.679,24,1.412,99,4.273,144,1.932,145,0.743,148,0.699,392,1.375,411,1.504,412,1.766,660,4.141,736,4.273,737,5.619]],["title/246",[16,1.322,23,0.825,207,1.533]],["description/246",[7,1.194,8,0.243,12,1.541,16,1.274,18,1.05,24,1.653,145,0.87,148,0.818,207,1.477,392,1.61,411,1.761,412,1.465,738,6.576]],["title/247",[16,1.077,23,0.672,83,1.583,207,1.249,235,2.201]],["description/247",[7,1.139,8,0.235,12,1.47,16,1.214,18,1.017,24,1.576,83,1.785,145,0.83,148,0.78,207,1.409,235,2.482,392,1.535,411,1.679,412,1.397,739,6.271]],["title/248",[16,1.187,26,2.152,207,1.377,226,2.905]],["description/248",[8,0.247,12,1.58,18,1.068,145,0.892,148,0.839,207,1.514,226,3.195,348,3.459,392,1.65,411,1.805,412,1.501,740,6.74]],["title/249",[16,1.077,200,3.23,207,1.249,412,1.239,697,3.634]],["description/249",[8,0.221,14,1.481,16,1.558,36,2.46,50,1.786,61,4.222,126,1.673,160,3.199,207,1.808,412,1.792,697,5.259,704,4.229,741,3.914,742,5.26,743,5.739]],["title/250",[6,2.103,143,2.531,207,1.377,357,3.857]],["description/250",[8,0.243,18,1.05,114,2.283,143,2.715,145,0.87,148,0.818,207,1.477,357,4.138,392,1.61,411,1.761,412,1.465,744,6.576,745,6.576]],["title/251",[37,2.918,207,1.249,589,4.38,746,5.097,747,5.097]],["description/251",[8,0.218,16,1.535,207,2.241,589,6.244,746,7.265,747,7.265,748,7.926]],["title/252",[16,1.187,177,3.18,207,1.377,226,2.905]],["description/252",[8,0.247,16,1.305,18,1.068,145,0.892,148,0.839,207,1.514,226,3.195,392,1.65,411,1.805,412,1.501,749,4.497,750,6.74]],["title/253",[12,1.437,62,2.218,207,1.377,692,4.28]],["description/253",[8,0.255,18,1.105,62,2.567,145,0.939,148,0.883,398,3.904,411,1.899,412,1.58,692,4.954,751,7.094]],["title/254",[62,2.47,143,2.818,207,1.533]],["description/254",[8,0.251,18,1.086,62,2.501,143,2.854,145,0.915,148,0.86,207,1.553,392,1.692,411,1.851,412,1.54,752,6.913]],["title/255",[6,2.103,12,1.437,207,1.377,692,4.28]],["description/255",[6,2.313,8,0.247,16,1.305,18,1.068,145,0.892,148,0.839,207,1.514,392,1.65,411,1.805,412,1.501,692,4.707,753,6.74]],["title/256",[16,1.077,19,1.671,145,0.736,207,1.249,754,4.791]],["description/256",[8,0.211,16,1.491,19,2.313,145,1.019,207,1.73,335,4.238,416,5.518,754,6.634,755,7.701]],["title/257",[106,2.853,202,4.517,588,4.28,637,3.462]],["description/257",[6,1.382,8,0.208,14,1.04,19,1.21,28,2.113,32,1.7,36,1.727,50,1.254,80,2.45,106,1.875,144,1.511,148,0.501,202,5.572,207,0.905,412,0.897,502,1.594,514,3.291,587,2.632,588,5.93,637,4.797,741,2.747,756,5.342,757,3.692,758,3.692,759,3.173,760,3.692,761,3.692,762,4.028]],["title/258",[32,2.587,202,4.517,588,4.28,637,3.462]],["description/258",[6,1.382,8,0.208,14,1.04,19,1.21,28,2.113,32,1.7,36,1.727,50,1.254,80,2.45,106,1.875,144,1.511,148,0.501,202,5.572,207,0.905,412,0.897,502,1.594,514,3.291,587,2.632,588,5.93,637,4.797,741,2.747,756,5.342,757,3.692,758,3.692,759,3.173,760,3.692,761,3.692,763,4.028]],["title/259",[7,0.924,16,0.986,324,3.751,355,3.147,764,4.176,765,4.665]],["description/259",[7,1.139,8,0.235,14,1.619,16,1.214,143,2.589,183,3.878,207,1.409,355,5.291,357,3.946,459,5.145,764,5.145,765,5.748,766,5.748,767,6.271,768,6.271]],["title/260",[207,1.73,422,3.755]],["description/260",[5,2.06,207,2.42,422,4.379]],["title/261",[7,0.924,12,1.193,23,0.615,207,1.143,246,3.647,422,2.482]],["description/261",[7,0.907,8,0.2,13,3.038,16,0.968,18,0.866,23,0.604,50,1.555,71,1.422,82,2.141,83,1.422,84,2.228,86,2.192,142,3.038,143,2.063,145,0.661,148,0.622,207,1.637,367,3.333,392,1.223,411,1.338,412,1.113,769,4.996,770,4.996,771,4.579,772,4.996]],["title/262",[16,1.077,18,0.661,207,1.768,422,2.712]],["description/262",[8,0.251,18,1.216,145,0.915,148,0.86,207,1.553,392,1.692,411,1.851,412,1.54,422,3.371,773,6.913]],["title/263",[16,1.077,120,1.887,207,1.768,422,2.712]],["description/263",[8,0.251,18,1.086,120,2.346,145,0.915,148,0.86,207,1.553,392,1.692,411,1.851,412,1.54,422,3.371,774,6.913]],["title/264",[23,0.741,83,1.744,207,1.377,775,5.617]],["description/264",[8,0.247,18,1.068,83,1.918,88,2.34,145,0.892,147,2.867,148,0.839,207,1.514,411,1.805,714,3.915,775,6.178,776,6.74]],["title/265",[23,0.741,207,1.377,422,2.989,777,5.617]],["description/265",[8,0.221,18,0.957,24,1.442,82,2.46,83,1.633,84,2.56,145,0.759,148,0.714,392,1.405,411,1.536,412,1.792,422,3.924,741,3.914,777,5.26,778,5.739,779,4.708,780,5.739]],["title/266",[23,0.672,144,1.355,207,1.249,422,2.712,781,3.793]],["description/266",[7,1.139,8,0.235,12,1.47,18,1.017,24,1.576,50,1.952,144,1.528,145,0.83,148,0.78,392,1.535,411,1.679,412,1.397,422,3.058,781,4.277,782,6.271]],["title/267",[19,1.529,23,0.615,83,1.449,207,1.143,422,2.482,783,4.665]],["description/267",[8,0.235,18,1.017,19,1.884,83,1.785,88,2.177,145,0.83,148,0.78,392,1.535,411,1.679,412,1.397,422,3.058,517,4.277,783,5.748,784,6.271,785,6.271]],["title/268",[26,1.788,39,3,207,1.659,422,2.482,701,4.665]],["description/268",[8,0.218,18,0.943,39,3.312,82,2.409,83,1.599,84,2.506,143,2.32,145,0.743,148,0.699,207,1.262,362,3.924,392,1.375,422,3.866,704,4.141,731,4.273,732,4.426,741,3.832,779,4.61,786,5.619]],["title/269",[6,2.342,207,1.533,422,3.328]],["description/269",[5,1.573,6,2.143,8,0.095,9,1.107,18,0.411,28,1.042,38,1.387,50,1.432,66,1.629,68,1.837,82,0.851,83,1.309,84,0.886,99,2.632,126,2,145,0.263,148,0.247,184,3.069,207,0.446,219,5.124,281,3.172,298,2.105,299,4.415,367,1.325,374,1.387,411,0.532,412,0.442,422,3.596,458,1.82,704,1.464,741,1.354,779,1.629,787,1.423,788,3.138,789,1.986,790,5.724,791,3.461,792,3.461,793,3.461,794,3.461,795,3.461,796,3.461,797,3.172,798,1.986,799,1.986,800,3.461,801,3.461,802,3.461,803,3.461,804,1.986]],["title/270",[37,2.671,144,1.24,207,1.143,422,2.482,660,3.751,805,4.009]],["description/270",[7,0.754,8,0.237,12,0.973,14,1.072,16,0.804,18,0.754,19,1.247,43,2.713,82,1.78,83,1.182,84,1.852,144,1.547,145,0.549,147,1.766,148,0.517,411,1.112,412,0.925,415,3.06,422,4.206,517,2.832,660,3.06,704,3.06,714,2.412,741,2.832,779,3.406,805,6.068,806,4.152,807,3.805,808,4.152]],["title/271",[12,1.303,62,2.012,207,1.768,422,2.712]],["description/271",[8,0.251,18,1.086,62,2.501,145,0.915,148,0.86,207,1.553,392,1.692,411,1.851,412,1.54,422,3.371,809,6.913]],["title/272",[207,1.73,410,4.186]],["description/272",[5,2.06,207,2.42,410,4.881]],["title/273",[6,2.342,410,3.71,781,4.655]],["description/273",[6,2.372,8,0.251,18,1.086,145,0.915,148,0.86,392,1.692,410,3.757,411,1.851,412,1.54,781,4.715,810,6.913]],["title/274",[6,2.103,16,1.187,207,1.377,410,3.331]],["description/274",[6,2.057,8,0.228,18,0.986,50,1.866,71,1.706,82,2.569,83,1.706,84,2.673,86,2.63,145,0.793,147,2.549,148,0.746,207,1.346,410,3.258,771,5.493,811,5.493,812,5.993]],["title/275",[62,2.47,410,3.71,781,4.655]],["description/275",[8,0.251,18,1.086,62,2.501,145,0.915,148,0.86,392,1.692,410,3.757,411,1.851,412,1.54,781,4.715,813,6.913]],["title/276",[7,0.924,12,1.193,23,0.615,246,3.647,410,2.767,412,1.134]],["description/276",[7,1.139,8,0.235,16,1.214,18,1.017,23,0.758,143,2.589,145,0.83,148,0.78,207,1.409,367,4.184,398,3.451,411,1.679,412,1.397,814,6.271,815,6.271]],["title/277",[12,1.303,62,2.012,207,1.768,410,3.023]],["description/277",[8,0.251,18,1.086,62,2.501,145,0.915,148,0.86,207,1.553,392,1.692,410,3.757,411,1.851,412,1.54,816,6.913]],["title/278",[23,0.825,410,3.71,781,4.655]],["description/278",[8,0.251,18,1.086,24,1.737,145,0.915,148,0.86,392,1.692,410,3.757,411,1.851,412,1.54,781,4.715,817,6.913]],["title/279",[23,0.825,410,3.71,514,3.622]],["description/279",[8,0.251,18,1.086,24,1.737,145,0.915,148,0.86,392,1.692,410,3.757,411,1.851,412,1.54,514,3.669,818,6.913]],["title/280",[23,0.741,144,1.494,410,3.331,781,4.18]],["description/280",[8,0.247,18,1.068,24,1.694,144,1.643,145,0.892,148,0.839,392,1.65,410,3.664,411,1.805,412,1.501,781,4.597,819,6.74]],["title/281",[71,1.943,83,1.943,207,1.533]],["description/281",[5,1.994,71,2.474,83,2.474,207,2.373]],["title/282",[23,0.672,117,2.612,820,5.097,821,5.561,822,3.634]],["description/282",[8,0.239,18,1.034,119,2.577,120,2.178,145,0.849,148,0.799,174,2.989,398,3.533,411,1.719,412,1.43,820,5.884,822,4.196,823,6.42,824,6.42]],["title/283",[7,1.01,16,1.077,18,0.661,825,3.382,826,4.791]],["description/283",[6,2.891,7,0.721,8,0.168,9,2.213,14,1.025,16,0.769,17,2.498,18,0.472,30,3.146,120,1.347,143,3.093,148,0.763,207,1.377,411,1.641,825,5.854,827,3.419,828,3.256,829,4.662,830,2.844,831,3.638,832,3.419,833,3.638,834,3.638,835,5.619,836,3.969]],["title/284",[7,1.01,16,1.077,120,1.887,825,3.382,826,4.791]],["description/284",[6,2.644,7,0.754,8,0.212,9,2.315,14,1.072,16,0.804,17,2.613,18,0.494,30,3.257,36,1.78,50,1.292,143,3.181,148,0.79,207,1.426,381,2.567,411,1.699,476,2.567,825,5.652,829,3.157,832,3.577,834,3.805,835,5.817,837,3.805,838,4.152]],["title/285",[23,0.672,110,3.278,529,3.884,530,3.793,822,3.634]],["description/285",[8,0.247,18,1.068,24,1.694,113,3.423,145,0.892,148,0.839,392,1.65,411,1.805,412,1.501,529,4.707,530,4.597,839,6.74]],["title/286",[16,0.909,200,2.726,207,1.054,764,3.85,840,4.301,841,4.301,842,2.766]],["description/286",[2,2.122,5,1.573,7,0.628,8,0.188,14,0.893,16,0.67,18,0.655,75,2.14,76,1.955,82,1.483,83,0.985,84,1.544,86,1.519,120,1.174,145,0.458,148,0.431,182,1.776,207,0.777,258,2.262,261,3.482,392,0.847,411,0.927,412,0.771,483,4.058,603,1.495,764,4.518,840,5.046,841,5.046,843,5.506,844,3.11,845,5.506,846,3.461,847,2.982,848,3.461,849,3.461,850,3.461,851,3.461]],["title/287",[23,0.615,110,3,412,1.134,529,3.555,530,3.471,822,3.326]],["description/287",[8,0.239,18,1.034,24,1.614,71,1.827,145,0.849,148,0.799,392,1.571,411,1.719,412,1.937,529,4.484,530,4.379,822,4.196,852,6.42]],["title/288",[7,0.924,12,1.193,23,0.615,117,2.391,825,3.095,826,4.385]],["description/288",[6,1.851,7,0.98,8,0.247,14,1.393,16,1.045,18,0.641,50,1.679,119,2.165,120,1.831,143,3.181,174,2.511,207,1.212,411,1.444,825,3.281,829,4.102,830,3.866,831,4.945,832,4.648,833,4.945,837,4.945,853,5.395]],["title/289",[23,0.672,105,2.885,119,2.232,120,1.887,854,5.097]],["description/289",[8,0.231,18,1.001,71,1.744,105,3.18,119,2.46,120,2.08,145,0.811,148,0.763,174,2.853,392,1.5,411,1.641,412,1.876,854,5.617,855,6.129,856,6.129]],["title/290",[26,2.152,412,1.365,587,4.005,857,3.51]],["description/290",[7,0.96,8,0.244,14,1.365,18,0.903,66,4.34,114,2.637,126,1.542,145,0.7,148,0.658,407,2.686,412,1.692,502,3.006,587,3.457,588,3.694,759,4.166,857,3.029,858,5.289,859,5.289,860,5.289]],["title/291",[23,0.672,117,2.612,403,2.248,861,5.097,862,5.097]],["description/291",[8,0.243,18,1.05,23,0.795,117,3.089,145,0.87,148,0.818,392,1.61,403,2.658,411,1.761,412,1.465,861,6.027,862,6.027,863,6.576]],["title/292",[207,1.73,864,6.318]],["description/292",[5,2.06,207,2.42,864,7.368]],["title/293",[16,0.986,207,1.143,328,3.326,412,1.134,865,3.751,866,4.385]],["description/293",[5,1.317,8,0.221,14,0.942,16,1.695,18,0.682,36,2.46,50,1.787,64,1.038,84,1.627,135,1.614,145,0.483,148,0.714,160,2.033,207,1.808,328,4.638,392,0.893,411,1.537,412,1.279,476,2.256,706,2.993,828,2.993,865,4.23,867,2.993,868,2.978,869,3.142,870,3.648,871,3.648]],["title/294",[16,1.187,168,3.857,207,1.377,328,4.005]],["description/294",[5,1.534,8,0.23,14,0.86,16,1.73,18,0.635,32,1.407,36,2.29,50,1.663,105,1.729,135,2.958,145,0.441,148,0.415,168,3.362,207,1.718,328,4.999,355,2.061,360,3.054,392,0.816,411,1.43,412,0.742,828,2.734,864,2.734,865,2.456,867,2.734,868,1.729,872,2.871,873,2.734,874,3.054,875,3.054,876,3.333,877,3.333]],["title/295",[16,1.187,168,3.857,207,1.377,878,5.028]],["description/295",[5,1.528,8,0.245,14,1.142,16,1.29,18,0.792,36,2.854,50,2.073,135,2.946,145,0.585,148,0.55,207,1.496,328,4.352,391,2.466,398,2.435,411,1.184,412,0.985,828,5.464,865,3.26,868,3.455,869,3.811,875,4.054,879,4.424]],["title/296",[16,1.077,207,1.249,328,3.634,412,1.239,697,3.634]],["description/296",[5,1.474,8,0.239,11,1.356,14,0.81,16,1.431,18,0.763,36,2.753,50,1.999,61,1.647,105,1.629,135,2.252,145,0.415,148,0.391,160,2.838,168,3.204,207,1.66,328,3.327,355,1.941,392,0.768,412,1.646,476,1.941,652,2.473,697,3.327,704,2.314,706,2.576,709,2.877,742,2.877,869,2.704,872,4.386,873,2.576,880,3.139,881,3.139]],["title/297",[16,1.077,207,1.249,412,1.239,865,4.099,878,4.563]],["description/297",[8,0.243,16,1.274,18,1.05,145,0.87,148,0.818,207,1.985,392,1.61,411,1.761,412,1.465,865,4.847,878,5.396,882,6.576]],["title/298",[16,1.077,207,1.249,412,1.239,697,3.634,878,4.563]],["description/298",[8,0.244,14,1.365,16,1.471,36,3.255,50,1.647,179,4.34,184,3.529,207,1.706,328,3.457,412,1.692,697,4.963,706,4.34,707,4.848,708,6.961,864,4.34,883,5.289,884,5.289]],["title/299",[71,1.943,83,1.943,412,1.52]],["description/299",[5,1.994,71,2.474,83,2.474,207,1.952,412,1.936]],["title/300",[23,0.615,412,1.134,697,3.326,866,4.385,885,5.09,886,3.647]],["description/300",[8,0.231,88,2.923,163,3.403,704,6.206,886,6.034,887,8.42]],["title/301",[23,0.672,412,1.239,697,3.634,866,4.791,886,3.985]],["description/301",[8,0.231,24,2.116,741,5.743,886,6.034,888,8.42,889,8.42]],["title/302",[2,2.968,825,4.683]],["description/302",[2,3.461,5,2.06,207,2.017,825,5.461]],["title/303",[7,1.01,12,1.303,23,0.672,117,2.612,825,3.382]],["description/303",[8,0.2,12,1.708,24,1.831,602,5.369,713,5.369,825,4.431,890,5.369,891,7.285,892,4.86,893,5.739,894,7.285]],["title/304",[62,2.218,656,2.711,825,3.727,895,4.28]],["description/304",[8,0.224,62,2.955,412,1.819,656,3.613,895,5.703,896,6.7,897,8.166]],["title/305",[62,2.012,656,2.46,825,3.382,892,3.71,895,3.884]],["description/305",[8,0.224,62,2.955,656,3.613,895,5.703,896,6.7,898,8.166,899,8.166]],["title/306",[7,0.924,12,1.193,23,0.615,50,1.584,825,3.095,900,4.176]],["description/306",[7,1.288,8,0.195,28,3.722,50,2.208,64,2.019,118,5.228,119,2.847,123,3.856,825,4.314,900,5.821,901,7.094,902,7.094]],["title/307",[18,0.605,120,1.727,530,3.471,681,2.057,825,3.095,900,4.176]],["description/307",[7,1.255,8,0.19,16,1.339,18,0.822,28,3.627,120,2.346,135,3.058,207,1.553,681,2.794,825,4.204,903,6.913,904,6.913,905,6.913]],["title/308",[24,1.935,412,1.715]],["description/308",[5,2.06,24,2.257,207,2.017,412,2]],["title/309",[24,1.54,106,2.853,412,1.365,906,4.392]],["description/309",[8,0.239,15,5.057,18,1.034,24,1.614,64,1.827,145,0.849,148,0.799,344,3.579,392,1.571,411,1.719,412,1.937,906,4.6,907,6.42]],["title/310",[7,0.924,12,1.193,23,0.615,24,1.279,246,3.647,412,1.134]],["description/310",[7,1.113,8,0.231,16,1.187,18,1.001,23,0.741,143,2.531,145,0.811,148,0.763,207,1.377,367,4.089,398,3.373,411,1.641,412,1.876,908,6.129,909,6.129]],["title/311",[7,0.852,12,1.1,19,1.41,24,1.179,412,1.045,548,3.007,910,3.568]],["description/311",[7,1.139,8,0.172,12,1.47,19,2.57,24,1.576,76,3.543,102,2.482,135,2.774,395,4.622,412,1.397,548,4.019,754,5.403,910,4.768,911,6.271,912,6.271,913,6.271]],["title/312",[24,1.715,62,2.47,412,1.52]],["description/312",[8,0.247,18,1.068,24,1.694,62,2.439,145,0.892,148,0.839,392,1.65,411,1.805,412,2.001,910,5.125,914,6.74]],["title/313",[6,1.909,24,1.398,226,2.636,412,1.239,915,5.097]],["description/313",[8,0.218,14,1.451,18,0.943,24,1.412,50,1.749,68,2.982,129,5.29,145,0.743,148,0.699,226,3.758,325,4.273,392,1.375,411,1.504,412,1.766,915,5.15,916,5.619,917,5.619]],["title/314",[7,0.852,12,1.1,23,0.567,24,1.179,235,1.857,272,3.066,412,1.045]],["description/314",[7,1.113,8,0.231,16,1.187,18,1.001,23,0.741,145,0.811,148,0.763,235,2.426,246,4.392,272,4.005,392,1.5,411,1.641,412,1.876,918,6.129,919,6.129]],["title/315",[23,0.741,24,1.54,412,1.365,906,4.392]],["description/315",[8,0.247,18,1.068,24,1.694,145,0.892,147,2.867,148,0.839,411,1.805,412,1.501,714,3.915,906,4.83,920,5.807,921,6.74]],["title/316",[24,1.54,26,2.152,226,2.905,412,1.365]],["description/316",[8,0.247,18,1.068,145,0.892,147,2.867,148,0.839,226,3.195,348,3.459,412,1.501,731,5.125,920,5.807,922,6.74,923,6.74]],["title/317",[12,1.193,23,0.615,24,1.279,207,1.143,344,2.837,412,1.134]],["description/317",[8,0.239,12,1.505,18,1.034,24,1.614,145,0.849,148,0.799,174,2.989,344,3.579,392,1.571,411,1.719,412,1.937,906,4.6,924,6.42]],["title/318",[7,1.01,12,1.303,23,0.672,24,1.398,412,1.239]],["description/318",[8,0.224,12,1.914,24,2.555,412,1.819,910,6.209,925,8.166]],["title/319",[16,0.986,24,1.279,32,2.149,344,2.837,412,1.134,926,4.665]],["description/319",[8,0.218,12,1.858,24,1.992,32,3.346,344,4.419,412,1.766,906,5.68,927,7.926]],["title/320",[24,1.398,26,1.953,213,3.439,412,1.239,489,4.229]],["description/320",[8,0.239,18,1.034,145,0.849,148,0.799,213,3.97,362,4.484,392,1.571,411,1.719,412,1.937,489,4.882,910,4.882,920,5.531,928,6.42]],["title/321",[6,2.342,24,1.715,412,1.52]],["description/321",[6,2.313,8,0.247,18,1.068,24,1.694,145,0.892,148,0.839,392,1.65,411,1.805,412,2.001,910,5.125,929,6.74]],["title/322",[262,2.41,562,3.668,930,5.617,931,3.727]],["description/322",[5,1.932,207,1.891,262,3.311,562,5.04,930,7.717,931,5.121]],["title/323",[62,2.218,262,2.41,931,3.727,932,5.617]],["description/323",[8,0.224,62,2.955,262,3.211,931,4.966,932,7.484,933,6.018,934,8.166]],["title/324",[262,2.41,548,3.928,931,3.727,935,4.66]],["description/324",[8,0.224,262,3.211,548,5.234,931,4.966,933,6.018,935,6.209,936,8.166]],["title/325",[262,2.41,548,3.928,931,3.727,937,5.028]],["description/325",[8,0.224,262,3.211,548,5.234,931,4.966,933,6.018,937,6.7,938,8.166]],["title/326",[145,0.903,262,2.683,931,4.151]],["description/326",[8,0.231,145,1.114,262,3.311,931,5.121,933,6.206,939,8.42]],["title/327",[23,0.615,123,2.767,135,2.252,262,2.001,931,3.095,935,3.87]],["description/327",[8,0.211,16,1.491,24,1.935,262,3.028,931,4.683,933,5.675,935,5.855,940,7.058,941,7.701]],["title/328",[23,0.615,123,2.767,135,2.252,262,2.001,931,3.095,937,4.176]],["description/328",[8,0.211,16,1.491,24,1.935,262,3.028,931,4.683,933,5.675,937,6.318,940,7.058,942,7.701]],["title/329",[6,2.342,262,2.683,931,4.151]],["description/329",[8,0.2,14,1.29,50,1.555,55,4.304,102,1.978,129,5.74,135,2.21,137,3.144,148,0.907,262,3.382,288,3.58,343,4.099,827,4.304,931,4.432,933,3.682,943,4.996,944,4.996,945,4.996,946,4.996,947,4.996,948,4.996]],["title/330",[422,3.328,949,4.023,950,4.375]],["description/330",[5,1.994,207,1.952,422,4.238,949,5.123,950,5.571]],["title/331",[23,0.741,119,2.46,120,2.08,950,3.928]],["description/331",[7,1.439,8,0.218,16,1.535,119,3.181,120,2.69,174,3.69,950,5.08,951,7.926]],["title/332",[120,2.316,144,1.663,950,4.375]],["description/332",[7,1.483,8,0.224,12,1.914,120,2.771,144,1.99,950,5.234,952,8.166]],["title/333",[18,0.811,144,1.663,950,4.375]],["description/333",[7,1.483,8,0.224,12,1.914,18,0.971,144,1.99,950,5.234,953,8.166]],["title/334",[18,0.729,144,1.494,284,2.989,950,3.928]],["description/334",[7,1.439,8,0.218,12,1.858,18,0.942,144,1.932,895,5.536,950,5.08,954,7.926]],["title/335",[23,0.741,117,2.879,144,1.494,950,3.928]],["description/335",[7,1.439,8,0.218,12,1.858,23,0.958,117,3.723,144,1.932,955,7.926,956,7.926]],["title/336",[120,2.08,144,1.494,284,2.989,950,3.928]],["description/336",[7,1.439,8,0.218,12,1.858,120,2.69,144,1.932,895,5.536,950,5.08,957,7.926]],["title/337",[2,2.968,949,4.539]],["description/337",[2,3.461,5,2.06,207,2.017,949,5.293]],["title/338",[7,1.01,16,1.077,18,0.661,844,3.142,958,3.329]],["description/338",[7,1.194,8,0.243,16,1.274,18,1.186,145,0.87,148,0.818,392,1.61,422,3.207,844,3.715,949,3.877,958,3.936,959,6.576]],["title/339",[18,0.661,422,2.712,683,3.985,949,3.278,960,5.097]],["description/339",[8,0.239,13,3.904,18,1.172,145,0.849,148,0.799,392,1.571,411,1.719,412,1.43,844,3.627,949,3.784,958,3.843,960,5.884,961,6.42]],["title/340",[7,0.924,16,0.986,18,0.605,422,2.482,683,3.647,949,3]],["description/340",[5,1.587,7,0.637,8,0.216,12,0.822,14,0.905,16,0.679,18,0.936,36,1.503,50,1.091,71,0.998,82,1.503,83,0.998,84,1.564,86,1.538,111,2.008,120,1.888,145,0.464,148,0.692,160,1.954,196,2.168,214,1.744,392,0.858,422,3.839,656,1.551,683,4.955,844,1.98,949,5.061,958,2.098,962,3.506,963,3.506,964,3.02,965,3.506]],["title/341",[7,0.924,16,0.986,120,1.727,422,2.482,683,3.647,949,3]],["description/341",[5,1.56,7,0.62,8,0.213,14,0.882,16,0.662,18,0.808,36,1.465,50,1.064,71,0.973,82,1.465,83,0.973,84,1.524,86,1.5,111,1.957,120,2.307,145,0.452,147,1.453,148,0.678,160,1.905,196,2.113,214,1.7,422,3.316,656,1.512,683,4.872,844,1.93,893,2.691,896,2.804,949,5.589,958,2.045,964,2.944,966,3.417,967,3.417,968,3.417]],["title/342",[7,1.01,16,1.077,120,1.887,844,3.142,958,3.329]],["description/342",[8,0.247,16,1.305,18,1.068,120,2.287,145,0.892,148,0.839,392,1.65,422,3.287,844,3.808,949,3.973,958,4.034,969,6.74]],["title/343",[16,0.986,23,0.615,126,1.484,207,1.143,844,2.875,958,3.047]],["description/343",[8,0.247,16,1.305,18,1.068,88,2.34,126,1.965,145,0.892,148,0.839,392,1.65,844,3.808,958,4.034,970,6.74,971,6.74]],["title/344",[62,2.218,683,4.392,949,3.613,972,3.613]],["description/344",[8,0.215,16,1.759,62,1.992,64,1.567,143,2.273,145,0.728,148,0.685,183,3.404,207,2.041,332,4.743,683,5.599,893,4.336,949,4.606,972,4.606,973,5.505]],["title/345",[23,0.672,805,4.38,958,3.329,974,5.097,975,4.563]],["description/345",[8,0.211,24,1.935,65,4.473,805,6.066,844,4.35,958,4.609,974,7.058,975,6.318,976,7.701]],["title/346",[26,2.397,126,1.99,958,4.085]],["description/346",[8,0.158,14,1.481,16,1.111,19,1.724,23,0.694,82,2.46,83,1.633,84,2.56,114,1.992,126,2.347,259,3.914,443,4.52,524,4.364,844,4.546,958,4.817,977,4.52,978,5.739,979,5.739]],["title/347",[23,0.825,126,1.99,958,4.085]],["description/347",[8,0.158,14,1.481,16,1.111,23,0.694,24,1.442,82,2.46,83,1.633,84,2.56,86,2.518,114,1.992,126,1.673,259,3.914,443,4.52,680,5.26,844,4.546,958,4.817,977,4.52,980,5.739,981,5.739]],["title/348",[26,1.788,263,3,949,3,975,4.176,982,4.176,983,4.665]],["description/348",[5,1.819,8,0.181,9,2.426,14,1.124,18,0.943,36,1.866,50,1.355,82,1.866,83,1.239,84,1.941,86,1.91,126,1.269,145,0.576,148,0.542,263,2.566,398,2.395,422,3.208,844,2.459,949,5.21,958,2.605,964,3.75,975,3.571,982,3.571,983,3.989,984,4.352,985,4.352,986,4.352]],["title/349",[873,5.6,949,4.023,987,2.926]],["description/349",[5,1.994,207,1.952,873,7.131,949,5.123,987,3.725]],["title/350",[16,1.077,18,0.661,120,1.887,207,1.249,987,2.384]],["description/350",[8,0.243,16,1.274,18,1.186,120,2.232,145,0.87,147,2.797,148,0.818,207,1.477,411,1.761,714,3.82,987,2.819,988,6.576]],["title/351",[106,2.369,141,3.87,143,2.102,207,1.143,613,3.326,987,2.182]],["description/351",[8,0.247,18,1.068,145,0.892,147,2.867,148,0.839,207,1.514,411,1.805,613,4.405,656,2.982,714,3.915,989,6.74,990,6.74]],["title/352",[61,3.216,160,3.417,656,2.711,987,2.627]],["description/352",[8,0.247,18,1.068,61,3.537,145,0.892,148,0.839,411,1.805,412,1.501,656,2.982,787,4.83,987,2.889,991,5.807,992,6.74]],["title/353",[16,1.077,23,0.672,788,3.793,987,2.384,993,4.563]],["description/353",[8,0.212,18,0.916,24,1.356,62,1.952,88,1.873,114,1.873,145,0.714,148,0.671,160,3.008,285,3.768,392,1.32,411,1.444,412,1.202,613,3.526,656,2.387,788,5.254,987,3.302,993,4.426,994,3.866,995,5.395]],["title/354",[16,1.077,23,0.672,788,3.793,987,2.384,996,4.563]],["description/354",[8,0.209,18,0.903,24,1.329,62,1.914,88,1.836,114,1.836,145,0.7,148,0.658,160,2.949,285,3.694,392,1.295,411,1.416,412,1.178,613,3.457,656,2.34,788,5.18,987,3.255,994,3.79,996,4.34,997,4.34,998,5.289]],["title/355",[23,0.567,61,2.462,533,3.568,807,4.301,987,2.011,999,4.692,1000,4.301]],["description/355",[8,0.235,18,1.017,23,0.758,61,3.29,99,4.768,145,0.83,147,2.668,148,0.78,207,1.409,411,1.679,533,4.768,714,3.643,987,2.688,1000,5.748,1001,6.271]],["title/356",[23,0.672,207,1.249,284,2.712,987,2.384,1002,3.634]],["description/356",[8,0.243,18,1.05,88,2.283,145,0.87,148,0.818,207,1.477,392,1.61,411,1.761,412,1.465,656,2.909,987,2.819,1002,4.298,1003,6.576]],["title/357",[16,0.986,24,1.279,106,2.369,207,1.143,741,3.471,1004,4.665]],["description/357",[8,0.239,18,1.034,145,0.849,148,0.799,207,1.442,407,3.26,411,1.719,412,1.43,613,4.196,656,2.84,741,4.379,896,5.268,1004,5.884,1005,6.42]],["title/358",[207,1.143,357,3.203,391,2.837,656,2.252,987,2.182,1002,3.326]],["description/358",[8,0.231,18,1.001,126,1.787,145,0.811,147,2.607,148,1.048,207,1.377,357,3.857,391,3.417,411,1.641,656,2.711,714,3.56,987,2.627,1002,4.005,1006,6.129]],["title/359",[16,1.187,26,2.152,987,2.627,996,5.028]],["description/359",[8,0.212,18,0.916,62,1.952,114,1.873,126,1.573,145,0.714,148,0.671,160,3.008,285,3.768,392,1.32,411,1.444,412,1.202,613,3.526,656,2.387,788,5.254,987,3.302,994,3.866,996,4.426,997,4.426,1007,5.395]],["title/360",[137,3.5,656,2.46,972,3.278,987,2.384,1002,3.634]],["description/360",[8,0.243,18,1.05,137,4.138,145,0.87,148,0.818,407,3.339,656,2.909,731,5.001,732,5.18,972,3.877,987,2.819,1002,4.298,1008,6.576]],["title/361",[12,1.193,23,0.615,207,1.143,656,2.252,987,2.182,1009,4.665]],["description/361",[8,0.239,12,1.505,18,1.034,23,0.776,24,1.614,61,3.369,145,0.849,148,0.799,392,1.571,411,1.719,412,1.43,656,2.84,987,2.752,1010,6.42]],["title/362",[16,1.187,26,2.152,987,2.627,993,5.028]],["description/362",[8,0.215,18,0.929,62,1.992,114,1.911,126,1.605,145,0.728,148,0.685,160,3.069,285,3.844,392,1.347,411,1.474,412,1.226,613,3.598,656,2.435,788,5.33,987,3.35,993,4.517,994,3.944,1011,5.505]],["title/363",[106,2.369,143,2.102,207,1.143,476,3.147,613,3.326,987,2.182]],["description/363",[8,0.241,14,1.339,18,0.89,36,2.224,50,1.615,61,2.722,88,1.801,145,0.686,147,2.207,148,0.645,207,1.682,411,1.389,613,3.39,656,3.313,714,3.013,987,2.224,1012,7.49,1013,4.47,1014,5.188,1015,5.188]],["title/364",[16,1.077,23,0.672,788,3.793,987,2.384,1016,4.563]],["description/364",[8,0.221,18,0.957,24,1.442,88,1.992,114,1.992,145,0.759,148,0.714,207,1.289,285,4.008,392,1.405,411,1.536,412,1.278,788,5.488,987,3.449,991,4.944,1016,4.708,1017,5.739]],["title/365",[12,1.303,23,0.672,114,1.931,207,1.249,987,2.384]],["description/365",[8,0.247,12,1.58,18,1.068,88,2.34,114,2.34,145,0.892,147,2.867,148,0.839,411,1.805,714,3.915,987,2.889,1018,6.74]],["title/366",[23,0.825,410,3.71,987,2.926]],["description/366",[8,0.231,18,1.001,24,1.54,88,2.128,143,2.531,145,0.811,147,2.607,148,0.763,207,1.892,410,3.331,411,1.641,656,2.711,714,3.56,987,2.627,1019,6.129]],["title/367",[19,1.671,23,0.672,868,2.885,972,3.278,987,2.384]],["description/367",[8,0.239,12,1.505,18,1.034,19,1.929,23,0.776,145,0.849,148,0.799,411,1.719,412,1.43,787,4.6,868,3.331,972,3.784,987,2.752,1020,6.42]],["title/368",[16,0.986,23,0.615,50,1.584,119,2.043,207,1.143,987,2.182]],["description/368",[8,0.239,16,1.243,18,1.034,119,2.577,120,2.178,145,0.849,148,0.799,174,2.989,207,1.442,411,1.719,412,1.43,787,4.6,987,2.752,1021,6.42]],["title/369",[61,3.216,62,2.218,656,2.711,987,2.627]],["description/369",[8,0.247,18,1.068,61,3.537,62,2.439,145,0.892,147,2.867,148,0.839,411,1.805,656,2.982,714,3.915,987,2.889,1022,6.74]],["title/370",[23,0.741,207,1.377,987,2.627,1002,4.005]],["description/370",[8,0.247,18,1.068,24,1.694,145,0.892,147,2.867,148,0.839,207,1.514,411,1.805,714,3.915,987,2.889,1002,4.405,1023,6.74]],["title/371",[12,1.303,26,1.953,114,1.931,207,1.249,987,2.384]],["description/371",[8,0.247,12,1.58,18,1.068,114,2.34,145,0.892,147,2.867,148,0.839,362,4.707,411,1.805,714,3.915,987,2.889,1024,6.74]],["title/372",[106,2.589,143,2.296,207,1.249,410,3.023,987,2.384]],["description/372",[8,0.231,18,1.001,24,1.54,106,2.853,143,2.531,145,0.811,147,2.607,148,0.763,207,1.892,410,3.331,411,1.641,656,2.711,714,3.56,987,2.627,1025,6.129]],["title/373",[16,1.187,26,2.152,987,2.627,1016,5.028]],["description/373",[8,0.224,18,0.971,114,2.035,126,1.71,145,0.776,148,0.729,207,1.317,285,4.095,392,1.435,411,1.57,412,1.306,788,5.571,987,3.501,991,5.051,1016,4.81,1026,5.863]],["title/374",[37,2.918,184,3.71,220,3.793,656,2.46,987,2.384]],["description/374",[8,0.239,18,1.034,42,5.268,61,3.369,145,0.849,147,2.731,148,0.799,184,4.283,284,3.131,411,1.719,656,2.84,987,2.752,1027,6.42,1028,6.42]],["title/375",[93,3.684,681,3.112]],["description/375",[5,2.06,93,4.296,207,2.017,681,3.629]],["title/376",[23,0.741,113,3.112,406,4.392,681,2.477]],["description/376",[8,0.243,12,1.541,18,1.05,24,1.653,113,3.339,145,0.87,148,0.818,406,4.712,407,3.339,411,1.761,412,1.465,681,2.658,1029,6.576]],["title/377",[95,4.35,681,3.112]],["description/377",[5,2.06,95,5.073,207,2.017,681,3.629]],["title/378",[6,2.103,95,3.462,681,2.477,872,5.28]],["description/378",[0,2.107,1,2.329,5,1.797,6,1.314,7,0.695,8,0.184,14,0.576,16,0.741,17,1.404,23,0.721,36,0.957,41,1.782,43,1.459,50,1.192,51,2.611,52,2.674,64,1.09,68,1.185,71,0.635,95,3.368,160,1.244,168,1.404,196,1.38,226,2.383,263,3.515,298,1.357,328,1.459,355,2.368,415,2.822,452,1.758,645,3.223,651,2.046,656,1.694,681,2.032,868,1.158,1030,1.645,1031,2.232,1032,2.232,1033,2.232,1034,1.923,1035,1.758,1036,1.831,1037,1.923,1038,1.923,1039,1.923,1040,1.923,1041,3.706,1042,1.923,1043,1.923,1044,1.923,1045,1.923,1046,1.923,1047,1.923,1048,2.232]],["title/379",[6,1.909,64,1.583,95,3.142,123,3.023,681,2.248]],["description/379",[0,2.629,1,3.011,5,1.83,6,1.041,7,0.551,8,0.083,17,1.909,23,0.875,41,1.412,50,0.944,51,3.377,52,3.458,64,0.863,71,0.863,95,3.544,105,1.574,160,1.691,263,4.268,298,1.845,355,1.876,415,3.649,645,4.021,656,2.19,681,1.226,868,1.574,1030,2.236,1035,2.389,1036,2.489,1037,2.613,1038,2.613,1039,2.613,1040,2.613,1041,4.623,1042,2.613,1043,2.613,1044,2.613,1045,2.613,1046,2.613,1047,2.613,1049,3.033]],["title/380",[6,2.342,95,3.856,681,2.758]],["description/380",[0,2.55,1,2.905,5,1.788,6,0.996,7,0.867,8,0.08,14,0.749,16,0.562,17,1.827,23,0.852,41,1.351,50,0.904,51,3.258,52,3.336,64,1.359,71,0.826,95,3.437,160,1.618,263,4.156,298,1.766,355,1.795,415,3.52,645,3.9,656,2.113,681,1.93,868,1.506,1030,2.14,1035,2.287,1036,2.382,1037,2.501,1038,2.501,1039,2.501,1040,2.501,1041,4.485,1042,2.501,1043,2.501,1044,2.501,1045,2.501,1046,2.501,1047,2.501,1050,2.903]],["title/381",[6,1.909,30,2.854,64,1.583,95,4.446]],["description/381",[0,1.12,5,1.317,6,2.557,7,0.81,8,0.221,11,1.155,26,1.567,41,3.12,50,0.832,56,2.106,64,2.43,80,3.491,90,2.52,95,4.547,113,1.357,145,0.354,148,0.333,177,1.387,196,2.759,258,1.747,261,1.357,405,1.088,448,1.6,475,2.193,533,2.033,534,1.867,681,1.08,1002,1.747,1030,5.932,1051,2.673,1052,1.916,1053,2.673,1054,2.45,1055,2.45,1056,2.673,1057,2.673,1058,2.673,1059,2.673,1060,2.673]],["title/382",[16,1.491,314,3.379]],["description/382",[5,2.06,16,1.739,19,2.697,314,3.941]],["title/383",[6,2.342,16,1.322,314,2.995]],["description/383",[6,2.435,8,0.255,16,1.374,18,1.105,145,0.939,148,0.883,314,4.078,392,1.736,1061,7.094]],["title/384",[16,1.322,62,2.47,314,2.995]],["description/384",[8,0.255,16,1.374,18,1.105,62,2.567,145,0.939,148,0.883,314,4.078,392,1.736,1062,7.094]],["title/385",[16,1.077,23,0.672,30,2.854,119,2.232,314,2.441]],["description/385",[8,0.231,14,1.582,16,1.864,23,0.741,30,4.939,119,2.46,174,2.853,232,4.392,314,4.224,653,4.28,1063,6.129]],["title/386",[12,1.437,23,0.741,236,3.373,314,2.69]],["description/386",[8,0.251,12,1.62,18,1.086,145,0.915,148,0.86,174,3.218,236,3.805,314,3.034,1064,6.913,1065,6.913,1066,6.913]],["title/387",[12,1.303,23,0.672,314,2.441,656,2.46,1067,4.563]],["description/387",[7,1.194,8,0.243,12,1.541,18,1.05,88,2.283,145,0.87,148,0.818,314,3.878,392,1.61,656,2.909,1067,5.396,1068,6.576]],["title/388",[16,1.077,23,0.672,235,2.201,272,3.634,314,2.441]],["description/388",[8,0.243,16,1.274,18,1.05,24,1.653,83,1.872,145,0.87,148,0.818,235,2.603,272,4.298,314,3.878,392,1.61,1069,6.576]],["title/389",[12,1.437,26,2.152,226,2.905,314,2.69]],["description/389",[8,0.251,12,1.62,18,1.086,145,0.915,148,0.86,226,3.277,314,4.009,348,3.548,392,1.692,1070,6.913]],["title/390",[12,1.303,26,1.953,76,3.142,102,2.201,314,2.441]],["description/390",[8,0.247,16,1.305,18,1.068,76,3.808,102,2.668,145,0.892,148,0.839,314,3.942,348,3.459,392,1.65,1071,6.74]],["title/391",[12,1.437,26,2.152,236,3.373,314,2.69]],["description/391",[8,0.251,12,1.62,18,1.086,145,0.915,148,0.86,236,3.805,314,4.009,348,3.548,392,1.692,1072,6.913]],["title/392",[16,1.322,23,0.825,314,2.995]],["description/392",[8,0.224,16,1.135,18,0.971,24,1.474,50,1.825,71,1.669,82,2.513,83,2.325,84,2.615,86,2.573,145,0.776,148,0.729,314,3.585,407,2.977,1073,4.618,1074,5.863]],["title/393",[26,2.152,314,2.69,656,2.711,1067,5.028]],["description/393",[8,0.251,18,1.086,126,2.016,145,0.915,148,0.86,314,4.009,392,1.692,656,3.058,1067,5.672,1075,6.913]],["title/394",[71,1.943,126,1.99,314,2.995]],["description/394",[5,1.994,19,2.611,71,2.474,126,2.534,314,3.814]],["title/395",[23,0.672,314,2.441,355,3.439,476,3.439,1076,3.985]],["description/395",[8,0.239,16,1.243,18,1.034,119,2.577,145,0.849,148,0.799,174,2.989,314,3.815,355,3.97,392,1.571,476,3.97,1076,4.6,1077,6.42]],["title/396",[23,0.672,314,2.441,383,4.38,476,3.439,1076,3.985]],["description/396",[8,0.235,16,1.214,18,1.017,119,2.517,145,0.83,148,0.78,174,2.919,314,3.755,383,4.94,407,3.184,476,3.878,1076,4.494,1078,5.748,1079,6.271]],["title/397",[23,0.741,83,1.744,110,3.613,314,2.69]],["description/397",[8,0.218,83,2.256,88,2.752,110,4.672,314,3.479,1080,7.926,1081,7.926,1082,7.926]],["title/398",[23,0.741,110,3.613,314,2.69,886,4.392]],["description/398",[8,0.255,18,1.105,23,0.857,145,0.939,148,0.883,314,4.078,392,1.736,886,5.083,1083,7.094]],["title/399",[95,3.856,314,2.995,324,5.03]],["description/399",[8,0.255,18,1.105,95,4.008,145,0.939,148,0.883,314,4.078,392,1.736,1084,7.094,1085,7.094]],["title/400",[23,0.672,95,3.142,110,3.278,314,2.441,577,4.099]],["description/400",[8,0.247,18,1.068,24,1.694,95,3.808,110,3.973,145,0.892,148,0.839,314,3.942,392,1.65,577,4.968,1086,6.74]],["title/401",[18,0.661,120,1.887,168,3.5,314,2.441,1076,3.985]],["description/401",[8,0.247,18,1.201,120,2.287,145,0.892,148,0.839,168,4.242,314,3.942,392,1.65,1076,4.83,1087,6.74]],["title/402",[23,0.615,50,1.584,71,1.449,119,2.043,1088,4.665,1089,4.665]],["description/402",[8,0.243,18,1.05,50,2.047,71,1.872,119,2.639,145,0.87,148,0.818,174,3.061,314,2.886,392,1.61,1088,6.027,1089,6.027,1090,6.576]],["title/403",[18,0.605,120,1.727,314,2.234,383,4.009,865,3.751,1076,3.647]],["description/403",[8,0.243,18,1.186,120,2.232,145,0.87,148,0.818,314,3.878,383,5.18,392,1.61,1076,4.712,1078,6.027,1091,6.576]],["title/404",[4,5.855,1092,5.252]],["description/404",[4,6.828,5,2.06,19,2.697,1092,6.124]],["title/405",[6,2.103,9,3.417,381,3.79,1092,4.18]],["description/405",[8,0.247,9,3.758,18,1.068,19,2.025,145,0.892,148,0.839,381,4.168,641,3.62,787,4.83,1092,4.597,1093,5.53,1094,6.74]],["title/406",[6,2.342,1092,4.655,1095,6.256]],["description/406",[6,1.683,8,0.234,9,2.735,17,3.087,18,0.855,102,1.942,137,3.087,145,0.649,148,0.895,195,3.615,392,1.201,401,4.226,484,3.426,641,2.634,1092,4.904,1095,8.592,1096,4.905,1097,4.905,1098,4.905,1099,4.905,1100,4.905]],["title/407",[23,0.825,1092,4.655,1101,6.256]],["description/407",[8,0.247,18,1.068,19,2.025,23,0.815,145,0.892,148,0.839,284,3.287,641,3.62,787,4.83,1092,4.597,1101,6.178,1102,6.74]],["title/408",[137,4.295,1092,4.655,1103,6.256]],["description/408",[8,0.255,18,1.105,145,0.939,148,0.883,284,3.459,641,3.81,787,5.083,1092,4.838,1103,6.502,1104,7.094]],["title/409",[2,2.968,19,2.313]],["description/409",[2,3.461,5,2.06,19,3.236]],["title/410",[19,1.671,23,0.672,28,2.918,102,2.201,1105,5.561]],["description/410",[8,0.239,18,1.034,19,2.612,23,0.776,102,2.541,145,0.849,148,0.799,254,4.115,284,3.131,407,3.26,1106,6.42,1107,5.268,1108,6.42]],["title/411",[62,2.218,893,4.828,972,3.613,1109,5.28]],["description/411",[8,0.239,18,1.034,76,3.627,102,2.541,135,2.84,145,0.849,148,0.799,787,4.6,893,5.057,972,3.784,1109,5.531,1110,6.42,1111,5.884,1112,6.42]],["title/412",[19,2.05,23,0.825,972,4.023]],["description/412",[8,0.185,14,1.161,18,0.801,19,2.025,23,0.544,49,2.939,80,2.735,88,2.341,100,4.122,145,0.595,147,1.913,148,0.56,177,2.333,322,3.69,523,3.875,900,6.636,972,3.974,1107,3.69,1113,3.875,1114,6.742,1115,4.497,1116,4.497,1117,4.497,1118,4.497,1119,4.497,1120,4.497]],["title/413",[19,1.841,23,0.741,83,1.744,102,2.426]],["description/413",[8,0.243,18,1.05,19,2.654,23,0.795,83,1.872,102,2.603,145,0.87,147,2.797,148,0.818,284,3.207,1113,5.666,1121,6.576]],["title/414",[26,2.397,530,4.655,1122,6.256]],["description/414",[8,0.239,18,1.034,19,1.929,68,3.407,70,4.732,145,0.849,148,0.799,254,4.115,392,1.571,466,5.268,530,4.379,1093,5.268,1122,5.884,1123,6.42]],["title/415",[23,0.825,102,2.702,972,4.023]],["description/415",[8,0.221,18,0.957,19,1.724,23,0.694,24,1.442,50,1.786,71,1.633,82,2.46,83,1.633,84,2.56,86,2.518,102,2.272,145,0.759,148,0.714,407,2.914,1073,4.52,1111,5.26,1124,5.739,1125,5.739]],["title/416",[19,2.313,137,4.846]],["description/416",[8,0.239,18,1.034,19,2.612,102,2.541,126,1.872,137,4.04,145,0.849,148,0.799,254,4.115,407,3.26,529,4.484,530,4.379,1126,6.42]],["title/417",[19,2.313,416,5.518]],["description/417",[0,1.854,8,0.276,14,1.142,18,0.792,19,2,41,2.059,50,2.073,82,1.896,83,1.259,84,1.973,128,5.464,145,0.585,147,1.882,148,0.55,156,3.811,258,2.891,259,4.542,416,3.17,830,3.17,1113,3.811,1127,4.424,1128,4.424,1129,4.424,1130,4.424,1131,4.424]],["title/418",[126,2.245,1132,6.634]],["description/418",[5,2.06,19,2.697,126,2.619,1132,7.737]],["title/419",[16,1.187,62,2.218,146,2.068,235,2.426]],["description/419",[8,0.247,16,1.305,18,1.068,62,2.439,145,0.892,146,3.031,148,0.839,235,3.556,392,1.65,1133,6.74]],["title/420",[16,1.077,26,1.953,146,1.876,226,2.636,235,2.201]],["description/420",[8,0.243,12,1.541,18,1.05,145,0.87,146,2.982,148,0.818,226,3.117,235,3.498,348,3.375,392,1.61,1134,6.576]],["title/421",[26,1.788,76,2.875,102,2.015,146,1.717,235,2.015,395,3.751]],["description/421",[8,0.239,16,1.243,18,1.034,76,3.627,102,2.541,145,0.849,146,2.934,148,0.799,235,3.442,348,3.295,1135,6.42,1136,6.42]],["title/422",[26,1.788,76,2.875,102,2.015,146,1.717,235,2.015,652,4.009]],["description/422",[8,0.239,18,1.034,76,3.627,145,0.849,146,2.934,148,0.799,235,3.442,348,3.295,392,1.571,400,4.882,652,5.057,1137,6.42]],["title/423",[126,2.245,1138,5.137]],["description/423",[2,3.349,5,1.994,72,5.123,126,2.534,1138,5.798]],["title/424",[6,2.103,59,3.928,72,3.613,1138,4.089]],["description/424",[5,1.603,8,0.145,18,0.284,19,1.219,64,0.68,68,1.268,72,3.119,79,3.329,82,2.268,83,1.506,84,1.81,86,1.781,102,0.946,112,1.761,114,0.83,126,0.697,145,0.316,148,0.658,177,1.24,196,2.51,213,1.478,237,1.369,288,2.908,298,1.453,348,2.083,374,1.669,376,1.133,410,1.299,452,1.882,534,1.669,605,3.497,645,1.532,648,1.669,656,1.057,868,1.24,892,2.708,1138,4.662,1139,2.39,1140,2.19,1141,2.059,1142,2.059,1143,2.059,1144,2.19,1145,2.39,1146,2.39,1147,2.39,1148,2.39,1149,2.39,1150,2.39,1151,2.39,1152,3.497,1153,2.19,1154,2.19,1155,2.19,1156,2.059,1157,1.961,1158,2.19,1159,2.39]],["title/425",[59,3.928,62,2.218,72,3.613,1138,4.089]],["description/425",[5,1.586,8,0.19,59,4.431,62,2.501,72,4.075,82,2.963,83,1.967,84,3.083,86,3.034,892,4.612,1138,4.612,1152,5.956,1160,6.913]],["title/426",[23,0.672,59,3.564,72,3.278,117,2.612,1138,3.71]],["description/426",[5,1.695,8,0.176,18,0.373,19,1.529,59,2.012,68,1.666,72,1.85,79,3.204,82,2.182,83,1.449,84,1.4,86,1.378,88,1.09,102,1.243,112,2.314,117,1.474,145,0.415,148,0.633,177,1.629,196,3.148,237,1.798,288,3.648,298,1.909,376,1.488,452,2.473,534,2.192,605,4.386,645,2.012,656,1.389,868,1.629,892,2.094,1138,4.929,1140,2.877,1141,2.704,1142,2.704,1143,2.704,1152,2.704,1153,2.877,1154,2.877,1155,2.877,1156,2.704,1157,2.576,1158,2.877,1161,3.139]],["title/427",[2,2.968,79,4.846]],["description/427",[2,4.071,5,1.994,72,5.123,79,5.469]],["title/428",[6,2.342,72,4.023,79,4.295]],["description/428",[5,1.78,6,1.173,7,0.99,8,0.15,9,1.905,16,0.662,19,1.026,24,0.859,72,4.008,73,3.039,77,2.233,79,3.43,82,1.465,83,0.973,84,2.431,86,2.392,114,1.186,145,0.452,148,0.678,258,2.233,288,3.906,348,1.754,645,2.19,653,3.806,822,2.233,868,1.773,892,3.636,1141,2.944,1142,2.944,1143,2.944,1162,2.804,1163,2.804,1164,2.691,1165,3.417,1166,2.804,1167,3.417,1168,3.417,1169,3.417]],["title/429",[26,2.152,72,3.613,79,3.857,126,1.787]],["description/429",[5,1.82,7,0.545,8,0.135,9,1.672,14,0.774,16,0.581,26,1.054,30,2.518,39,1.768,50,0.934,72,2.892,73,2.735,77,1.96,79,3.917,82,1.286,83,0.854,84,1.338,86,1.316,90,1.695,126,0.875,183,3.034,213,1.855,219,2.461,258,1.96,263,4.239,284,2.392,299,3.517,348,2.518,362,3.426,376,1.422,602,2.211,654,2.749,684,2.749,822,1.96,857,1.718,892,2.001,1144,2.749,1156,2.584,1162,2.461,1163,2.461,1170,3,1171,2.363,1172,4.906,1173,3]],["title/430",[62,2.47,72,4.023,79,4.295]],["description/430",[5,1.56,7,0.99,8,0.187,12,0.801,17,2.15,30,1.754,41,1.591,50,1.064,62,2.808,72,3.213,73,3.039,77,2.233,79,4.883,82,1.465,83,0.973,84,1.524,86,1.5,102,2.158,148,0.425,186,2.014,258,2.233,284,1.666,289,2.804,443,2.691,446,2.113,517,2.33,529,2.386,567,2.113,822,2.233,892,2.28,972,2.014,1162,2.804,1163,2.804,1174,3.417,1175,3.417,1176,3.417,1177,3.417,1178,3.132,1179,3.417]],["title/431",[23,0.825,72,4.023,79,4.295]],["description/431",[5,2.714,6,0.708,7,0.86,8,0.098,11,0.891,13,1.254,16,0.399,24,0.899,30,1.058,56,1.624,64,1.018,72,2.108,73,1.993,77,1.347,79,4.023,82,0.884,83,0.587,84,0.92,86,0.905,102,1.415,145,0.273,163,0.833,258,1.347,298,2.175,387,1.44,412,0.459,443,1.624,476,2.211,529,1.44,533,1.568,653,1.44,656,0.912,822,1.347,868,1.07,892,1.375,958,1.234,1109,1.776,1162,1.691,1163,1.691,1178,1.89,1180,1.624,1181,2.062,1182,2.062,1183,2.062,1184,2.062,1185,2.062,1186,2.062,1187,2.062,1188,2.062,1189,2.062,1190,2.062,1191,2.062]],["title/432",[83,2.192,403,3.112]],["description/432",[5,1.994,83,2.474,403,3.513,405,3.537,1192,7.131]],["title/433",[23,0.615,71,1.449,73,2.837,83,1.449,214,2.532,405,2.072]],["description/433",[8,0.231,12,1.437,18,1.001,23,0.741,83,1.744,114,2.128,145,0.811,148,0.763,214,3.048,335,3.373,376,2.905,392,1.5,405,3.917,1193,6.129]],["title/434",[23,0.672,71,1.583,83,1.583,214,2.766,405,2.264]],["description/434",[8,0.231,12,1.437,18,1.001,23,0.741,83,1.744,114,2.128,145,0.811,148,0.763,214,3.048,335,3.373,376,2.905,398,3.373,405,3.428,1194,3.857,1195,6.129]],["title/435",[2,2.968,403,3.112]],["description/435",[2,3.349,5,1.994,403,3.513,405,3.537,1192,7.131]],["title/436",[26,2.397,344,3.805,405,2.778]],["description/436",[8,0.231,16,1.187,18,1.001,26,2.153,64,1.744,114,2.128,145,0.811,148,0.763,344,3.417,376,2.905,392,1.5,403,2.477,405,3.428,1194,3.857,1196,6.129]],["title/437",[92,4.66,177,3.18,403,2.477,405,2.495]],["description/437",[8,0.231,18,1.001,114,2.128,145,0.811,148,0.763,174,2.853,335,3.373,376,2.905,392,1.5,403,2.477,405,3.917,653,4.28,1197,5.029,1198,6.129]],["title/438",[6,2.342,403,2.758,405,2.778]],["description/438",[6,2.203,8,0.239,18,1.034,114,2.229,145,0.849,148,0.799,335,3.533,376,3.043,403,2.595,405,3.539,407,3.26,1194,4.04,1199,6.42]],["title/439",[23,0.741,403,2.477,405,2.495,1200,5.617]],["description/439",[8,0.224,18,0.971,23,0.709,114,2.035,145,0.776,148,0.729,322,4.81,376,2.779,392,1.435,405,3.325,1107,4.81,1194,3.689,1200,5.374,1201,5.374,1202,5.863,1203,5.863,1204,5.863]],["title/440",[62,2.47,403,2.758,405,2.778]],["description/440",[8,0.239,18,1.034,62,2.323,114,2.229,145,0.849,148,0.799,335,3.533,376,3.043,398,3.533,403,2.595,405,3.539,1194,4.04,1205,6.42]],["title/441",[23,0.825,403,2.758,405,2.778]],["description/441",[8,0.239,12,1.505,18,1.034,24,1.614,114,2.229,145,0.849,148,0.799,376,3.043,392,1.571,403,2.595,405,3.539,1194,4.04,1206,6.42]],["title/442",[26,2.152,28,3.216,403,2.477,405,2.495]],["description/442",[0,1.347,5,1.191,6,1.103,7,0.331,8,0.118,9,2.401,15,4.088,18,0.382,23,0.388,29,4.963,42,2.637,43,2.815,47,1.673,49,1.193,62,1.558,63,1.218,99,1.388,114,0.634,128,1.497,145,0.241,148,0.98,161,1.437,184,1.218,186,1.076,258,1.193,298,1.11,335,1.004,372,0.842,376,0.865,391,1.792,392,0.447,401,1.572,403,3.65,404,1.572,405,2.112,476,1.129,524,1.388,527,1.572,534,1.274,545,1.308,567,1.988,572,1.572,609,1.572,653,2.245,797,1.673,977,1.437,1034,2.769,1035,1.437,1052,1.308,1166,2.637,1194,1.148,1201,1.673,1207,1.345,1208,1.825,1209,5.189,1210,1.076,1211,1.825,1212,1.825,1213,1.825,1214,3.214,1215,2.769,1216,1.825,1217,1.825,1218,1.825,1219,1.825]],["title/443",[403,2.477,405,2.495,1197,5.028,1220,5.617]],["description/443",[8,0.235,18,1.017,114,2.177,145,0.83,148,0.78,335,3.451,376,2.973,392,1.535,403,2.535,405,3.483,1194,3.946,1197,5.145,1220,5.748,1221,6.271]],["title/444",[6,1.747,28,2.671,126,1.484,405,2.072,1222,4.665,1223,5.09]],["description/444",[4,3.309,6,2.258,7,0.79,8,0.181,18,0.782,28,2.284,64,1.239,114,1.511,145,0.576,148,0.542,236,2.395,264,3.309,335,2.395,373,3.309,376,2.063,403,1.759,405,2.677,407,2.21,408,3.309,476,2.691,653,3.04,997,3.571,1036,3.571,1194,2.739,1222,3.989,1224,4.352,1225,4.352,1226,4.352,1227,4.352,1228,3.989,1229,4.352,1230,4.352]],["title/445",[376,3.65,403,3.112]],["description/445",[5,1.994,376,4.12,403,3.513,405,3.537,1192,7.131]],["title/446",[14,1.436,106,2.589,214,2.766,376,2.636,405,2.264]],["description/446",[5,1.743,8,0.244,14,1.961,18,0.903,43,3.457,71,2.162,106,3.535,145,0.7,148,0.658,376,3.6,392,1.295,405,3.617,1034,4.557,1231,5.289,1232,5.289]],["title/447",[11,2.402,120,1.887,214,2.766,376,2.636,405,2.264]],["description/447",[8,0.224,11,2.533,12,1.374,18,0.971,108,4.458,114,2.035,145,0.776,148,0.729,214,2.916,335,3.227,376,3.872,392,1.435,403,2.37,405,3.826,1233,5.863]],["title/448",[14,1.436,23,0.672,214,2.766,376,2.636,405,2.264]],["description/448",[8,0.224,12,1.374,14,1.514,18,0.971,23,0.709,114,2.035,145,0.776,148,0.729,214,2.916,335,3.227,376,3.872,392,1.435,405,3.325,570,4.618,1194,3.689,1234,5.863]],["title/449",[11,2.402,18,0.661,214,2.766,376,2.636,405,2.264]],["description/449",[8,0.224,11,2.533,12,1.374,18,0.971,32,2.475,114,2.035,145,0.776,148,0.729,335,3.227,376,3.872,392,1.435,403,2.37,405,3.826,1235,3.912,1236,5.863]],["title/450",[2,2.968,64,2.192]],["description/450",[2,3.349,5,1.994,64,2.474,405,3.537,1192,7.131]],["title/451",[6,2.342,64,1.943,405,2.778]],["description/451",[6,2.152,8,0.235,18,1.017,64,1.785,114,2.177,145,0.83,148,0.78,335,3.451,376,2.973,392,1.535,403,2.535,405,3.964,1237,6.271]],["title/452",[62,2.47,64,1.943,405,2.778]],["description/452",[8,0.239,18,1.034,62,2.323,64,1.827,114,2.229,145,0.849,148,0.799,335,3.533,376,3.043,392,1.571,405,4.012,1238,6.42]],["title/453",[23,0.672,28,2.918,48,3.985,405,2.264,1164,4.38]],["description/453",[8,0.218,18,0.943,24,1.412,28,2.948,48,4.026,114,1.951,145,0.743,148,0.699,280,3.602,335,3.093,376,2.664,392,1.375,403,2.271,404,4.841,405,3.227,1164,4.426,1194,3.536,1239,5.619,1240,5.619]],["title/454",[23,0.741,64,1.744,405,2.495,1241,5.617]],["description/454",[8,0.235,18,1.017,23,0.758,114,2.177,135,2.774,145,0.83,148,0.78,376,2.973,392,1.535,403,2.535,405,3.483,1194,3.946,1241,5.748,1242,6.271]],["title/455",[23,0.825,64,1.943,405,2.778]],["description/455",[8,0.235,12,1.47,18,1.017,24,1.576,64,1.785,114,2.177,145,0.83,148,0.78,376,2.973,392,1.535,403,2.535,405,3.483,1194,3.946,1243,6.271]],["title/456",[26,2.397,280,4.375,405,2.778]],["description/456",[8,0.235,18,1.017,29,4.768,64,1.785,114,2.177,145,0.83,148,0.78,335,3.451,376,2.973,392,1.535,403,2.535,405,3.964,1244,6.271]],["title/457",[23,0.741,64,1.744,344,3.417,405,2.495]],["description/457",[8,0.231,18,1.001,24,1.54,114,2.128,135,2.711,145,0.811,148,0.763,335,3.373,344,3.417,376,2.905,392,1.5,403,2.477,405,3.917,1245,6.129]],["title/458",[32,2.587,64,1.744,344,3.417,405,2.495]],["description/458",[8,0.231,18,1.001,114,2.128,135,2.711,145,0.811,148,0.763,335,3.373,344,3.417,376,2.905,392,1.5,403,2.477,405,3.917,1246,5.617,1247,6.129]],["title/459",[26,2.152,64,1.744,344,3.417,405,2.495]],["description/459",[8,0.231,18,1.001,114,2.128,126,1.787,135,2.711,145,0.811,148,0.763,335,3.373,344,3.417,376,2.905,392,1.5,403,2.477,405,3.428,1194,3.857,1248,6.129]],["title/460",[26,2.152,64,1.744,226,2.905,405,2.495]],["description/460",[8,0.231,18,1.001,114,2.128,126,1.787,135,2.711,145,0.811,148,0.763,226,2.905,335,3.373,376,2.905,392,1.5,403,2.477,405,3.917,1249,6.129]],["title/461",[1250,7.247]],["description/461",[35,5.319,36,3.981,1250,7.621]],["title/462",[1,4.151,177,3.541,1250,5.6]],["description/462",[1,4.204,8,0.19,16,1.339,118,5.095,160,3.854,177,3.587,411,1.851,656,4.041,805,5.445,1250,5.672,1251,6.913,1252,6.913]],["title/463",[252,6.716]],["description/463",[35,5.319,36,3.981,252,7.063]],["title/464",[490,3.756,1253,6.256,1254,5.376]],["description/464",[5,1.932,93,4.028,213,5.207,490,4.634,1253,7.717,1254,6.633]],["title/465",[23,0.741,842,3.613,857,3.51,1255,4.28]],["description/465",[0,1.191,7,0.516,8,0.078,14,1.212,16,0.55,19,1.801,24,0.714,37,4.353,39,1.675,61,1.491,65,1.651,98,1.896,101,2.605,113,2.383,114,0.987,117,1.335,118,2.095,126,0.829,148,0.584,200,1.651,237,1.628,441,2.605,526,2.036,545,2.036,615,2.036,842,4.103,847,2.449,857,1.628,906,2.036,1052,2.036,1180,2.239,1207,2.095,1210,1.675,1255,1.985,1256,2.605,1257,2.842,1258,2.842,1259,2.161,1260,2.161,1261,3.569,1262,3.569,1263,2.095,1264,2.161,1265,1.896,1266,3.459,1267,2.161,1268,2.161,1269,2.161,1270,2.036,1271,2.161,1272,2.161,1273,2.095,1274,2.842]],["title/466",[200,3.965,842,4.023,1255,4.767]],["description/466",[0,1.469,8,0.096,14,0.905,19,2.077,24,0.881,37,4.794,39,2.066,61,1.839,65,2.036,98,2.339,102,1.388,117,1.647,200,3.231,526,2.512,545,2.512,615,2.512,842,4.076,1052,2.512,1207,2.584,1210,2.066,1254,2.761,1255,2.448,1259,2.666,1260,2.666,1261,4.23,1262,4.23,1263,2.584,1264,2.666,1265,2.339,1266,4.1,1267,2.666,1268,2.666,1269,2.666,1270,2.512,1271,2.666,1272,2.666,1273,2.584,1275,3.506]],["title/467",[19,1.841,23,0.741,24,1.54,1266,4.517]],["description/467",[0,1.432,8,0.094,14,0.882,19,2.331,24,1.37,37,4.741,39,2.014,61,1.793,65,1.985,98,2.28,117,1.605,200,1.985,526,2.448,545,2.448,615,2.448,842,4.008,1052,2.448,1207,2.518,1210,2.014,1254,2.691,1255,3.806,1259,2.598,1260,2.598,1261,4.144,1262,4.144,1263,2.518,1264,2.598,1265,2.28,1266,5.011,1267,2.598,1268,2.598,1269,2.598,1270,2.448,1271,2.598,1272,2.598,1273,2.518,1276,3.417]],["title/468",[117,2.879,182,3.145,842,3.613,1255,4.28]],["description/468",[0,1.45,8,0.095,14,0.893,19,2.06,24,0.87,37,4.767,39,2.04,61,1.816,65,2.01,98,2.309,102,1.37,117,2.586,200,2.01,526,2.48,545,2.48,615,2.48,842,4.042,1052,2.48,1207,2.551,1210,2.04,1254,2.726,1255,2.417,1256,3.172,1259,2.631,1260,2.631,1261,4.187,1262,4.187,1263,2.551,1264,2.631,1265,2.309,1266,4.058,1267,2.631,1268,2.631,1269,2.631,1270,2.48,1271,2.631,1272,2.631,1273,2.551,1277,3.461]],["title/469",[19,1.841,200,3.56,1270,4.392,1278,6.129]],["description/469",[0,1.396,8,0.092,14,0.86,19,2.298,24,0.838,37,4.689,39,1.964,61,1.749,64,0.949,65,3.103,98,2.223,117,1.565,200,1.936,213,2.061,473,2.097,526,2.388,545,2.388,615,2.388,842,3.149,895,2.327,1052,2.388,1207,2.456,1210,1.964,1255,2.327,1259,2.534,1260,2.534,1261,4.063,1262,4.063,1263,2.456,1264,2.534,1265,2.223,1266,4.929,1267,2.534,1268,2.534,1269,2.534,1270,3.828,1271,2.534,1272,2.534,1273,2.456,1279,3.333]],["title/470",[63,4.089,117,2.879,182,3.145,1270,4.392]],["description/470",[0,1.12,8,0.073,14,0.69,19,2.238,23,0.323,24,0.672,37,4.223,39,1.576,61,1.403,63,1.784,65,2.591,98,1.784,112,1.97,117,2.095,126,0.78,174,1.244,184,1.784,200,1.553,220,1.823,290,2.193,504,2.193,508,1.164,526,1.916,545,1.916,615,3.196,842,2.63,857,1.531,1009,2.45,1013,2.303,1052,1.916,1166,3.66,1207,1.97,1210,1.576,1255,1.867,1259,2.033,1260,2.033,1261,3.392,1262,3.392,1263,1.97,1264,2.033,1265,1.784,1266,4.231,1267,2.033,1268,2.033,1269,2.033,1270,3.196,1271,2.033,1272,2.033,1273,1.97,1280,2.193,1281,2.673,1282,2.673,1283,2.673,1284,2.673,1285,2.673,1286,2.673]],["title/471",[205,2.72,1287,2.778,1288,5.6]],["description/471",[5,1.932,93,4.028,205,3.356,213,5.207,1287,3.427,1288,6.909]],["title/472",[120,2.08,143,2.531,890,4.517,1289,4.517]],["description/472",[7,1.288,8,0.195,12,1.663,16,1.374,120,2.407,123,3.856,143,2.929,318,4.314,681,2.867,890,5.228,1289,5.228,1290,7.094]],["title/473",[23,0.615,119,2.043,120,1.727,143,2.102,890,3.751,1289,3.751]],["description/473",[7,1.224,8,0.185,12,1.58,16,1.305,119,2.705,120,2.287,123,3.664,143,2.783,174,3.138,318,4.099,681,2.724,890,4.968,1289,4.968,1291,6.74]],["title/474",[18,0.729,143,2.531,890,4.517,1289,4.517]],["description/474",[7,1.288,8,0.195,12,1.663,16,1.374,18,0.843,123,3.856,143,2.929,318,4.314,681,2.867,890,5.228,1289,5.228,1292,7.094]],["title/475",[23,0.672,83,1.583,355,3.439,1293,4.791,1294,4.791]],["description/475",[8,0.206,23,0.905,83,2.131,126,2.183,355,4.63,374,5.229,406,5.365,1293,6.451,1294,6.451,1295,7.487]],["title/476",[23,0.741,119,2.46,120,2.08,1288,5.028]],["description/476",[8,0.224,119,3.277,120,2.771,174,3.801,278,4.103,1288,6.7,1296,8.166]],["title/477",[23,0.741,119,2.46,120,2.08,1297,5.617]],["description/477",[8,0.19,23,0.836,119,2.774,120,2.346,155,5.956,174,3.218,263,4.075,603,2.986,1297,8.372,1298,6.913,1299,6.913,1300,6.913]],["title/478",[318,4.683,1287,3.134]],["description/478",[8,0.231,106,3.92,284,4.106,318,5.121,1287,3.427,1301,8.42]],["title/479",[24,1.715,318,4.151,1287,2.778]],["description/479",[8,0.224,16,1.581,24,2.052,114,2.835,318,4.966,1287,3.324,1302,8.166]],["title/480",[26,2.397,318,4.151,1287,2.778]],["description/480",[8,0.218,24,1.992,50,2.467,64,2.256,113,4.025,1293,6.829,1294,6.829,1303,7.926]],["title/481",[24,1.179,42,3.85,59,3.007,143,1.937,1287,1.91,1289,3.458,1304,4.301]],["description/481",[6,2.89,8,0.231,26,2.957,62,3.047,1305,8.42,1306,8.42]],["title/482",[32,3.251,318,4.683]],["description/482",[8,0.231,32,3.555,284,4.106,318,5.121,1287,3.427,1307,8.42]],["title/483",[26,2.397,318,4.151,1287,2.778]],["description/483",[8,0.231,26,2.957,284,4.106,318,5.121,1287,3.427,1308,8.42]],["title/484",[71,1.943,205,2.72,1287,2.778]],["description/484",[5,1.932,71,2.397,93,4.028,205,3.356,213,5.207,1287,3.427]],["title/485",[32,2.881,561,4.891,1287,2.778]],["description/485",[0,2.628,7,1.139,8,0.235,11,2.709,14,1.619,32,2.647,70,4.622,135,2.774,205,2.499,261,3.184,561,4.494,603,2.709,1287,3.483,1309,4.94,1310,6.271]],["title/486",[7,1.01,12,1.303,24,1.398,64,1.583,1287,2.264]],["description/486",[0,2.628,7,1.554,8,0.235,11,2.709,14,1.619,16,1.214,24,1.576,64,1.785,205,2.499,261,3.184,603,2.709,1287,3.483,1309,4.94,1311,6.271]],["title/487",[26,2.397,561,4.891,1287,2.778]],["description/487",[0,2.568,7,1.113,8,0.231,11,2.648,14,1.582,26,2.153,64,1.744,70,4.517,135,2.711,205,2.443,261,3.112,561,4.392,603,2.648,1287,3.428,1309,4.828,1312,6.129]],["title/488",[106,3.177,561,4.891,1287,2.778]],["description/488",[0,2.628,7,1.139,8,0.235,11,2.709,14,1.619,64,1.785,70,4.622,135,2.774,205,2.499,261,3.184,561,4.494,603,2.709,1287,3.483,1309,4.94,1313,6.271]],["title/489",[7,1.01,12,1.303,24,1.398,561,3.985,1287,2.264]],["description/489",[0,2.628,7,1.554,8,0.235,11,2.709,14,1.619,16,1.214,24,1.576,205,2.499,261,3.184,603,2.709,1287,3.483,1309,4.94,1314,6.271,1315,6.271]],["title/490",[7,1.239,661,5.88,1316,4.46]],["description/490",[5,1.932,7,1.529,93,4.028,213,5.207,661,7.254,1316,5.503]],["title/491",[23,0.825,113,3.466,1316,4.46]],["description/491",[8,0.231,12,1.974,24,2.116,113,4.276,1316,5.503,1317,8.42]],["title/492",[23,0.672,126,1.622,1138,3.71,1316,3.634,1318,4.38]],["description/492",[8,0.231,24,2.116,126,2.455,1316,5.503,1318,6.633,1319,8.42]],["title/493",[23,0.741,1138,4.089,1316,4.005,1320,4.828]],["description/493",[8,0.224,12,1.914,24,2.052,1138,5.448,1316,5.337,1320,6.432,1321,8.166]],["title/494",[2,2.63,372,3.149,1322,2.995]],["description/494",[2,3.245,5,1.932,93,4.028,213,5.207,372,3.885,1322,3.695]],["title/495",[324,4.517,372,2.828,636,2.828,1322,2.69]],["description/495",[0,2.756,7,1.194,8,0.243,11,2.841,14,1.698,179,5.396,261,3.339,372,3.034,603,2.841,636,3.034,1322,3.878,1323,3.82,1324,6.576]],["title/496",[23,0.672,117,2.612,372,2.566,636,2.566,1322,2.441]],["description/496",[0,2.568,7,1.529,8,0.231,11,2.648,14,1.582,16,1.187,174,2.853,261,3.112,372,2.828,577,4.517,603,2.648,636,2.828,1322,3.697,1323,3.56,1325,6.129]],["title/497",[19,1.671,62,2.012,372,2.566,1030,4.099,1322,2.441]],["description/497",[0,2.568,7,1.113,8,0.231,11,2.648,14,1.582,148,0.763,261,3.112,271,4.517,372,2.828,571,5.617,603,2.648,636,2.828,1322,3.697,1323,3.56,1326,6.129,1327,6.129]],["title/498",[23,0.741,372,2.828,636,2.828,1322,2.69]],["description/498",[0,2.511,7,1.088,8,0.228,11,2.589,14,1.547,24,1.506,88,2.081,113,3.043,261,3.043,308,4.185,372,2.765,603,2.589,636,3.827,1322,3.64,1323,3.481,1328,5.993]],["title/499",[23,0.672,117,2.612,372,2.566,636,2.566,1322,2.441]],["description/499",[0,2.69,7,1.166,8,0.239,11,2.773,14,1.657,174,2.989,261,3.26,372,2.962,577,4.732,603,2.773,636,2.962,1322,3.815,1323,3.729,1329,6.42]],["title/500",[372,3.149,636,3.149,1322,2.995]],["description/500",[0,2.69,7,1.166,8,0.239,11,2.773,14,1.657,200,3.729,261,3.26,308,4.484,372,2.962,603,2.773,636,2.962,1322,3.815,1323,3.729,1330,6.42]],["title/501",[391,3.805,636,3.149,1322,2.995]],["description/501",[0,2.628,7,1.139,8,0.235,11,2.709,14,1.619,200,3.643,261,3.184,308,4.38,372,2.894,391,3.496,603,2.709,636,2.894,1322,3.755,1323,3.643,1331,6.271]],["title/502",[23,0.672,117,2.612,391,3.1,636,2.566,1322,2.441]],["description/502",[0,2.133,5,1.695,7,0.924,8,0.239,11,2.199,14,1.314,23,0.615,119,2.043,261,2.585,348,2.612,372,3.409,391,4.118,471,3.647,572,4.385,603,2.199,636,2.349,1280,4.176,1322,3.242,1323,2.957,1332,4.009,1333,5.09]],["title/503",[19,1.529,62,1.842,391,2.837,1030,3.751,1322,2.234,1334,5.09]],["description/503",[0,2.457,7,1.065,8,0.224,11,2.533,14,1.514,148,0.729,261,2.977,271,4.321,372,2.705,374,4.095,391,3.269,603,2.533,636,2.705,1030,4.321,1157,4.81,1322,3.585,1323,3.406,1335,5.863]],["title/504",[2,2.63,126,1.99,1322,2.995]],["description/504",[2,3.245,5,1.932,93,4.028,126,2.455,213,5.207,1322,3.695]],["title/505",[26,1.953,226,2.636,636,2.566,926,5.097,1322,2.441]],["description/505",[0,2.628,7,1.139,8,0.235,11,2.709,14,1.619,26,2.203,226,2.973,261,3.184,603,2.709,906,4.494,1316,4.098,1318,4.94,1322,3.755,1323,3.643,1336,6.271]],["title/506",[32,2.348,842,4.64,868,2.885,1265,3.71]],["description/506",[0,1.949,5,1.067,7,0.845,8,0.251,11,2.01,14,1.201,19,1.397,36,1.994,63,3.104,82,1.994,83,1.324,84,3.084,86,2.042,261,2.362,374,3.249,603,2.01,842,4.865,868,2.414,1157,3.817,1265,4.613,1322,2.042,1323,2.702,1337,5.957,1338,4.652]],["title/507",[26,2.594,126,1.484,636,2.349,829,3.87,1322,2.234]],["description/507",[0,1.347,7,0.584,8,0.241,11,1.388,14,0.83,19,0.965,23,0.388,26,2.631,30,2.663,37,1.686,50,1.615,114,1.116,118,2.369,120,1.091,126,1.903,145,0.425,261,1.632,348,1.649,422,2.53,534,2.244,603,1.388,749,2.144,829,5.696,1093,2.637,1316,4.265,1318,4.087,1320,2.531,1322,3.287,1323,1.867,1339,3.214,1340,2.946,1341,3.214,1342,2.946,1343,3.214,1344,3.214,1345,3.214]],["title/508",[2,2.143,23,0.672,73,3.1,261,2.824,1322,2.441]],["description/508",[0,2.69,2,2.474,7,1.166,8,0.239,11,2.773,14,1.657,73,3.579,88,2.229,261,3.26,603,2.773,1322,3.815,1323,3.729,1346,6.42,1347,6.42]],["title/509",[23,0.825,636,3.149,1322,2.995]],["description/509",[0,2.019,5,1.628,7,0.875,8,0.231,11,2.081,12,1.129,14,1.244,24,1.211,64,1.371,88,1.673,148,0.599,161,3.795,186,4.183,261,2.446,348,2.473,603,3.065,1320,3.795,1322,3.697,1323,2.799,1348,4.416,1349,4.416,1350,4.151,1351,4.818]],["title/510",[23,0.741,26,2.152,1352,6.129,1353,5.617]],["description/510",[0,2.69,7,1.166,8,0.239,11,2.773,14,1.657,23,0.776,26,2.255,113,3.26,261,3.26,603,2.773,1322,3.815,1323,3.729,1353,5.884,1354,6.42]],["title/511",[23,0.741,126,1.787,636,2.828,1322,2.69]],["description/511",[0,2.019,5,1.628,7,0.875,8,0.231,11,2.081,14,1.244,64,1.371,88,2.463,114,1.673,148,0.599,161,3.795,186,4.183,261,2.446,348,2.473,603,3.065,1318,3.795,1322,3.697,1323,2.799,1348,4.416,1349,4.416,1350,4.151,1355,4.818]],["title/512",[23,0.672,340,4.38,636,2.566,842,3.278,1322,2.441]],["description/512",[0,2.174,7,0.942,8,0.206,11,2.241,14,1.339,36,2.224,63,3.461,82,2.224,83,1.477,84,2.314,86,2.277,98,3.461,117,2.437,174,2.415,261,2.634,340,4.086,603,2.241,842,4.415,1055,4.755,1265,3.461,1322,2.277,1323,3.013,1337,4.47,1356,5.188]],["title/513",[113,3.112,749,4.089,1316,4.005,1322,2.69]],["description/513",[0,2.628,2,2.417,7,1.139,8,0.235,11,2.709,14,1.619,30,3.218,148,0.78,261,3.184,603,2.709,749,4.184,1316,4.098,1322,3.755,1340,5.748,1357,6.271]],["title/514",[200,3.56,636,2.828,842,3.613,1322,2.69]],["description/514",[0,0.544,2,0.501,5,2.136,7,0.43,8,0.129,11,0.561,14,0.335,16,0.252,19,0.39,23,0.157,36,1.727,43,0.849,50,1.017,58,2.041,64,0.37,71,0.674,75,0.803,82,0.557,83,0.37,84,0.579,86,0.57,111,0.744,129,0.866,148,0.716,175,1.19,186,2.762,189,2.994,261,0.659,279,1.801,288,0.931,290,1.944,293,1.023,298,1.441,313,3.174,335,0.715,381,1.465,418,1.119,517,3.196,534,0.907,603,1.023,645,0.832,653,1.654,656,1.048,766,2.171,842,3.099,1093,1.944,1107,2.68,1180,2.573,1263,0.957,1265,0.866,1273,0.957,1304,2.171,1320,6.164,1322,2.307,1323,0.754,1342,2.171,1358,1.299,1359,2.369,1360,4.029,1361,2.369,1362,4.029,1363,4.686,1364,1.299,1365,2.369,1366,3.266,1367,2.369,1368,1.299,1369,1.299,1370,2.369,1371,3.266,1372,1.299,1373,1.299,1374,1.299,1375,1.299,1376,1.299]],["title/515",[324,4.517,636,2.828,842,3.613,1322,2.69]],["description/515",[0,2.69,7,1.166,8,0.271,11,2.773,14,1.657,179,5.268,200,3.729,261,3.26,603,2.773,842,3.784,1322,2.817,1323,3.729,1337,5.531,1377,6.42]],["title/516",[2,2.63,403,2.758,1378,3.395]],["description/516",[2,3.461,5,2.06,403,3.629,1378,4.466]],["title/517",[6,2.342,403,2.758,1378,3.395]],["description/517",[6,2.435,8,0.255,18,1.105,145,0.939,148,0.883,403,2.867,407,3.602,1378,4.622,1379,7.094]],["title/518",[23,0.672,28,2.918,48,3.985,1164,4.38,1378,2.766]],["description/518",[8,0.239,18,1.034,28,3.369,48,4.6,64,1.827,88,2.229,145,0.849,148,0.799,392,1.571,403,2.595,1164,5.057,1378,4.324,1380,6.42]],["title/519",[62,2.47,403,2.758,1378,3.395]],["description/519",[8,0.255,18,1.105,62,2.567,145,0.939,148,0.883,392,1.736,403,2.867,1378,3.529,1381,6.112,1382,7.094]],["title/520",[23,0.825,403,2.758,1378,3.395]],["description/520",[8,0.251,12,1.62,18,1.086,24,1.737,145,0.915,148,0.86,392,1.692,403,2.794,1378,3.438,1381,5.956,1383,6.913]],["title/521",[26,2.152,28,3.216,403,2.477,1378,3.048]],["description/521",[8,0.255,18,1.105,29,5.394,145,0.939,148,0.883,392,1.736,403,2.867,1378,4.622,1384,7.094]],["title/522",[2,2.63,64,1.943,1378,3.395]],["description/522",[2,3.461,5,2.06,64,2.556,1378,4.466]],["title/523",[26,2.397,344,3.805,1378,3.395]],["description/523",[0,1.363,5,1.202,6,1.116,8,0.181,9,1.813,11,1.405,15,5.182,16,0.63,18,0.623,38,2.271,41,1.514,50,1.012,64,1.491,73,1.813,75,2.011,106,1.514,145,0.43,148,0.405,202,2.397,344,1.813,392,0.796,403,2.117,615,2.331,822,2.126,874,2.981,1197,5.398,1378,4.396,1385,3.252,1386,3.252,1387,3.252,1388,3.252,1389,3.252,1390,3.252,1391,3.252,1392,3.252,1393,3.252,1394,3.252,1395,3.252,1396,5.239,1397,3.252,1398,3.252]],["title/524",[6,2.342,64,1.943,1378,3.395]],["description/524",[6,2.372,8,0.251,18,1.086,64,1.967,145,0.915,148,0.86,392,1.692,403,2.794,1378,4.544,1399,6.913]],["title/525",[62,2.47,64,1.943,1378,3.395]],["description/525",[8,0.255,18,1.105,62,2.567,64,2.019,145,0.939,148,0.883,392,1.736,1378,4.622,1400,7.094]],["title/526",[64,1.583,120,1.887,344,3.1,403,2.248,1378,2.766]],["description/526",[8,0.243,15,5.18,18,1.05,64,1.872,145,0.87,148,0.818,344,3.666,403,3.571,407,3.339,1378,4.395,1401,6.576]],["title/527",[23,0.825,64,1.943,1378,3.395]],["description/527",[8,0.247,12,1.58,18,1.068,24,1.694,64,1.918,145,0.892,148,0.839,392,1.65,403,2.724,1378,4.468,1402,6.74]],["title/528",[26,1.953,226,2.636,280,3.564,997,4.563,1378,2.766]],["description/528",[5,1.473,6,1.447,8,0.214,18,0.763,29,4.883,49,2.756,50,1.313,64,2.475,68,2.238,126,1.23,145,0.558,148,0.525,161,3.321,196,2.607,226,3.044,248,3.021,358,3.865,392,1.032,403,2.595,567,2.607,609,3.633,1378,4.325,1403,4.217,1404,4.217,1405,4.217]],["title/529",[32,2.587,64,1.744,344,3.417,1378,3.048]],["description/529",[8,0.243,18,1.05,64,1.872,145,0.87,148,0.818,344,3.666,392,1.61,403,3.571,1246,6.027,1378,4.395,1406,6.576]],["title/530",[26,2.152,64,1.744,226,2.905,1378,3.048]],["description/530",[8,0.247,18,1.068,135,2.982,145,0.892,148,0.839,226,3.195,348,3.459,392,1.65,403,2.724,1378,3.353,1381,5.807,1407,6.74]],["title/531",[26,2.397,280,4.375,1378,3.395]],["description/531",[8,0.251,18,1.086,29,5.256,64,1.967,145,0.915,148,0.86,392,1.692,403,2.794,1378,4.544,1408,6.913]],["title/532",[1409,6.169]],["description/532",[35,5.319,36,3.981,1409,6.487]],["title/533",[23,0.672,186,3.278,278,2.794,1409,3.884,1410,5.561]],["description/533",[8,0.224,23,0.987,24,2.052,110,4.813,120,2.771,379,6.7,1411,8.166]],["title/534",[7,0.924,12,1.193,23,0.615,98,3.396,272,3.326,1409,3.555]],["description/534",[7,1.166,8,0.239,12,1.505,14,1.657,23,1.051,50,1.999,98,4.283,186,3.784,238,5.531,420,4.882,1409,6.072,1412,6.42,1413,6.42]],["title/535",[23,0.741,1409,4.28,1414,5.617,1415,5.617]],["description/535",[8,0.224,88,2.835,186,4.813,1409,5.703,1414,7.484,1415,7.484,1416,8.166]],["title/536",[2,2.362,214,3.048,387,4.28,1417,5.617]],["description/536",[2,3.245,5,1.932,214,4.188,377,4.418,387,5.881,1417,7.717]],["title/537",[6,2.643,214,3.83]],["description/537",[7,1.439,8,0.218,12,1.858,19,2.381,214,3.942,313,6.244,1418,6.503,1419,7.926]],["title/538",[62,2.786,214,3.83]],["description/538",[7,1.439,8,0.218,12,1.858,19,2.381,32,3.346,214,3.942,1418,6.503,1420,7.926]],["title/539",[19,1.841,26,2.152,214,3.048,1421,6.129]],["description/539",[7,1.398,8,0.211,12,1.805,19,2.313,26,2.705,759,6.066,1235,5.137,1418,6.318,1422,7.701]],["title/540",[177,3.995,214,3.83]],["description/540",[7,1.288,8,0.195,12,1.663,19,2.131,30,3.641,119,2.847,174,3.302,262,2.789,935,5.394,1235,4.733,1418,5.821,1423,7.094]],["title/541",[83,2.192,168,4.846]],["description/541",[5,2.06,83,2.556,168,5.651,377,4.712]],["title/542",[23,0.615,105,2.641,142,3.095,143,2.102,168,3.203,1424,5.09]],["description/542",[8,0.218,23,0.958,64,2.256,142,4.821,143,3.273,868,4.113,1350,6.829,1425,7.926]],["title/543",[23,0.741,110,3.613,146,2.068,1041,4.517]],["description/543",[8,0.231,88,2.923,110,4.963,146,2.841,1041,6.206,1426,8.42]],["title/544",[7,1.239,71,1.943,83,1.943]],["description/544",[5,1.932,7,1.529,71,2.949,83,2.949]],["title/545",[23,0.741,117,2.879,278,3.08,1427,5.617]],["description/545",[7,1.224,8,0.185,23,0.815,65,3.915,71,2.557,117,3.166,174,3.138,278,3.387,628,6.178,1427,6.178,1428,6.74,1429,6.74,1430,6.74]],["title/546",[23,0.741,110,3.613,114,2.128,126,1.787]],["description/546",[5,1.406,7,1.113,8,0.231,16,1.631,17,3.857,30,3.145,50,1.908,71,1.744,88,2.128,93,2.932,113,3.112,114,2.128,126,1.787,258,4.005,749,4.089,1431,6.129]],["title/547",[994,6.329]],["description/547",[35,5.319,36,3.981,994,6.656]],["title/548",[23,0.741,71,1.744,246,4.392,994,4.392]],["description/548",[8,0.224,16,1.581,23,0.987,367,5.448,994,5.851,1432,8.166,1433,8.166]],["title/549",[226,3.65,1434,6.318]],["description/549",[5,1.994,71,2.474,83,2.474,226,4.12,1434,7.131]],["title/550",[23,0.672,196,3.439,226,2.636,982,4.563,1434,4.563]],["description/550",[8,0.218,88,2.752,196,4.901,226,3.757,428,6.503,982,6.503,1434,6.503,1435,7.926]],["title/551",[387,6.169]],["description/551",[35,5.319,36,3.981,387,6.487]],["title/552",[23,0.825,387,4.767,886,4.891]],["description/552",[8,0.231,88,2.923,110,4.963,387,5.881,886,6.034,1436,8.42]],["title/553",[1437,8.096]],["description/553",[35,5.319,36,3.981,1437,8.513]],["title/554",[7,0.924,23,0.615,278,2.558,1438,4.665,1439,4.009,1440,5.09]],["description/554",[7,1.439,8,0.218,12,1.858,98,5.288,114,2.752,278,3.983,1441,6.829,1442,7.926]],["title/555",[7,1.01,16,1.077,32,2.348,278,2.794,1439,4.38]],["description/555",[0,1.488,5,1.6,7,1.44,8,0.218,12,0.832,14,0.917,16,0.688,23,0.429,32,1.499,36,1.522,41,1.653,50,1.106,71,1.6,126,1.036,135,2.487,146,2.353,147,1.511,148,0.442,214,1.767,232,2.545,278,2.824,567,2.196,577,2.618,648,2.48,673,2.16,867,2.914,1215,3.06,1439,2.798,1441,3.06,1443,3.255,1444,4.274,1445,4.842,1446,3.255,1447,3.552,1448,3.552]],["title/556",[7,1.01,16,1.077,106,2.589,278,2.794,1439,4.38]],["description/556",[0,1.528,5,1.628,7,0.662,8,0.221,12,1.345,14,0.942,23,0.441,32,1.54,36,1.563,41,1.698,50,1.135,71,1.634,114,1.266,135,2.539,146,2.395,147,1.552,148,0.454,214,1.814,232,2.614,278,2.884,567,2.256,577,2.688,648,2.547,673,2.218,756,3.142,867,2.993,1215,3.142,1439,2.873,1441,3.142,1443,3.343,1444,4.365,1445,4.945,1446,3.343,1449,3.648,1450,3.648]],["title/557",[163,2.758,164,2.58,1451,6.256]],["description/557",[5,1.932,163,4.187,164,3.916,1451,7.717]],["title/558",[18,0.811,144,1.663,1452,4.375]],["description/558",[8,0.221,18,1.105,71,1.633,144,1.398,145,0.759,146,2.715,148,0.714,205,2.287,235,2.272,284,2.798,411,1.536,412,1.278,681,2.319,1287,2.336,1452,3.678,1453,3.286,1454,5.739]],["title/559",[18,0.729,23,0.741,144,1.494,1452,3.928]],["description/559",[8,0.231,18,1.001,24,2.116,144,2.052,1452,5.397,1455,8.42]],["title/560",[23,0.741,144,1.494,1452,3.928,1456,5.28]],["description/560",[8,0.215,18,0.929,24,1.383,71,1.567,88,1.911,144,1.342,145,0.728,146,2.637,148,0.685,205,2.194,235,2.179,411,1.474,412,1.226,650,4.743,681,2.225,1287,2.241,1452,3.528,1453,3.153,1456,4.743,1457,5.505]],["title/561",[23,0.672,119,2.232,174,2.589,1280,4.563,1452,3.564]],["description/561",[8,0.212,18,0.916,59,3.458,64,1.535,71,1.535,119,2.165,123,2.932,145,0.714,146,2.599,148,0.671,205,2.15,235,2.136,411,1.444,412,1.202,681,2.18,749,3.599,1280,4.426,1287,2.196,1453,3.09,1458,5.395,1459,5.395]],["title/562",[120,2.08,144,1.494,220,4.18,1452,3.928]],["description/562",[8,0.221,18,0.957,71,1.633,120,1.947,144,1.398,145,0.759,146,2.715,148,0.714,205,2.287,235,2.272,284,2.798,411,1.536,412,1.278,681,2.319,1287,2.336,1452,3.678,1453,3.286,1460,5.739]],["title/563",[18,0.729,144,1.494,220,4.18,1452,3.928]],["description/563",[8,0.241,18,0.934,24,1.633,36,1.836,50,1.333,71,1.219,106,1.994,144,2.136,145,0.567,146,2.193,148,0.533,205,1.707,235,1.696,284,2.089,338,3.257,411,1.147,412,0.954,567,2.649,681,1.731,1013,3.69,1287,1.743,1452,2.745,1453,2.453,1461,6.499,1462,4.283,1463,4.283]],["title/564",[64,1.744,123,3.331,200,3.56,1452,3.928]],["description/564",[8,0.221,18,0.957,64,1.633,71,1.633,145,0.759,146,2.715,148,0.714,174,2.671,205,2.287,235,2.272,411,1.536,412,1.278,681,2.319,1287,2.336,1453,3.286,1464,5.739,1465,5.739,1466,5.739]],["title/565",[2,2.362,7,1.113,16,1.187,163,2.477]],["description/565",[2,3.147,5,1.874,7,1.483,16,1.581,163,4.109,164,3.086]],["title/566",[23,0.615,90,2.875,119,2.043,144,1.24,377,2.671,637,2.875]],["description/566",[7,1.288,8,0.195,16,1.374,50,2.208,118,5.228,119,2.847,144,1.729,148,0.883,163,2.867,637,4.008,829,5.394,1467,7.094]],["title/567",[32,2.881,144,1.663,163,2.758]],["description/567",[8,0.235,14,1.056,18,0.746,32,2.648,36,1.753,50,1.273,62,1.48,71,1.164,123,2.223,144,1.86,145,0.541,146,2.117,148,0.509,163,3.084,164,2.371,205,1.63,235,1.619,248,2.93,254,2.621,411,1.095,412,0.911,459,3.355,681,1.653,1287,1.664,1453,2.342,1468,3.748,1469,4.089,1470,4.089,1471,4.089]],["title/568",[23,0.615,30,2.612,119,2.043,163,2.057,164,1.924,318,3.095]],["description/568",[8,0.211,16,1.491,119,3.091,163,3.112,164,2.91,174,3.585,318,4.683,570,6.066,1472,7.701]],["title/569",[163,2.477,164,2.316,182,3.145,1473,5.617]],["description/569",[8,0.231,18,0.844,71,1.371,88,2.463,113,2.446,144,1.174,145,0.637,146,2.394,148,0.599,164,1.821,205,1.92,235,1.907,262,1.894,388,2.652,411,1.29,412,1.073,570,3.795,681,1.947,1287,1.961,1453,2.759,1474,4.818,1475,3.551,1476,3.795,1477,3.795,1478,4.818]],["title/570",[23,0.741,83,1.744,163,2.477,164,2.316]],["description/570",[5,1.695,8,0.203,18,0.878,41,2.369,71,1.449,83,1.449,88,1.767,113,2.585,145,0.673,146,2.493,148,0.633,205,2.029,235,2.015,299,2.875,411,1.363,412,1.134,448,3.047,681,2.057,1287,2.072,1453,2.915,1475,3.751,1479,3.472,1480,5.09]],["title/571",[23,0.672,83,1.583,163,2.248,164,2.102,1481,5.097]],["description/571",[8,0.195,16,1.374,28,3.722,83,2.019,88,2.463,144,1.729,164,2.681,1481,6.502,1482,7.094,1483,7.094,1484,6.112,1485,7.094]],["title/572",[23,0.672,163,2.248,164,2.102,262,2.186,388,3.061]],["description/572",[8,0.247,14,1.74,41,3.138,88,2.34,163,2.724,164,2.548,183,4.168,262,2.65,299,3.808,388,3.71,448,4.034,1479,4.597,1486,6.74]],["title/573",[23,0.672,262,2.186,388,3.061,1476,4.38,1477,4.38]],["description/573",[7,0.891,8,0.197,14,1.266,41,3.347,46,3.73,48,3.515,50,2.238,51,4.904,52,3.426,53,5.9,83,1.396,90,2.771,95,2.771,164,1.854,262,1.929,264,3.73,330,3.615,331,3.864,388,2.7,681,1.983,1476,3.864,1477,3.864,1487,4.905,1488,4.905]],["title/574",[23,0.615,164,1.924,182,2.612,388,2.801,562,3.047,1489,4.385]],["description/574",[8,0.239,14,1.657,41,2.989,88,2.229,164,2.426,182,3.295,183,3.97,262,2.524,299,3.627,388,3.533,448,3.843,562,3.843,1479,4.379,1490,4.732,1491,6.42]],["title/575",[23,0.672,1041,4.099,1475,4.099,1476,4.38,1477,4.38]],["description/575",[8,0.212,18,0.916,71,1.535,88,1.873,108,4.102,145,0.714,146,2.599,148,0.671,164,2.039,205,2.15,235,2.136,411,1.444,412,1.202,681,2.18,1041,3.976,1287,2.196,1453,3.09,1475,3.976,1476,4.249,1477,4.249,1492,5.395]],["title/576",[144,1.355,163,2.248,182,2.854,278,2.794,1473,5.097]],["description/576",[8,0.231,88,2.923,144,2.052,278,4.231,377,4.418,1493,8.42]],["title/577",[23,0.615,142,3.095,163,2.057,426,4.176,1475,3.751,1494,4.009]],["description/577",[5,1.948,8,0.233,18,0.737,43,2.632,50,1.254,83,1.146,88,1.398,142,4.598,143,3.122,145,0.533,148,0.501,164,1.522,514,2.138,603,1.74,650,3.47,731,3.063,732,3.173,1494,4.884,1495,4.028,1496,3.692,1497,3.692,1498,3.692,1499,5.342,1500,3.692,1501,3.692,1502,3.692,1503,2.491,1504,3.692]],["title/578",[23,0.672,83,1.583,144,1.355,163,2.248,164,2.102]],["description/578",[5,2.096,8,0.227,12,1.09,18,0.822,24,1.169,36,1.994,50,1.448,83,1.324,88,1.615,142,2.829,143,1.921,144,1.134,145,0.915,148,0.579,164,1.758,641,2.498,681,1.88,811,4.264,1132,4.008,1453,2.664,1494,3.664,1496,4.264,1504,4.264,1505,2.982,1506,4.652]],["title/579",[23,0.825,163,2.758,164,2.58]],["description/579",[8,0.224,12,1.374,18,0.971,24,1.474,71,1.669,145,0.776,146,2.756,148,0.729,164,2.216,205,2.337,235,2.321,411,1.57,412,1.306,681,2.37,1287,2.386,1503,3.626,1507,5.863]],["title/580",[23,0.825,262,2.683,388,3.756]],["description/580",[8,0.221,12,1.345,18,0.957,24,1.442,71,1.633,145,0.759,146,2.715,148,0.714,205,2.287,235,2.272,262,2.256,388,3.158,411,1.536,412,1.278,681,2.319,1287,2.336,1503,3.549,1508,5.739]],["title/581",[23,0.825,60,5.03,1509,5.88]],["description/581",[8,0.221,18,0.957,24,1.442,60,4.229,71,1.633,144,1.398,145,0.759,146,2.715,148,0.714,205,2.287,235,2.272,411,1.536,412,1.278,681,2.319,1287,2.336,1509,4.944,1510,5.739,1511,5.739]],["title/582",[23,0.741,164,2.316,182,3.145,562,3.668]],["description/582",[8,0.215,12,1.29,18,0.929,24,1.383,71,1.567,145,0.728,146,2.637,148,0.685,164,2.081,182,2.825,205,2.194,235,2.179,411,1.474,412,1.226,562,3.295,681,2.225,1287,2.241,1490,4.057,1503,3.404,1512,5.505]],["title/583",[163,2.477,200,3.56,403,2.477,1444,4.66]],["description/583",[8,0.231,12,1.974,163,3.403,403,3.403,1444,6.403,1513,8.42]],["title/584",[18,0.729,120,2.08,377,3.216,637,3.462]],["description/584",[5,1.719,7,0.721,8,0.168,12,0.93,18,0.472,30,3.844,41,1.848,51,2.707,65,2.305,68,2.106,120,2.859,144,2.053,145,0.525,163,1.604,164,1.5,177,2.059,284,1.935,298,2.414,377,4.42,637,4.759,790,3.638,1452,2.544,1514,6.131,1515,3.969]],["title/585",[26,1.953,163,2.248,262,2.186,857,3.185,1516,5.561]],["description/585",[8,0.218,126,2.311,262,3.116,296,7.265,581,6.829,857,4.539,1517,7.926,1518,7.926]],["title/586",[126,1.99,207,1.533,1519,4.295]],["description/586",[5,1.932,126,2.455,163,3.403,164,3.182,207,1.891,1519,5.299]],["title/587",[120,1.887,144,1.355,278,2.794,412,1.239,1519,3.5]],["description/587",[5,1.451,7,0.557,8,0.22,18,0.752,43,2.005,50,0.955,71,0.873,120,2.473,144,0.748,145,0.406,146,1.686,148,0.382,163,1.24,164,1.16,205,1.223,235,1.214,278,2.511,284,1.496,348,1.574,355,3.09,411,0.821,412,2.021,553,2.261,567,3.09,648,2.143,681,2.946,736,3.8,1287,1.249,1503,1.897,1519,5.414,1520,2.643,1521,3.068]],["title/588",[18,0.661,144,1.355,278,2.794,412,1.239,1519,3.5]],["description/588",[5,1.751,8,0.235,14,1.056,18,0.746,37,2.145,43,2.672,117,1.921,120,2.589,144,0.996,278,2.055,284,1.994,348,3.219,412,2.056,553,3.014,567,2.529,648,2.856,736,4.77,830,2.93,1519,6.13,1522,4.089,1523,4.089]],["title/589",[23,0.672,119,2.232,120,1.887,412,1.239,1519,3.5]],["description/589",[5,1.462,7,0.563,8,0.222,13,1.887,18,0.757,43,2.028,50,0.966,71,0.883,119,1.245,120,2.49,145,0.411,146,1.702,148,0.386,163,1.254,164,1.173,174,1.445,205,1.237,235,1.228,278,1.559,348,1.593,355,3.119,411,0.831,412,1.927,553,2.287,567,3.119,648,2.167,681,2.966,736,3.835,1287,1.263,1453,1.777,1519,5.08,1520,2.673,1524,3.103,1525,3.103]],["title/590",[23,0.526,71,1.239,119,1.747,146,1.469,412,0.969,822,2.844,844,2.459,1519,2.739]],["description/590",[8,0.212,18,0.916,71,2.192,119,2.165,145,0.714,146,3.032,148,0.671,174,2.511,205,2.15,235,2.136,411,1.444,412,1.202,681,2.18,822,3.526,844,3.048,1287,2.196,1453,3.09,1519,3.395,1526,5.395]],["title/591",[23,0.615,117,2.391,278,2.558,412,1.134,514,2.701,1519,3.203]],["description/591",[5,1.331,7,0.671,8,0.223,14,0.955,18,0.44,43,2.416,50,1.151,88,1.284,117,1.737,120,2.429,163,1.494,164,1.397,278,2.915,348,1.898,355,3.588,412,2.082,514,1.962,553,2.725,567,3.588,648,2.582,681,2.894,736,4.411,1519,5.882,1520,3.185,1527,3.697]],["title/592",[19,1.671,114,1.931,200,3.23,1444,4.229,1519,3.5]],["description/592",[5,1.65,8,0.247,14,0.774,18,0.855,19,0.901,37,1.574,43,3.206,114,1.041,117,1.409,120,2.112,145,0.397,148,0.373,156,2.584,348,3.195,412,1.767,553,3.616,567,1.855,648,2.095,731,2.281,732,2.363,736,3.731,830,2.149,1444,2.281,1453,1.718,1497,2.749,1498,2.749,1499,4.227,1500,2.749,1501,2.749,1502,2.749,1519,5.654,1528,3,1529,3,1530,3]],["title/593",[2,2.63,163,2.758,164,2.58]],["description/593",[2,3.245,5,1.932,163,4.187,164,3.916]],["title/594",[163,2.758,164,2.58,603,2.948]],["description/594",[3,3.163,8,0.247,14,0.995,18,0.713,41,2.791,46,2.932,71,1.097,84,1.72,86,1.692,145,0.51,146,2.023,148,0.48,163,1.558,164,1.457,196,2.384,205,1.537,235,1.526,259,2.63,411,1.032,412,0.859,603,1.666,681,1.558,830,2.763,977,3.037,1035,3.037,1054,3.534,1166,3.163,1287,1.569,1453,2.208,1456,3.322,1509,3.322,1531,3.856,1532,3.856,1533,3.856,1534,3.856,1535,3.856,1536,3.856]],["title/595",[62,2.218,164,2.316,182,3.145,562,3.668]],["description/595",[5,1.456,8,0.237,14,1.072,18,0.754,36,1.78,41,1.933,50,1.292,62,2.296,71,1.182,145,0.549,146,2.141,148,0.517,164,1.569,182,2.131,183,2.567,205,1.655,235,1.643,248,2.975,262,1.632,299,2.345,388,2.285,411,1.112,412,0.925,448,2.485,562,2.485,681,1.678,1287,1.69,1479,2.832,1490,3.06,1503,2.567,1537,4.152,1538,4.152]],["title/596",[62,2.47,262,2.683,388,3.756]],["description/596",[5,1.456,8,0.237,14,1.072,18,0.754,36,1.78,41,1.933,50,1.292,62,2.296,71,1.182,145,0.549,146,2.141,148,0.517,164,1.569,182,2.131,183,2.567,205,1.655,235,1.643,248,2.975,262,1.632,299,2.345,388,2.285,411,1.112,412,0.925,448,2.485,562,2.485,681,1.678,1287,1.69,1479,2.832,1490,3.06,1503,2.567,1539,4.152,1540,4.152]],["title/597",[62,2.47,163,2.758,164,2.58]],["description/597",[5,1.391,8,0.248,14,1.01,18,0.721,36,1.677,41,1.821,50,1.218,62,2.193,71,1.113,144,0.953,145,0.518,146,2.045,148,0.487,163,3,164,2.291,183,2.419,205,1.559,235,1.548,248,2.803,254,2.507,299,2.21,411,1.047,412,0.871,448,2.341,459,3.209,681,1.581,1287,1.592,1468,3.585,1479,2.668,1503,2.419,1541,3.911,1542,3.911]],["title/598",[6,2.103,163,2.477,164,2.316,1543,5.617]],["description/598",[8,0.221,18,0.957,71,1.633,129,3.828,145,0.759,146,2.715,148,0.714,163,2.319,164,2.169,205,2.287,235,2.272,411,1.536,412,1.278,681,2.319,1287,2.336,1503,3.549,1543,5.26,1544,5.739]],["title/599",[6,2.342,262,2.683,388,3.756]],["description/599",[5,1.65,8,0.197,18,0.855,41,3.347,71,1.396,129,3.273,145,0.649,146,2.426,148,0.61,205,1.955,235,1.942,262,1.929,299,2.771,308,3.426,388,2.7,411,1.313,412,1.093,681,1.983,1287,1.997,1503,3.033,1545,4.905,1546,4.905,1547,4.905,1548,4.905]],["title/600",[6,2.103,164,2.316,182,3.145,562,3.668]],["description/600",[8,0.247,12,1.054,14,1.161,18,0.801,102,1.78,129,4.498,145,0.595,146,1.517,148,0.56,163,1.818,164,1.7,177,2.333,182,2.308,196,2.781,205,1.792,235,1.78,262,2.651,411,1.204,412,1.002,562,2.692,641,2.415,681,1.818,830,3.222,1287,1.83,1490,3.314,1503,2.781,1549,4.497,1550,4.497]],["title/601",[26,1.953,28,2.918,163,2.248,1475,4.099,1551,4.229]],["description/601",[8,0.221,18,0.957,28,3.011,71,1.633,145,0.759,146,2.715,148,0.714,205,2.287,235,2.272,348,2.945,411,1.536,412,1.278,681,2.319,1287,2.336,1453,3.286,1475,4.229,1551,4.364,1552,5.739]],["title/602",[26,1.788,28,2.671,164,1.924,562,3.047,1551,3.87,1553,4.665]],["description/602",[5,1.628,8,0.195,18,0.844,28,2.528,41,2.243,71,1.371,145,0.637,146,2.394,148,0.599,164,1.821,205,1.92,235,1.907,299,2.722,348,2.473,411,1.29,412,1.073,448,2.884,562,2.884,681,1.947,1287,1.961,1453,2.759,1479,3.286,1490,3.551,1551,3.663,1553,4.416,1554,4.818]],["title/603",[26,1.953,28,2.918,388,3.061,1489,4.791,1551,4.229]],["description/603",[5,1.695,8,0.203,18,0.878,28,2.671,41,2.369,71,1.449,145,0.673,146,2.493,148,0.633,205,2.029,235,2.015,299,2.875,348,2.612,411,1.363,412,1.134,448,3.047,681,2.057,1287,2.072,1453,2.915,1479,3.472,1489,4.385,1551,3.87,1555,5.09]],["title/604",[26,1.788,142,3.095,143,2.102,163,2.057,1494,4.009,1505,3.262]],["description/604",[8,0.209,9,2.949,18,0.903,71,1.505,126,1.542,142,3.217,143,2.184,145,0.7,146,2.563,148,0.658,163,2.138,205,2.108,235,2.094,349,4.022,411,1.416,412,1.178,681,2.138,1287,2.153,1453,3.029,1494,4.166,1505,3.39,1556,5.289]],["title/605",[163,2.758,164,2.58,548,4.375]],["description/605",[8,0.206,14,1.339,18,0.89,41,2.415,71,1.477,88,1.801,145,0.686,146,2.527,148,0.645,164,1.961,183,3.208,205,2.068,235,2.054,299,4.231,411,1.389,412,1.156,448,3.105,681,2.097,1287,2.112,1479,3.538,1503,3.208,1557,5.188]],["title/606",[262,2.683,388,3.756,548,4.375]],["description/606",[8,0.224,18,0.971,71,1.669,88,2.035,145,0.776,146,2.756,148,0.729,205,2.337,235,2.321,262,2.305,388,3.227,411,1.57,412,1.306,681,2.37,1287,2.386,1453,3.358,1558,5.863]],["title/607",[164,2.316,182,3.145,548,3.928,562,3.668]],["description/607",[8,0.234,14,1.266,18,0.855,41,2.283,71,1.396,88,1.703,145,0.649,146,2.426,148,0.61,164,1.854,182,2.517,183,3.033,205,1.955,235,1.942,299,2.771,411,1.313,412,1.093,448,2.936,562,2.936,681,1.983,1287,1.997,1479,3.346,1490,3.615,1503,3.033,1559,4.905]],["title/608",[145,0.903,163,2.758,164,2.58]],["description/608",[5,1.439,7,0.742,8,0.21,18,0.746,41,2.92,46,3.109,48,2.93,50,1.953,51,4.278,52,2.856,53,5.147,71,1.164,90,2.31,95,2.31,145,0.541,146,2.117,148,0.509,164,1.545,205,1.63,235,1.619,264,3.109,330,3.014,331,3.221,411,1.095,412,0.911,416,2.93,681,2.535,1287,1.664,1503,2.529,1560,4.089]],["title/609",[145,0.903,262,2.683,388,3.756]],["description/609",[7,0.742,8,0.21,14,1.056,18,0.746,41,2.92,46,3.109,48,2.93,50,1.953,51,4.278,52,2.856,53,5.147,71,1.164,90,2.31,95,2.31,145,0.541,146,2.117,148,0.509,205,1.63,235,1.619,262,1.608,264,3.109,330,3.014,331,3.221,388,2.25,411,1.095,412,0.911,416,2.93,681,2.535,1287,1.664,1503,2.529,1561,4.089]],["title/610",[144,1.663,749,4.553,1562,5.376]],["description/610",[5,1.932,144,2.052,163,3.403,164,3.182,749,5.618,1562,6.633]],["title/611",[80,3.382,144,1.355,502,2.201,749,3.71,1562,4.38]],["description/611",[8,0.185,12,1.58,77,4.405,80,4.099,119,2.705,144,2.189,174,3.138,177,3.497,182,3.459,194,5.309,408,5.125,502,2.668,1563,6.74]],["title/612",[51,3.793,80,3.382,144,1.355,749,3.71,1562,4.38]],["description/612",[8,0.185,12,1.58,51,4.597,77,4.405,80,4.099,119,2.705,144,2.189,174,3.138,177,3.497,182,3.459,194,5.309,408,5.125,1564,6.74]],["title/613",[144,1.663,749,4.553,1562,5.376]],["description/613",[8,0.261,12,1.405,50,1.866,77,3.917,119,2.405,144,2.021,174,2.79,177,3.109,194,4.721,408,4.557,470,5.493,504,4.917,567,3.706,830,4.294,1565,5.993,1566,5.993]],["title/614",[144,1.877,273,4.846]],["description/614",[5,2.06,144,2.188,273,6.78]],["title/615",[11,2.402,23,0.672,144,1.355,284,2.712,868,2.885]],["description/615",[8,0.224,23,0.987,514,4.334,653,5.703,759,6.432,868,4.237,1567,8.166]],["title/616",[23,0.741,144,1.494,273,3.857,1409,4.28]],["description/616",[5,1.784,7,1.166,8,0.214,13,4.73,14,1.089,16,0.817,23,0.51,24,1.06,50,1.999,75,2.607,76,2.382,88,1.464,120,1.431,144,1.028,196,2.607,238,3.633,297,3.865,508,1.836,567,2.607,847,3.633,1409,4.485,1568,4.217,1569,4.217,1570,4.217,1571,4.217,1572,4.217,1573,4.217,1574,3.321,1575,4.217]],["title/617",[23,0.741,144,1.494,273,3.857,1576,5.028]],["description/617",[7,1.439,8,0.218,16,1.535,112,5.842,144,1.932,273,4.988,1576,6.503,1577,7.926]],["title/618",[23,0.672,144,1.355,273,3.5,284,2.712,1576,4.563]],["description/618",[8,0.231,23,1.018,273,5.299,514,4.469,1576,6.909,1578,8.42]],["title/619",[126,2.245,1579,6.318]],["description/619",[5,2.06,126,2.619,273,5.651,1579,7.368]],["title/620",[23,0.741,114,2.128,1579,5.028,1580,5.028]],["description/620",[7,0.754,8,0.174,14,1.072,16,0.804,18,0.754,23,0.502,24,1.043,50,1.292,64,1.182,65,2.412,71,1.182,82,1.78,83,1.182,84,1.852,111,2.378,114,2.674,144,1.012,145,0.549,146,2.141,147,1.766,148,0.517,232,2.975,305,3.157,641,2.23,868,3.293,977,3.27,1073,3.27,1228,3.805,1580,3.406,1581,3.805,1582,4.152,1583,3.577,1584,4.152]],["title/621",[114,1.767,123,2.767,135,2.252,137,3.203,1579,4.176,1580,4.176]],["description/621",[2,1.576,7,0.742,8,0.172,16,1.215,18,0.907,50,1.273,64,2.172,65,2.375,71,1.164,77,2.672,82,1.753,83,1.164,84,1.824,86,1.794,120,2.129,137,2.573,144,0.996,145,0.541,146,1.38,147,1.739,148,0.509,641,2.196,868,3.96,1073,3.221,1580,3.355,1581,5.749,1585,4.089,1586,3.355,1587,3.221,1588,4.089]],["title/622",[1589,7.247]],["description/622",[35,5.319,36,3.981,1589,7.621]],["title/623",[49,4.46,114,2.369,1589,5.6]],["description/623",[8,0.211,24,1.935,49,5.033,88,2.673,114,2.673,1210,4.539,1589,6.318,1590,4.936,1591,7.701]],["title/624",[126,2.245,1590,4.936]],["description/624",[5,1.932,71,2.397,114,2.923,126,2.455,146,2.841,1590,5.397]],["title/625",[1592,4.861]],["description/625",[49,6.286,1592,5.294]],["title/626",[49,4.46,259,4.655,1592,3.756]],["description/626",[8,0.224,23,0.987,24,2.052,49,5.337,73,4.552,1592,4.494,1593,8.166]],["title/627",[2,2.968,93,3.684]],["description/627",[2,3.993,5,1.932,71,2.397,93,4.028,146,2.841]],["title/628",[26,2.152,93,2.932,126,1.787,1594,3.857]],["description/628",[8,0.247,14,1.74,16,1.305,18,1.068,71,1.918,93,3.225,146,2.274,148,0.839,305,5.125,392,1.65,1594,4.242,1595,6.74]],["title/629",[18,0.811,93,3.265,1594,4.295]],["description/629",[8,0.247,16,1.305,18,1.201,71,1.918,93,3.225,145,0.892,146,2.274,148,0.839,398,3.71,1594,4.242,1596,6.74]],["title/630",[93,3.265,120,2.316,1594,4.295]],["description/630",[8,0.235,16,1.214,18,1.017,71,1.785,93,3,114,2.177,120,2.128,129,4.184,145,0.83,146,2.116,148,0.78,407,3.184,844,3.543,1594,3.946,1597,6.271]],["title/631",[23,0.825,93,3.265,1594,4.295]],["description/631",[8,0.247,18,1.068,24,1.694,71,1.918,93,3.225,145,0.892,146,2.274,148,0.839,392,1.65,1438,6.178,1594,4.242,1598,6.74]],["title/632",[93,2.932,603,2.647,1332,4.828,1594,3.857]],["description/632",[8,0.249,14,1.421,18,0.929,55,4.743,63,3.673,71,1.567,93,2.634,145,0.728,146,1.857,148,0.685,200,3.198,288,3.944,392,1.347,603,3.376,1265,3.673,1332,4.336,1594,3.464,1599,5.505,1600,5.505]],["title/633",[93,3.265,313,5.376,1594,4.295]],["description/633",[5,1.566,6,2.804,8,0.224,16,0.886,17,2.878,18,0.812,71,1.302,84,2.04,86,2.007,93,4.638,145,0.605,146,2.304,148,0.569,313,6.435,392,1.119,534,3.194,1594,2.878,1601,4.573,1602,4.573,1603,4.573]],["title/634",[93,3.265,310,5.88,1594,4.295]],["description/634",[5,1.743,8,0.244,14,1.365,16,1.024,18,0.903,62,2.748,71,1.505,93,4.251,146,1.785,148,0.945,202,3.898,310,6.543,392,1.295,1594,3.328,1604,5.289,1605,5.289]],["title/635",[1606,5.662]],["description/635",[35,5.319,36,3.981,1606,5.953]],["title/636",[18,0.811,144,1.663,1606,4.375]],["description/636",[7,1.224,8,0.247,12,1.58,18,1.201,144,1.643,145,0.892,148,0.839,398,3.71,641,3.62,1606,4.32,1607,6.74]],["title/637",[18,0.729,144,1.494,895,4.28,1606,3.928]],["description/637",[8,0.251,18,1.216,144,1.685,145,0.915,148,0.86,284,3.371,398,3.805,641,3.712,1606,4.431,1608,6.913]],["title/638",[120,2.316,144,1.663,1606,4.375]],["description/638",[7,1.224,8,0.247,12,1.58,18,1.068,120,2.287,144,1.643,145,0.892,148,0.839,398,3.71,641,3.62,1606,4.32,1609,6.74]],["title/639",[120,2.08,144,1.494,895,4.28,1606,3.928]],["description/639",[8,0.251,18,1.086,120,2.346,144,1.685,145,0.915,148,0.86,284,3.371,398,3.805,641,3.712,1606,4.431,1610,6.913]],["title/640",[23,0.741,117,2.879,603,2.647,1606,3.928]],["description/640",[8,0.243,18,1.05,71,2.515,119,2.639,145,0.87,146,2.219,148,0.818,174,3.061,398,3.619,603,2.841,1606,4.215,1611,6.576]],["title/641",[23,0.741,117,2.879,144,1.494,1606,3.928]],["description/641",[7,1.194,8,0.243,12,1.541,18,1.05,23,0.795,117,3.089,144,1.603,145,0.87,148,0.818,398,3.619,641,3.532,1612,6.576,1613,6.576]],["title/642",[1614,8.096]],["description/642",[35,5.319,36,3.981,1614,8.513]],["title/643",[120,2.08,135,2.711,446,3.79,1615,4.392]],["description/643",[5,1.586,8,0.251,14,1.785,50,2.152,120,2.346,135,3.058,446,4.275,603,2.986,1574,5.445,1615,4.953,1616,5.672,1617,6.913]],["title/644",[62,2.218,446,3.79,972,3.613,1615,4.392]],["description/644",[5,1.586,8,0.251,14,1.785,50,2.152,135,3.058,332,5.956,446,4.275,603,2.986,1574,5.445,1615,4.953,1616,5.672,1618,6.913]],["title/645",[114,1.931,135,2.46,346,4.38,446,3.439,1615,3.985]],["description/645",[5,1.546,8,0.247,14,1.74,50,2.098,114,2.34,135,2.982,346,5.309,446,4.168,603,2.912,1574,5.309,1615,4.83,1616,5.53,1619,6.74]],["title/646",[18,0.729,135,2.711,446,3.79,1615,4.392]],["description/646",[5,1.586,8,0.251,14,1.785,18,0.822,50,2.152,135,3.058,446,4.275,603,2.986,1574,5.445,1615,4.953,1616,5.672,1620,6.913]],["title/647",[126,2.245,1592,4.238]],["description/647",[2,3.245,5,1.932,71,2.397,126,2.455,146,2.841,1592,4.634]],["title/648",[23,0.741,1592,3.373,1621,5.617,1622,4.18]],["description/648",[8,0.197,14,1.266,18,0.855,23,0.593,37,2.574,50,1.527,71,1.396,82,2.103,83,1.396,84,2.188,86,3.156,145,0.649,148,0.895,219,4.025,407,2.491,473,3.087,641,2.634,1073,3.864,1210,2.892,1590,3.144,1592,3.958,1621,4.496,1622,3.346,1623,4.905]],["title/649",[23,0.672,114,1.931,144,1.355,318,3.382,1592,3.061]],["description/649",[8,0.212,14,1.393,18,0.916,24,1.356,37,2.831,73,3.008,86,2.368,114,1.873,144,1.315,145,0.714,148,0.958,284,2.631,407,2.739,473,3.395,611,4.945,641,2.897,1210,3.18,1590,3.458,1592,4.24,1624,5.395]],["title/650",[23,0.741,73,3.417,603,2.647,1592,3.373]],["description/650",[8,0.224,14,1.514,18,0.971,24,1.474,37,3.076,73,3.269,86,2.573,145,0.776,148,1.016,407,2.977,473,3.689,641,3.149,827,5.051,1210,3.456,1590,3.758,1592,3.227,1625,5.863]],["title/651",[23,0.672,673,3.382,972,3.278,1235,3.71,1626,4.229]],["description/651",[8,0.212,14,1.393,18,0.916,19,1.621,23,0.652,37,2.831,86,2.368,120,1.831,145,0.714,148,0.958,407,2.739,473,3.395,641,2.897,673,3.281,972,3.18,1210,3.18,1235,3.599,1590,3.458,1626,4.102,1627,4.249,1628,5.395]],["title/652",[23,0.741,73,3.417,357,3.857,1592,3.373]],["description/652",[8,0.243,18,1.05,24,1.653,71,1.872,73,3.666,145,0.87,146,2.219,148,0.818,357,4.138,392,1.61,1592,3.619,1629,6.576,1630,6.576]],["title/653",[23,0.741,632,4.66,1171,4.828,1592,3.373]],["description/653",[5,1.423,8,0.17,14,1.04,18,0.737,24,1.558,37,2.113,75,2.491,76,2.275,86,1.768,120,1.367,145,0.533,148,0.772,293,3.173,407,2.045,473,2.535,632,4.715,641,2.163,673,2.45,1171,4.884,1210,2.374,1235,2.687,1583,3.47,1590,2.582,1592,2.217,1627,5.955,1631,3.692,1632,5.683,1633,4.028,1634,3.692,1635,3.692,1636,4.028]],["title/654",[19,1.841,23,0.741,1180,4.828,1626,4.66]],["description/654",[8,0.197,14,1.266,18,0.855,19,1.474,24,1.233,37,2.574,76,2.771,86,3.156,102,1.942,120,1.664,135,2.17,145,0.649,148,0.895,214,2.44,407,2.491,473,3.087,641,2.634,673,2.983,1180,3.864,1210,2.892,1587,3.864,1590,3.144,1626,3.73,1627,3.864,1637,4.905]],["title/655",[26,2.152,632,4.66,1171,4.828,1592,3.373]],["description/655",[5,1.703,8,0.166,14,1.01,18,0.721,24,0.983,37,2.052,71,1.113,75,2.419,76,2.21,86,1.717,120,1.327,126,1.141,145,0.518,146,1.32,148,0.754,258,2.556,263,2.306,293,3.081,392,0.957,473,2.461,632,4.609,1171,4.775,1210,2.306,1583,3.37,1590,2.507,1592,2.153,1627,5.846,1631,3.585,1632,5.556,1634,3.585,1635,3.585,1638,3.911,1639,3.911]],["title/656",[26,1.953,673,3.382,972,3.278,1235,3.71,1626,4.229]],["description/656",[8,0.212,14,1.393,18,0.916,19,1.621,37,2.831,86,2.368,120,1.831,145,0.714,148,0.958,348,2.769,407,2.739,473,3.395,641,2.897,673,3.281,972,3.18,1210,3.18,1235,3.599,1590,3.458,1626,4.102,1627,4.249,1640,5.395]],["title/657",[26,1.953,73,3.1,673,3.382,1235,3.71,1592,3.061]],["description/657",[8,0.221,14,1.481,18,0.957,37,3.011,73,3.199,86,2.518,126,1.673,145,0.759,148,1.001,407,2.914,473,3.611,641,3.082,673,3.49,1210,3.383,1235,3.828,1590,3.678,1592,3.158,1641,5.739]],["title/658",[23,0.672,73,3.1,673,3.382,1235,3.71,1592,3.061]],["description/658",[8,0.19,14,1.201,18,0.822,23,0.562,28,2.441,37,2.441,71,1.324,73,3.855,77,3.04,86,2.042,111,2.664,145,0.615,146,1.57,148,0.86,213,2.877,214,3.439,308,3.249,407,2.362,473,2.927,673,4.205,1210,2.742,1445,4.008,1586,3.817,1590,2.982,1592,2.56,1642,4.652]],["title/659",[2,2.968,1622,5.252]],["description/659",[2,3.349,5,1.994,114,3.017,1505,5.571,1622,5.927]],["title/660",[71,1.449,106,2.369,146,1.717,857,2.915,1622,3.471,1643,3.203]],["description/660",[6,2.152,8,0.235,18,1.017,19,1.884,145,0.83,146,2.116,147,2.668,148,0.78,634,5.145,639,5.748,844,3.543,857,3.591,1622,4.277,1643,3.946,1644,6.271]],["title/661",[32,2.149,71,1.449,146,1.717,857,2.915,1622,3.471,1643,3.203]],["description/661",[8,0.247,18,1.068,62,2.439,145,0.892,148,0.839,392,1.65,641,3.62,844,3.808,857,3.86,1622,4.597,1643,4.242,1645,6.74]],["title/662",[23,0.672,110,3.278,146,1.876,1622,3.793,1643,3.5]],["description/662",[8,0.251,18,1.086,24,1.737,145,0.915,148,0.86,392,1.692,641,3.712,1622,4.715,1643,4.35,1646,6.336,1647,6.913]],["title/663",[23,0.825,83,1.943,637,3.856]],["description/663",[5,1.933,8,0.231,18,1.001,71,1.744,83,1.744,88,2.128,90,3.462,144,1.494,145,0.811,146,2.068,148,0.763,392,1.5,637,3.462,935,4.66,1648,6.129]],["title/664",[868,4.583]],["description/664",[5,2.06,114,3.117,868,4.659,1505,5.756]],["title/665",[19,1.841,62,2.218,868,3.18,1649,4.392]],["description/665",[19,2.249,62,2.709,102,2.964,105,3.885,135,3.312,220,5.106,868,4.993,1649,5.365,1650,7.487]],["title/666",[7,0.924,12,1.193,88,1.767,126,1.484,868,2.641,1649,3.647]],["description/666",[8,0.224,12,1.914,88,2.835,126,2.381,868,4.237,1649,5.851,1651,8.166]],["title/667",[7,0.924,12,1.193,19,1.529,23,0.615,24,1.279,1649,3.647]],["description/667",[8,0.224,19,2.453,23,0.987,24,2.052,135,3.613,1649,5.851,1652,8.166]],["title/668",[7,0.924,12,1.193,126,1.484,137,3.203,868,2.641,1649,3.647]],["description/668",[8,0.185,12,1.58,14,1.74,68,3.577,126,1.965,137,4.242,299,3.808,408,5.125,868,3.497,1649,4.83,1653,6.74,1654,6.74,1655,6.74,1656,6.74]],["title/669",[2,2.63,857,3.909,1643,4.295]],["description/669",[2,3.245,5,1.932,114,2.923,857,4.822,1505,5.397,1643,5.299]],["title/670",[71,1.583,106,2.589,146,1.876,857,3.185,1643,3.5]],["description/670",[8,0.247,18,1.068,106,3.138,145,0.892,146,2.274,147,2.867,148,0.839,634,5.53,844,3.808,857,3.86,1643,4.242,1657,6.74]],["title/671",[32,2.348,71,1.583,146,1.876,857,3.185,1643,3.5]],["description/671",[8,0.251,18,1.086,32,2.918,145,0.915,148,0.86,392,1.692,641,3.712,844,3.905,857,3.959,1643,4.35,1658,6.913]],["title/672",[23,0.672,110,3.278,146,1.876,857,3.185,1643,3.5]],["description/672",[8,0.231,14,1.244,18,0.844,24,1.783,64,1.371,71,1.371,73,2.686,112,3.551,120,1.635,144,1.174,145,0.637,146,1.626,148,0.883,259,3.286,392,1.179,857,4.824,1592,2.652,1643,5.301,1646,4.416,1659,4.818,1660,4.818]],["title/673",[83,2.192,636,3.553]],["description/673",[5,1.994,83,2.474,114,3.017,636,4.01,1505,5.571]],["title/674",[23,0.741,83,1.744,636,2.828,1322,2.69]],["description/674",[7,1.255,8,0.19,83,1.967,88,2.4,117,3.247,135,3.058,144,1.685,233,5.956,349,5.256,603,2.986,636,3.19,1322,3.034,1661,6.913]],["title/675",[603,3.326,636,3.553]],["description/675",[5,1.994,114,3.017,603,3.754,636,4.01,1505,5.571]],["title/676",[603,2.948,636,3.149,1322,2.995]],["description/676",[7,1.398,8,0.211,135,3.407,144,1.877,349,5.855,603,3.326,636,3.553,1322,3.379,1662,7.701]],["title/677",[2,2.63,636,3.149,1663,5.03]],["description/677",[2,3.245,5,1.932,114,2.923,636,3.885,1505,5.397,1663,6.206]],["title/678",[23,0.672,113,2.824,636,2.566,1002,3.634,1663,4.099]],["description/678",[5,2.081,7,0.386,8,0.232,12,0.498,13,1.293,14,0.549,16,0.711,18,0.437,24,1.638,41,2.257,64,1.643,71,0.605,113,1.08,119,0.853,135,2.883,145,0.281,146,0.718,148,0.457,223,4.546,280,2.354,293,1.675,342,1.745,392,0.52,395,1.567,400,1.617,471,1.524,524,1.617,636,0.981,645,1.363,1002,6.092,1332,2.893,1484,4.177,1586,3.978,1587,6.364,1664,1.832,1665,1.949,1666,1.949,1667,1.949,1668,1.949,1669,2.126]],["title/679",[106,2.853,636,2.828,1505,3.928,1663,4.517]],["description/679",[5,2.105,6,1.144,8,0.147,14,0.491,18,0.396,19,1.336,50,1.038,64,1.266,76,1.074,82,0.815,83,0.949,84,0.848,86,0.835,99,1.446,102,2.115,119,0.763,135,1.475,145,0.252,147,0.809,148,0.554,186,1.121,223,2.625,280,2.136,284,0.927,289,1.561,372,0.878,395,1.402,400,2.534,475,1.561,517,1.297,636,3.086,645,1.219,652,1.498,868,0.987,892,1.269,972,1.121,1002,4.371,1332,1.498,1484,1.639,1499,1.639,1505,3.895,1586,1.561,1587,2.625,1663,5.922,1664,1.639,1665,1.743,1666,1.743,1667,1.743,1668,1.743,1670,1.902,1671,1.743,1672,1.902,1673,1.902,1674,1.743,1675,1.902,1676,3.333,1677,1.902,1678,1.902,1679,1.902,1680,1.902]],["title/680",[23,0.672,83,1.583,636,2.566,1505,3.564,1663,4.099]],["description/680",[7,0.742,8,0.21,12,0.958,14,1.056,18,0.746,19,1.228,24,1.577,65,2.375,71,1.164,82,1.753,83,2.172,84,1.824,86,2.753,88,1.42,145,0.541,146,1.38,148,0.509,407,2.076,420,3.109,514,2.17,636,3.521,892,2.728,1505,4.021,1587,3.221,1663,4.623,1664,3.523,1671,3.748,1674,3.748,1681,4.089]]],"invertedIndex":[["",{"_index":5,"title":{"153":{},"161":{}},"description":{"0":{},"6":{},"7":{},"8":{},"9":{},"10":{},"13":{},"19":{},"25":{},"28":{},"36":{},"44":{},"51":{},"54":{},"57":{},"61":{},"65":{},"69":{},"70":{},"71":{},"74":{},"76":{},"78":{},"83":{},"111":{},"117":{},"118":{},"119":{},"120":{},"125":{},"127":{},"130":{},"134":{},"138":{},"142":{},"149":{},"159":{},"166":{},"169":{},"175":{},"176":{},"179":{},"185":{},"194":{},"196":{},"202":{},"206":{},"209":{},"211":{},"218":{},"221":{},"224":{},"230":{},"260":{},"269":{},"272":{},"281":{},"286":{},"292":{},"293":{},"294":{},"295":{},"296":{},"299":{},"302":{},"308":{},"322":{},"330":{},"337":{},"340":{},"341":{},"348":{},"349":{},"375":{},"377":{},"378":{},"379":{},"380":{},"381":{},"382":{},"394":{},"404":{},"409":{},"418":{},"423":{},"424":{},"425":{},"426":{},"427":{},"428":{},"429":{},"430":{},"431":{},"432":{},"435":{},"442":{},"445":{},"446":{},"450":{},"464":{},"471":{},"484":{},"490":{},"494":{},"502":{},"504":{},"506":{},"509":{},"511":{},"514":{},"516":{},"522":{},"523":{},"528":{},"536":{},"541":{},"544":{},"546":{},"549":{},"555":{},"556":{},"557":{},"565":{},"570":{},"577":{},"578":{},"584":{},"586":{},"587":{},"588":{},"589":{},"591":{},"592":{},"593":{},"595":{},"596":{},"597":{},"599":{},"602":{},"603":{},"608":{},"610":{},"614":{},"616":{},"619":{},"624":{},"627":{},"633":{},"634":{},"643":{},"644":{},"645":{},"646":{},"647":{},"653":{},"655":{},"659":{},"663":{},"664":{},"669":{},"673":{},"675":{},"677":{},"678":{},"679":{}}}],["0",{"_index":1299,"title":{},"description":{"477":{}}}],["0700",{"_index":1673,"title":{},"description":{"679":{}}}],["1",{"_index":1052,"title":{},"description":{"381":{},"442":{},"465":{},"466":{},"467":{},"468":{},"469":{},"470":{}}}],["1'",{"_index":1129,"title":{},"description":{"417":{}}}],["128",{"_index":265,"title":{},"description":{"69":{},"70":{}}}],["2",{"_index":1207,"title":{},"description":{"442":{},"465":{},"466":{},"467":{},"468":{},"469":{},"470":{}}}],["200",{"_index":1000,"title":{"355":{}},"description":{"355":{}}}],["2048",{"_index":266,"title":{},"description":{"69":{},"70":{}}}],["2fa",{"_index":127,"title":{"20":{},"21":{},"22":{},"23":{},"24":{}},"description":{}}],["3",{"_index":545,"title":{},"description":{"167":{},"442":{},"465":{},"466":{},"467":{},"468":{},"469":{},"470":{}}}],["3](https://tools.ietf.org/html/rfc4470",{"_index":575,"title":{},"description":{"177":{}}}],["3rdparti",{"_index":1224,"title":{},"description":{"444":{}}}],["4",{"_index":1210,"title":{},"description":{"442":{},"465":{},"466":{},"467":{},"468":{},"469":{},"470":{},"623":{},"648":{},"649":{},"650":{},"651":{},"653":{},"654":{},"655":{},"656":{},"657":{},"658":{}}}],["4,096",{"_index":789,"title":{},"description":{"269":{}}}],["5",{"_index":1268,"title":{},"description":{"465":{},"466":{},"467":{},"468":{},"469":{},"470":{}}}],["6",{"_index":1271,"title":{},"description":{"465":{},"466":{},"467":{},"468":{},"469":{},"470":{}}}],["7-bit",{"_index":518,"title":{},"description":{"155":{},"163":{}}}],["_bandwidth",{"_index":1569,"title":{},"description":{"616":{}}}],["_calendar",{"_index":1497,"title":{},"description":{"577":{},"592":{}}}],["_cpanel",{"_index":295,"title":{},"description":{"78":{}}}],["_dns_",{"_index":558,"title":{},"description":{"171":{},"180":{},"181":{},"182":{},"183":{},"184":{}}}],["_featur",{"_index":1571,"title":{},"description":{"616":{}}}],["_ftp",{"_index":1064,"title":{},"description":{"386":{}}}],["_home",{"_index":1397,"title":{},"description":{"523":{}}}],["_postgresql",{"_index":1395,"title":{},"description":{"523":{}}}],["_receiv",{"_index":731,"title":{},"description":{"242":{},"268":{},"316":{},"360":{},"577":{},"592":{}}}],["_synchron",{"_index":1393,"title":{},"description":{"523":{}}}],["_web",{"_index":1499,"title":{},"description":{"577":{},"592":{},"679":{}}}],["_webmail_",{"_index":1501,"title":{},"description":{"577":{},"592":{}}}],["_whm",{"_index":1573,"title":{},"description":{"616":{}}}],["aaaa",{"_index":627,"title":{},"description":{"199":{}}}],["abil",{"_index":828,"title":{},"description":{"283":{},"293":{},"294":{},"295":{}}}],["absolut",{"_index":1367,"title":{},"description":{"514":{}}}],["access",{"_index":11,"title":{"62":{},"447":{},"449":{},"615":{}},"description":{"1":{},"26":{},"27":{},"35":{},"62":{},"91":{},"96":{},"103":{},"129":{},"144":{},"147":{},"148":{},"222":{},"296":{},"381":{},"431":{},"447":{},"449":{},"485":{},"486":{},"487":{},"488":{},"489":{},"495":{},"496":{},"497":{},"498":{},"499":{},"500":{},"501":{},"502":{},"503":{},"505":{},"506":{},"507":{},"508":{},"509":{},"510":{},"511":{},"512":{},"513":{},"514":{},"515":{},"523":{}}}],["access-log",{"_index":1182,"title":{},"description":{"431":{}}}],["account",{"_index":16,"title":{"22":{},"48":{},"49":{},"50":{},"51":{},"52":{},"54":{},"55":{},"73":{},"77":{},"78":{},"82":{},"83":{},"106":{},"107":{},"108":{},"109":{},"113":{},"131":{},"221":{},"222":{},"226":{},"246":{},"247":{},"248":{},"249":{},"252":{},"256":{},"259":{},"262":{},"263":{},"274":{},"283":{},"284":{},"286":{},"293":{},"294":{},"295":{},"296":{},"297":{},"298":{},"319":{},"338":{},"340":{},"341":{},"342":{},"343":{},"350":{},"353":{},"354":{},"357":{},"359":{},"362":{},"364":{},"368":{},"373":{},"382":{},"383":{},"384":{},"385":{},"388":{},"392":{},"419":{},"420":{},"555":{},"556":{},"565":{}},"description":{"1":{},"4":{},"8":{},"9":{},"14":{},"17":{},"18":{},"22":{},"23":{},"26":{},"27":{},"44":{},"45":{},"47":{},"48":{},"49":{},"50":{},"51":{},"52":{},"53":{},"54":{},"57":{},"58":{},"60":{},"61":{},"62":{},"65":{},"71":{},"72":{},"74":{},"76":{},"77":{},"78":{},"82":{},"83":{},"97":{},"111":{},"136":{},"137":{},"139":{},"141":{},"144":{},"146":{},"147":{},"148":{},"207":{},"209":{},"210":{},"221":{},"222":{},"225":{},"226":{},"227":{},"230":{},"234":{},"236":{},"237":{},"238":{},"240":{},"246":{},"247":{},"249":{},"251":{},"252":{},"255":{},"256":{},"259":{},"261":{},"270":{},"276":{},"283":{},"284":{},"286":{},"288":{},"293":{},"294":{},"295":{},"296":{},"297":{},"298":{},"307":{},"310":{},"314":{},"327":{},"328":{},"331":{},"338":{},"340":{},"341":{},"342":{},"343":{},"344":{},"346":{},"347":{},"350":{},"368":{},"378":{},"380":{},"382":{},"383":{},"384":{},"385":{},"388":{},"390":{},"392":{},"395":{},"396":{},"419":{},"421":{},"428":{},"429":{},"431":{},"436":{},"462":{},"465":{},"472":{},"473":{},"474":{},"479":{},"486":{},"489":{},"496":{},"514":{},"523":{},"546":{},"548":{},"555":{},"565":{},"566":{},"568":{},"571":{},"616":{},"617":{},"620":{},"621":{},"628":{},"629":{},"630":{},"633":{},"634":{},"678":{}}}],["account'",{"_index":12,"title":{"26":{},"27":{},"49":{},"53":{},"62":{},"63":{},"64":{},"79":{},"84":{},"208":{},"225":{},"226":{},"227":{},"228":{},"230":{},"231":{},"232":{},"233":{},"234":{},"235":{},"236":{},"237":{},"238":{},"239":{},"240":{},"241":{},"242":{},"245":{},"253":{},"255":{},"261":{},"271":{},"276":{},"277":{},"288":{},"303":{},"306":{},"310":{},"311":{},"314":{},"317":{},"318":{},"361":{},"365":{},"371":{},"386":{},"387":{},"389":{},"390":{},"391":{},"486":{},"489":{},"534":{},"666":{},"667":{},"668":{}},"description":{"1":{},"2":{},"3":{},"9":{},"46":{},"49":{},"55":{},"59":{},"63":{},"64":{},"66":{},"67":{},"73":{},"76":{},"79":{},"84":{},"110":{},"117":{},"118":{},"119":{},"131":{},"132":{},"152":{},"160":{},"199":{},"207":{},"208":{},"210":{},"215":{},"223":{},"229":{},"232":{},"233":{},"235":{},"239":{},"240":{},"241":{},"242":{},"245":{},"246":{},"247":{},"248":{},"266":{},"270":{},"303":{},"311":{},"317":{},"318":{},"319":{},"332":{},"333":{},"334":{},"335":{},"336":{},"340":{},"361":{},"365":{},"367":{},"371":{},"376":{},"386":{},"387":{},"389":{},"391":{},"420":{},"430":{},"433":{},"434":{},"441":{},"447":{},"448":{},"449":{},"455":{},"472":{},"473":{},"474":{},"491":{},"493":{},"509":{},"520":{},"527":{},"534":{},"537":{},"538":{},"539":{},"540":{},"554":{},"555":{},"556":{},"578":{},"579":{},"580":{},"582":{},"583":{},"584":{},"600":{},"611":{},"612":{},"613":{},"636":{},"638":{},"641":{},"666":{},"668":{},"678":{},"680":{}}}],["account-level",{"_index":777,"title":{"265":{}},"description":{"265":{}}}],["account](https://docs.cpanel.net/knowledge-base/cpanel-product/cpanel-glossary#distributed-cpanel-account",{"_index":1568,"title":{},"description":{"616":{}}}],["account](https://go.cpanel.net/cpanelglossary#distributed-cpanel-account",{"_index":1412,"title":{},"description":{"534":{}}}],["account](https://go.cpanel.net/glossaryd",{"_index":239,"title":{},"description":{"66":{}}}],["accountenhancements/has_enhanc",{"_index":222,"title":{},"description":{"50":{}}}],["accountenhancements/list",{"_index":218,"title":{},"description":{"49":{}}}],["accounts](https://go.cpanel.net/cpaneldocsemailaccount",{"_index":695,"title":{},"description":{"226":{}}}],["account’",{"_index":1438,"title":{"554":{}},"description":{"631":{}}}],["action",{"_index":184,"title":{"374":{}},"description":{"38":{},"91":{},"96":{},"103":{},"175":{},"269":{},"298":{},"374":{},"442":{},"470":{}}}],["action1",{"_index":791,"title":{},"description":{"269":{}}}],["action2",{"_index":798,"title":{},"description":{"269":{}}}],["activ",{"_index":577,"title":{"400":{}},"description":{"178":{},"400":{},"496":{},"499":{},"555":{},"556":{}}}],["actual",{"_index":646,"title":{},"description":{"207":{},"209":{},"210":{}}}],["add",{"_index":106,"title":{"14":{},"26":{},"91":{},"96":{},"148":{},"170":{},"196":{},"197":{},"212":{},"257":{},"309":{},"351":{},"357":{},"363":{},"372":{},"446":{},"488":{},"556":{},"660":{},"670":{},"679":{}},"description":{"14":{},"91":{},"96":{},"148":{},"156":{},"164":{},"169":{},"176":{},"204":{},"212":{},"257":{},"258":{},"372":{},"446":{},"478":{},"523":{},"563":{},"670":{}}}],["addit",{"_index":977,"title":{},"description":{"346":{},"347":{},"442":{},"594":{},"620":{}}}],["addon",{"_index":661,"title":{"490":{}},"description":{"209":{},"490":{}}}],["address",{"_index":143,"title":{"26":{},"27":{},"45":{},"58":{},"93":{},"157":{},"224":{},"229":{},"244":{},"250":{},"254":{},"351":{},"363":{},"372":{},"472":{},"473":{},"474":{},"481":{},"542":{},"604":{}},"description":{"25":{},"26":{},"27":{},"45":{},"46":{},"58":{},"59":{},"93":{},"157":{},"199":{},"224":{},"225":{},"229":{},"244":{},"250":{},"254":{},"259":{},"261":{},"268":{},"276":{},"283":{},"284":{},"288":{},"310":{},"344":{},"366":{},"372":{},"472":{},"473":{},"474":{},"542":{},"577":{},"578":{},"604":{}}}],["address'",{"_index":701,"title":{"268":{}},"description":{"228":{}}}],["address(",{"_index":208,"title":{"46":{},"59":{}},"description":{"45":{},"46":{},"58":{},"59":{}}}],["address](https://go.cpanel.net/cpaneldocsdefaultaddress",{"_index":767,"title":{},"description":{"259":{}}}],["admin",{"_index":926,"title":{"319":{},"505":{}},"description":{}}],["administr",{"_index":906,"title":{"309":{},"315":{}},"description":{"309":{},"315":{},"317":{},"319":{},"465":{},"505":{}}}],["administrators](https://go.cpanel.net/guidetogitforsystemadministr",{"_index":1167,"title":{},"description":{"428":{}}}],["affect",{"_index":858,"title":{},"description":{"290":{}}}],["against",{"_index":806,"title":{},"description":{"270":{}}}],["alia",{"_index":507,"title":{"153":{},"161":{}},"description":{"153":{},"161":{},"209":{}}}],["alias",{"_index":658,"title":{"210":{}},"description":{"209":{},"210":{}}}],["allow",{"_index":476,"title":{"220":{},"363":{},"395":{},"396":{}},"description":{"136":{},"137":{},"204":{},"284":{},"293":{},"296":{},"395":{},"396":{},"431":{},"442":{},"444":{}}}],["allowlist",{"_index":1016,"title":{"364":{},"373":{}},"description":{"364":{},"373":{}}}],["alreadi",{"_index":335,"title":{},"description":{"90":{},"129":{},"256":{},"433":{},"434":{},"437":{},"438":{},"440":{},"442":{},"443":{},"444":{},"447":{},"448":{},"449":{},"451":{},"452":{},"453":{},"456":{},"457":{},"458":{},"459":{},"460":{},"514":{}}}],["alway",{"_index":736,"title":{},"description":{"245":{},"587":{},"588":{},"589":{},"591":{},"592":{}}}],["amount",{"_index":334,"title":{},"description":{"90":{}}}],["analog",{"_index":1576,"title":{"617":{},"618":{}},"description":{"617":{},"618":{}}}],["analyz",{"_index":1580,"title":{"620":{},"621":{}},"description":{"620":{},"621":{}}}],["anam",{"_index":509,"title":{},"description":{"153":{},"161":{}}}],["anayz",{"_index":1581,"title":{},"description":{"620":{},"621":{}}}],["anonym",{"_index":1076,"title":{"395":{},"396":{},"401":{},"403":{}},"description":{"395":{},"396":{},"401":{},"403":{}}}],["anoth",{"_index":70,"title":{},"description":{"8":{},"9":{},"204":{},"414":{},"485":{},"487":{},"488":{}}}],["ansi",{"_index":1386,"title":{},"description":{"523":{}}}],["answer",{"_index":1044,"title":{},"description":{"378":{},"379":{},"380":{}}}],["antiviru",{"_index":1253,"title":{"464":{}},"description":{"464":{}}}],["apach",{"_index":844,"title":{"338":{},"342":{},"343":{},"590":{}},"description":{"286":{},"338":{},"339":{},"340":{},"341":{},"342":{},"343":{},"345":{},"346":{},"347":{},"348":{},"590":{},"630":{},"660":{},"661":{},"670":{},"671":{}}}],["apache'",{"_index":1646,"title":{},"description":{"662":{},"672":{}}}],["api",{"_index":0,"title":{"0":{},"1":{},"2":{},"3":{},"4":{}},"description":{"0":{},"1":{},"2":{},"3":{},"4":{},"7":{},"10":{},"378":{},"379":{},"380":{},"381":{},"417":{},"442":{},"465":{},"466":{},"467":{},"468":{},"469":{},"470":{},"485":{},"486":{},"487":{},"488":{},"489":{},"495":{},"496":{},"497":{},"498":{},"499":{},"500":{},"501":{},"502":{},"503":{},"505":{},"506":{},"507":{},"508":{},"509":{},"510":{},"511":{},"512":{},"513":{},"514":{},"515":{},"523":{},"555":{},"556":{}}}],["app",{"_index":425,"title":{"121":{}},"description":{}}],["app'",{"_index":433,"title":{"123":{},"124":{}},"description":{}}],["appear",{"_index":443,"title":{},"description":{"126":{},"346":{},"347":{},"430":{},"431":{}}}],["append",{"_index":458,"title":{},"description":{"129":{},"269":{}}}],["appli",{"_index":473,"title":{"189":{}},"description":{"136":{},"189":{},"469":{},"648":{},"649":{},"650":{},"651":{},"653":{},"654":{},"655":{},"656":{},"657":{},"658":{}}}],["applic",{"_index":93,"title":{"11":{},"120":{},"122":{},"375":{},"627":{},"628":{},"629":{},"630":{},"631":{},"632":{},"633":{},"634":{}},"description":{"11":{},"38":{},"120":{},"122":{},"129":{},"155":{},"163":{},"220":{},"375":{},"464":{},"471":{},"484":{},"490":{},"494":{},"504":{},"546":{},"627":{},"628":{},"629":{},"630":{},"631":{},"632":{},"633":{},"634":{}}}],["application'",{"_index":428,"title":{},"description":{"121":{},"123":{},"124":{},"550":{}}}],["application](https://go.cpanel.net/cpaneldocsapplicationmanag",{"_index":1604,"title":{},"description":{"634":{}}}],["applications](https://go.cpanel.net/howtocreaterubyapp",{"_index":1602,"title":{},"description":{"633":{}}}],["approach",{"_index":240,"title":{},"description":{"66":{}}}],["archiv",{"_index":1649,"title":{"665":{},"666":{},"667":{},"668":{}},"description":{"665":{},"666":{},"667":{},"668":{}}}],["archive_log",{"_index":1653,"title":{},"description":{"668":{}}}],["around",{"_index":453,"title":{},"description":{"128":{}}}],["array",{"_index":290,"title":{},"description":{"77":{},"97":{},"470":{},"514":{}}}],["ascii",{"_index":519,"title":{},"description":{"155":{},"163":{}}}],["assign",{"_index":219,"title":{"50":{}},"description":{"269":{},"429":{},"648":{}}}],["associ",{"_index":570,"title":{},"description":{"175":{},"209":{},"448":{},"568":{},"569":{}}}],["attempt",{"_index":1034,"title":{},"description":{"378":{},"442":{},"446":{}}}],["attribut",{"_index":1364,"title":{},"description":{"514":{}}}],["auditlog",{"_index":228,"title":{"56":{}},"description":{"56":{}}}],["authent",{"_index":105,"title":{"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"20":{},"289":{},"542":{}},"description":{"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"122":{},"208":{},"289":{},"294":{},"296":{},"379":{},"665":{}}}],["author",{"_index":108,"title":{"144":{},"147":{},"148":{}},"description":{"14":{},"447":{},"575":{}}}],["authorit",{"_index":539,"title":{"158":{},"165":{}},"description":{"158":{},"165":{},"196":{}}}],["auto-delet",{"_index":960,"title":{"339":{}},"description":{"339":{}}}],["auto-gener",{"_index":1451,"title":{"557":{}},"description":{"557":{}}}],["autocomplet",{"_index":1105,"title":{"410":{}},"description":{}}],["autocr",{"_index":826,"title":{"283":{},"284":{},"288":{}},"description":{}}],["automat",{"_index":829,"title":{"507":{}},"description":{"283":{},"284":{},"288":{},"507":{},"566":{}}}],["autorespond",{"_index":692,"title":{"225":{},"231":{},"243":{},"253":{},"255":{}},"description":{"231":{},"243":{},"253":{},"255":{}}}],["autoresponders](https://go.cpanel.net/autorespond",{"_index":693,"title":{},"description":{"225":{}}}],["autossl",{"_index":1452,"title":{"558":{},"559":{},"560":{},"561":{},"562":{},"563":{},"564":{}},"description":{"558":{},"559":{},"560":{},"562":{},"563":{},"584":{}}}],["autossl](https://go.cpanel.net/whmdocsmanageautossl",{"_index":1465,"title":{},"description":{"564":{}}}],["autossl_check",{"_index":1458,"title":{},"description":{"561":{}}}],["autoupdate.core.has_filt",{"_index":1344,"title":{},"description":{"507":{}}}],["avail",{"_index":113,"title":{"29":{},"40":{},"132":{},"137":{},"153":{},"161":{},"376":{},"491":{},"513":{},"678":{}},"description":{"15":{},"29":{},"40":{},"64":{},"132":{},"137":{},"153":{},"161":{},"285":{},"376":{},"381":{},"465":{},"480":{},"491":{},"498":{},"510":{},"546":{},"569":{},"570":{},"678":{}}}],["back",{"_index":373,"title":{"106":{},"107":{},"108":{},"109":{}},"description":{"199":{},"444":{}}}],["backup",{"_index":372,"title":{"105":{},"110":{},"112":{},"113":{},"114":{},"494":{},"495":{},"496":{},"497":{},"498":{},"499":{},"500":{}},"description":{"105":{},"106":{},"107":{},"108":{},"109":{},"110":{},"111":{},"112":{},"113":{},"114":{},"115":{},"116":{},"117":{},"118":{},"119":{},"175":{},"442":{},"494":{},"495":{},"496":{},"497":{},"498":{},"499":{},"500":{},"501":{},"502":{},"503":{},"679":{}}}],["backup-mm.dd.yyyy_hh-mm-ss.tar.gz",{"_index":380,"title":{},"description":{"106":{},"107":{}}}],["backup-mm.dd.yyyy_hh-mm-ss_username.tar.gz",{"_index":385,"title":{},"description":{"108":{},"109":{}}}],["backup/fullbackup_to_ftp",{"_index":384,"title":{},"description":{"107":{}}}],["backup/fullbackup_to_homedir",{"_index":386,"title":{},"description":{"108":{}}}],["backup/fullbackup_to_scp_with_key",{"_index":389,"title":{},"description":{"109":{}}}],["backup/fullbackup_to_scp_with_password",{"_index":382,"title":{},"description":{"106":{}}}],["backup/list_backup",{"_index":390,"title":{},"description":{"110":{}}}],["backup/restore_databas",{"_index":409,"title":{},"description":{"116":{}}}],["backup/restore_email_filt",{"_index":423,"title":{},"description":{"118":{}}}],["backup/restore_email_forward",{"_index":421,"title":{},"description":{"117":{}}}],["backup/restore_fil",{"_index":424,"title":{},"description":{"119":{}}}],["balanc",{"_index":241,"title":{},"description":{"66":{}}}],["bandwidth",{"_index":1409,"title":{"532":{},"533":{},"534":{},"535":{},"616":{}},"description":{"532":{},"534":{},"535":{},"616":{}}}],["bandwidth/get_enabled_protocol",{"_index":1411,"title":{},"description":{"533":{}}}],["bandwidth/get_retention_period",{"_index":1416,"title":{},"description":{"535":{}}}],["bandwidth/queri",{"_index":1413,"title":{},"description":{"534":{}}}],["base",{"_index":101,"title":{},"description":{"12":{},"465":{}}}],["base64",{"_index":525,"title":{},"description":{"155":{},"163":{}}}],["basic",{"_index":1171,"title":{"653":{},"655":{}},"description":{"429":{},"653":{},"655":{}}}],["batch",{"_index":34,"title":{"5":{}},"description":{"5":{},"6":{},"196":{}}}],["batch/strict",{"_index":57,"title":{},"description":{"6":{}}}],["batch::strict",{"_index":44,"title":{},"description":{"6":{}}}],["be",{"_index":1285,"title":{},"description":{"470":{}}}],["befor",{"_index":534,"title":{},"description":{"156":{},"164":{},"381":{},"424":{},"426":{},"442":{},"507":{},"514":{},"633":{}}}],["begin",{"_index":1106,"title":{},"description":{"410":{}}}],["best",{"_index":1473,"title":{"569":{},"576":{}},"description":{}}],["best-avail",{"_index":1474,"title":{},"description":{"569":{}}}],["between",{"_index":242,"title":{},"description":{"66":{}}}],["binari",{"_index":521,"title":{},"description":{"155":{},"163":{}}}],["blackberri",{"_index":820,"title":{"282":{}},"description":{"282":{}}}],["blacklist",{"_index":989,"title":{},"description":{"351":{}}}],["blank",{"_index":655,"title":{},"description":{"208":{}}}],["block",{"_index":141,"title":{"25":{},"26":{},"27":{},"351":{}},"description":{"25":{},"26":{}}}],["blocker*](https://go.cpanel.net/whmdocsfeaturemanag",{"_index":770,"title":{},"description":{"261":{}}}],["blockip/add_ip",{"_index":149,"title":{},"description":{"26":{}}}],["blockip/remove_ip",{"_index":151,"title":{},"description":{"27":{}}}],["blocklist",{"_index":993,"title":{"353":{},"362":{}},"description":{"353":{},"362":{}}}],["bodi",{"_index":415,"title":{},"description":{"117":{},"118":{},"119":{},"270":{},"378":{},"379":{},"380":{}}}],["book",{"_index":1289,"title":{"472":{},"473":{},"474":{},"481":{}},"description":{"472":{},"473":{},"474":{}}}],["both",{"_index":1545,"title":{},"description":{"599":{}}}],["box",{"_index":683,"title":{"339":{},"340":{},"341":{},"344":{}},"description":{"223":{},"340":{},"341":{},"344":{}}}],["boxtrapp",{"_index":987,"title":{"349":{},"350":{},"351":{},"352":{},"353":{},"354":{},"355":{},"356":{},"358":{},"359":{},"360":{},"361":{},"362":{},"363":{},"364":{},"365":{},"366":{},"367":{},"368":{},"369":{},"370":{},"371":{},"372":{},"373":{},"374":{}},"description":{"349":{},"350":{},"352":{},"353":{},"354":{},"355":{},"356":{},"358":{},"359":{},"360":{},"361":{},"362":{},"363":{},"364":{},"365":{},"366":{},"367":{},"368":{},"369":{},"370":{},"371":{},"372":{},"373":{},"374":{}}}],["boxtrapper/blacklist_messag",{"_index":990,"title":{},"description":{"351":{}}}],["boxtrapper/delete_messag",{"_index":1022,"title":{},"description":{"369":{}}}],["boxtrapper/deliver_messag",{"_index":992,"title":{},"description":{"352":{}}}],["boxtrapper/get_allowlist",{"_index":1017,"title":{},"description":{"364":{}}}],["boxtrapper/get_blocklist",{"_index":995,"title":{},"description":{"353":{}}}],["boxtrapper/get_configur",{"_index":1018,"title":{},"description":{"365":{}}}],["boxtrapper/get_email_templ",{"_index":1003,"title":{},"description":{"356":{}}}],["boxtrapper/get_forward",{"_index":1019,"title":{},"description":{"366":{}}}],["boxtrapper/get_ignorelist",{"_index":998,"title":{},"description":{"354":{}}}],["boxtrapper/get_log",{"_index":1020,"title":{},"description":{"367":{}}}],["boxtrapper/get_messag",{"_index":1001,"title":{},"description":{"355":{}}}],["boxtrapper/get_statu",{"_index":1021,"title":{},"description":{"368":{}}}],["boxtrapper/ignore_messag",{"_index":1005,"title":{},"description":{"357":{}}}],["boxtrapper/list_email_templ",{"_index":1023,"title":{},"description":{"370":{}}}],["boxtrapper/list_queued_messag",{"_index":1010,"title":{},"description":{"361":{}}}],["boxtrapper/process_messag",{"_index":1028,"title":{},"description":{"374":{}}}],["boxtrapper/reset_email_templ",{"_index":1006,"title":{},"description":{"358":{}}}],["boxtrapper/save_configur",{"_index":1024,"title":{},"description":{"371":{}}}],["boxtrapper/save_email_templ",{"_index":1008,"title":{},"description":{"360":{}}}],["boxtrapper/set_allowlist",{"_index":1026,"title":{},"description":{"373":{}}}],["boxtrapper/set_blocklist",{"_index":1011,"title":{},"description":{"362":{}}}],["boxtrapper/set_forward",{"_index":1025,"title":{},"description":{"372":{}}}],["boxtrapper/set_ignorelist",{"_index":1007,"title":{},"description":{"359":{}}}],["boxtrapper/set_statu",{"_index":988,"title":{},"description":{"350":{}}}],["boxtrapper/whitelist_messag",{"_index":1015,"title":{},"description":{"363":{}}}],["boxtrapper::deliver_messag",{"_index":1014,"title":{},"description":{"363":{}}}],["branch",{"_index":1156,"title":{},"description":{"424":{},"426":{},"429":{}}}],["branch'",{"_index":1146,"title":{},"description":{"424":{}}}],["brand",{"_index":437,"title":{"125":{}},"description":{"125":{}}}],["branding/get_appl",{"_index":430,"title":{},"description":{"121":{}}}],["branding/get_application_inform",{"_index":436,"title":{},"description":{"124":{}}}],["branding/get_available_appl",{"_index":432,"title":{},"description":{"122":{}}}],["branding/get_information_for_appl",{"_index":435,"title":{},"description":{"123":{}}}],["browser",{"_index":445,"title":{"127":{},"128":{},"129":{}},"description":{"127":{},"129":{}}}],["browser'",{"_index":454,"title":{},"description":{"128":{}}}],["buffer",{"_index":1122,"title":{"414":{}},"description":{"414":{}}}],["build",{"_index":1370,"title":{},"description":{"514":{}}}],["built-in",{"_index":664,"title":{"210":{}},"description":{"210":{}}}],["bundl",{"_index":1477,"title":{"573":{},"575":{}},"description":{"569":{},"573":{},"575":{}}}],["bypass",{"_index":757,"title":{},"description":{"257":{},"258":{}}}],["byte",{"_index":267,"title":{"238":{}},"description":{"69":{},"70":{},"233":{},"239":{}}}],["ca",{"_index":1476,"title":{"573":{},"575":{}},"description":{"569":{},"573":{},"575":{}}}],["cach",{"_index":446,"title":{"127":{},"128":{},"129":{},"643":{},"644":{},"645":{},"646":{}},"description":{"127":{},"128":{},"129":{},"430":{},"643":{},"644":{},"645":{},"646":{}}}],["cachebust",{"_index":451,"title":{},"description":{"128":{},"129":{}}}],["cachebuster/read",{"_index":465,"title":{},"description":{"129":{}}}],["cachebuster/upd",{"_index":455,"title":{},"description":{"128":{}}}],["cachebuster::upd",{"_index":463,"title":{},"description":{"129":{}}}],["caldav",{"_index":1293,"title":{"475":{}},"description":{"475":{},"480":{}}}],["calendar",{"_index":1287,"title":{"471":{},"478":{},"479":{},"480":{},"481":{},"483":{},"484":{},"485":{},"486":{},"487":{},"488":{},"489":{}},"description":{"471":{},"478":{},"479":{},"482":{},"483":{},"484":{},"485":{},"486":{},"487":{},"488":{},"489":{},"558":{},"560":{},"561":{},"562":{},"563":{},"564":{},"567":{},"569":{},"570":{},"575":{},"579":{},"580":{},"581":{},"582":{},"587":{},"589":{},"590":{},"594":{},"595":{},"596":{},"597":{},"598":{},"599":{},"600":{},"601":{},"602":{},"603":{},"604":{},"605":{},"606":{},"607":{},"608":{},"609":{}}}],["calendarcontact",{"_index":1506,"title":{},"description":{"578":{}}}],["call",{"_index":41,"title":{},"description":{"6":{},"45":{},"46":{},"58":{},"59":{},"117":{},"118":{},"119":{},"129":{},"156":{},"164":{},"196":{},"222":{},"378":{},"379":{},"380":{},"381":{},"417":{},"430":{},"523":{},"555":{},"556":{},"570":{},"572":{},"573":{},"574":{},"584":{},"594":{},"595":{},"596":{},"597":{},"599":{},"602":{},"603":{},"605":{},"607":{},"608":{},"609":{},"678":{}}}],["can't",{"_index":21,"title":{},"description":{"1":{}}}],["cancel",{"_index":179,"title":{},"description":{"37":{},"298":{},"495":{},"515":{}}}],["candid",{"_index":292,"title":{},"description":{"78":{}}}],["carddav",{"_index":1294,"title":{"475":{}},"description":{"475":{},"480":{}}}],["cart",{"_index":159,"title":{"30":{}},"description":{"30":{}}}],["case",{"_index":527,"title":{},"description":{"155":{},"163":{},"442":{}}}],["catchal",{"_index":744,"title":{},"description":{"250":{}}}],["caus",{"_index":946,"title":{},"description":{"329":{}}}],["ccs/add_deleg",{"_index":1313,"title":{},"description":{"488":{}}}],["ccs/list_deleg",{"_index":1315,"title":{},"description":{"489":{}}}],["ccs/list_us",{"_index":1311,"title":{},"description":{"486":{}}}],["ccs/remove_deleg",{"_index":1310,"title":{},"description":{"485":{}}}],["ccs/update_deleg",{"_index":1312,"title":{},"description":{"487":{}}}],["certif",{"_index":164,"title":{"36":{},"38":{},"39":{},"40":{},"42":{},"43":{},"220":{},"557":{},"568":{},"569":{},"570":{},"571":{},"572":{},"574":{},"578":{},"579":{},"582":{},"593":{},"594":{},"595":{},"597":{},"598":{},"600":{},"602":{},"605":{},"607":{},"608":{}},"description":{"30":{},"36":{},"37":{},"38":{},"39":{},"40":{},"42":{},"43":{},"220":{},"557":{},"565":{},"567":{},"568":{},"569":{},"571":{},"572":{},"573":{},"574":{},"575":{},"577":{},"578":{},"579":{},"582":{},"584":{},"586":{},"587":{},"589":{},"591":{},"593":{},"594":{},"595":{},"596":{},"597":{},"598":{},"600":{},"602":{},"605":{},"607":{},"608":{},"610":{}}}],["certificate'",{"_index":1475,"title":{"575":{},"577":{},"601":{}},"description":{"569":{},"570":{},"575":{},"601":{}}}],["cgi-bin",{"_index":1183,"title":{},"description":{"431":{}}}],["cgi::phpmyadminlink",{"_index":1059,"title":{},"description":{"381":{}}}],["chang",{"_index":348,"title":{},"description":{"93":{},"169":{},"176":{},"228":{},"248":{},"316":{},"389":{},"390":{},"391":{},"420":{},"421":{},"422":{},"424":{},"428":{},"429":{},"502":{},"507":{},"509":{},"511":{},"530":{},"587":{},"588":{},"589":{},"591":{},"592":{},"601":{},"602":{},"603":{},"656":{}}}],["charact",{"_index":529,"title":{"285":{},"287":{}},"description":{"155":{},"163":{},"285":{},"287":{},"416":{},"430":{},"431":{}}}],["character-encod",{"_index":901,"title":{},"description":{"306":{}}}],["check",{"_index":174,"title":{"561":{}},"description":{"34":{},"41":{},"47":{},"60":{},"62":{},"158":{},"165":{},"191":{},"198":{},"282":{},"288":{},"289":{},"317":{},"331":{},"368":{},"385":{},"386":{},"395":{},"396":{},"402":{},"437":{},"470":{},"473":{},"476":{},"477":{},"496":{},"499":{},"512":{},"540":{},"545":{},"564":{},"568":{},"589":{},"590":{},"611":{},"612":{},"613":{},"640":{}}}],["checked-in",{"_index":1153,"title":{},"description":{"424":{},"426":{}}}],["checkout",{"_index":173,"title":{"34":{}},"description":{}}],["child",{"_index":244,"title":{},"description":{"66":{}}}],["chkservd/get_exim_port",{"_index":889,"title":{},"description":{"301":{}}}],["chkservd/get_exim_ports_ssl",{"_index":887,"title":{},"description":{"300":{}}}],["choic",{"_index":1585,"title":{},"description":{"621":{}}}],["chrome/get_dom",{"_index":444,"title":{},"description":{"126":{}}}],["clamav",{"_index":1254,"title":{"464":{}},"description":{"464":{},"466":{},"467":{},"468":{}}}],["clamav®](https://go.cpanel.net/configureclamavscann",{"_index":1258,"title":{},"description":{"465":{}}}],["clamscanner/check_disinfection_statu",{"_index":1286,"title":{},"description":{"470":{}}}],["clamscanner/disinfect_fil",{"_index":1279,"title":{},"description":{"469":{}}}],["clamscanner/get_scan_path",{"_index":1274,"title":{},"description":{"465":{}}}],["clamscanner/get_scan_statu",{"_index":1277,"title":{},"description":{"468":{}}}],["clamscanner/list_infected_fil",{"_index":1276,"title":{},"description":{"467":{}}}],["clamscanner/start_scan",{"_index":1275,"title":{},"description":{"466":{}}}],["clamscanner::check_disinfection_statu",{"_index":1282,"title":{},"description":{"470":{}}}],["clamscanner::check_disinfection_status`](https://go.cpanel.net/clamscanner-check-disinfection-statu",{"_index":1272,"title":{},"description":{"465":{},"466":{},"467":{},"468":{},"469":{},"470":{}}}],["clamscanner::disinfect_files`](https://go.cpanel.net/clamscanner-disinfect-fil",{"_index":1269,"title":{},"description":{"465":{},"466":{},"467":{},"468":{},"469":{},"470":{}}}],["clamscanner::get_scan_status`](https://go.cpanel.net/clamscanner-get-scan-statu",{"_index":1260,"title":{},"description":{"465":{},"466":{},"467":{},"468":{},"469":{},"470":{}}}],["clamscanner::list_infected_files`](https://go.cpanel.net/clamscanner-list-infected-fil",{"_index":1264,"title":{},"description":{"465":{},"466":{},"467":{},"468":{},"469":{},"470":{}}}],["clamscanner::start_scan`](https://go.cpanel.net/clamscanner-start-scan",{"_index":1259,"title":{},"description":{"465":{},"466":{},"467":{},"468":{},"469":{},"470":{}}}],["clean",{"_index":1157,"title":{},"description":{"424":{},"426":{},"503":{},"506":{}}}],["clear",{"_index":332,"title":{},"description":{"89":{},"344":{},"644":{}}}],["cli",{"_index":690,"title":{},"description":{"224":{}}}],["click",{"_index":1392,"title":{},"description":{"523":{}}}],["client",{"_index":406,"title":{"229":{},"232":{},"376":{}},"description":{"116":{},"229":{},"232":{},"376":{},"475":{}}}],["clone",{"_index":78,"title":{},"description":{"8":{},"9":{}}}],["code",{"_index":128,"title":{"20":{}},"description":{"20":{},"417":{},"442":{}}}],["code](https://go.cpanel.net/tutorial-call-uapis-ssl-install-ssl-function-in-custom-cod",{"_index":1535,"title":{},"description":{"594":{}}}],["collect",{"_index":1305,"title":{},"description":{"481":{}}}],["combin",{"_index":40,"title":{},"description":{"6":{}}}],["command",{"_index":56,"title":{},"description":{"6":{},"106":{},"109":{},"381":{},"431":{}}}],["commerc",{"_index":153,"title":{},"description":{"28":{},"36":{}}}],["commit",{"_index":1148,"title":{},"description":{"424":{}}}],["compat",{"_index":1520,"title":{},"description":{"587":{},"589":{},"591":{}}}],["complet",{"_index":1265,"title":{"506":{}},"description":{"465":{},"466":{},"467":{},"468":{},"469":{},"470":{},"506":{},"512":{},"514":{},"632":{}}}],["complex",{"_index":1532,"title":{},"description":{"594":{}}}],["compliant",{"_index":1388,"title":{},"description":{"523":{}}}],["condit",{"_index":790,"title":{},"description":{"269":{},"584":{}}}],["config",{"_index":132,"title":{"21":{},"22":{},"23":{},"24":{}},"description":{}}],["configur",{"_index":114,"title":{"53":{},"207":{},"209":{},"365":{},"371":{},"546":{},"592":{},"620":{},"621":{},"623":{},"645":{},"649":{}},"description":{"15":{},"20":{},"21":{},"22":{},"23":{},"53":{},"69":{},"70":{},"141":{},"167":{},"177":{},"250":{},"290":{},"346":{},"347":{},"353":{},"354":{},"359":{},"362":{},"364":{},"365":{},"371":{},"373":{},"424":{},"428":{},"433":{},"434":{},"436":{},"437":{},"438":{},"439":{},"440":{},"441":{},"442":{},"443":{},"444":{},"447":{},"448":{},"449":{},"451":{},"452":{},"453":{},"454":{},"455":{},"456":{},"457":{},"458":{},"459":{},"460":{},"465":{},"479":{},"507":{},"511":{},"546":{},"554":{},"556":{},"592":{},"620":{},"623":{},"624":{},"630":{},"645":{},"649":{},"659":{},"664":{},"669":{},"673":{},"675":{},"677":{}}}],["configuration](https://go.cpanel.net/whmdocsemailroutingconfigur",{"_index":590,"title":{},"description":{"186":{},"187":{},"188":{}}}],["configurations.json",{"_index":1671,"title":{},"description":{"679":{},"680":{}}}],["confirm",{"_index":491,"title":{},"description":{"143":{},"194":{}}}],["conflict",{"_index":287,"title":{"77":{}},"description":{"77":{}}}],["connect",{"_index":355,"title":{"259":{},"395":{},"475":{}},"description":{"97":{},"259":{},"294":{},"296":{},"378":{},"379":{},"380":{},"395":{},"475":{},"587":{},"589":{},"591":{}}}],["consist",{"_index":283,"title":{},"description":{"76":{}}}],["contact",{"_index":205,"title":{"44":{},"45":{},"46":{},"47":{},"57":{},"58":{},"59":{},"60":{},"93":{},"471":{},"484":{}},"description":{"44":{},"45":{},"46":{},"47":{},"57":{},"58":{},"59":{},"60":{},"471":{},"484":{},"485":{},"486":{},"487":{},"488":{},"489":{},"558":{},"560":{},"561":{},"562":{},"563":{},"564":{},"567":{},"569":{},"570":{},"575":{},"579":{},"580":{},"581":{},"582":{},"587":{},"589":{},"590":{},"594":{},"595":{},"596":{},"597":{},"598":{},"599":{},"600":{},"601":{},"602":{},"603":{},"604":{},"605":{},"606":{},"607":{},"608":{},"609":{}}}],["contactinformation/set_email_address",{"_index":212,"title":{},"description":{"46":{},"59":{}}}],["contactinformation/unset_email_address",{"_index":210,"title":{},"description":{"45":{},"58":{}}}],["contacts_",{"_index":1498,"title":{},"description":{"577":{},"592":{}}}],["contactus/is_en",{"_index":215,"title":{},"description":{"47":{},"60":{}}}],["contain",{"_index":517,"title":{},"description":{"155":{},"163":{},"207":{},"209":{},"210":{},"267":{},"270":{},"430":{},"514":{},"679":{}}}],["content",{"_index":972,"title":{"344":{},"360":{},"367":{},"411":{},"412":{},"415":{},"644":{},"651":{},"656":{}},"description":{"344":{},"360":{},"367":{},"411":{},"412":{},"430":{},"651":{},"656":{},"679":{}}}],["control",{"_index":77,"title":{},"description":{"8":{},"9":{},"41":{},"428":{},"429":{},"430":{},"431":{},"611":{},"612":{},"613":{},"621":{},"658":{}}}],["control*](https://go.cpanel.net/gitversioncontrol",{"_index":74,"title":{},"description":{"8":{},"9":{}}}],["control](https://go.cpanel.net/gitversioncontrol",{"_index":1162,"title":{},"description":{"428":{},"429":{},"430":{},"431":{}}}],["convert",{"_index":1093,"title":{},"description":{"405":{},"414":{},"507":{},"514":{}}}],["copi",{"_index":378,"title":{},"description":{"106":{},"109":{}}}],["correct",{"_index":651,"title":{},"description":{"208":{},"378":{}}}],["count",{"_index":722,"title":{"237":{}},"description":{"237":{}}}],["coverag",{"_index":1468,"title":{},"description":{"567":{},"597":{}}}],["cpaddon",{"_index":1316,"title":{"490":{},"491":{},"492":{},"493":{},"513":{}},"description":{"490":{},"491":{},"492":{},"493":{},"505":{},"507":{},"513":{}}}],["cpaddons/get_available_addon",{"_index":1317,"title":{},"description":{"491":{}}}],["cpaddons/get_instance_set",{"_index":1319,"title":{},"description":{"492":{}}}],["cpaddons/list_addon_inst",{"_index":1321,"title":{},"description":{"493":{}}}],["cpanel",{"_index":7,"title":{"1":{},"2":{},"3":{},"4":{},"22":{},"26":{},"27":{},"49":{},"52":{},"53":{},"55":{},"61":{},"62":{},"63":{},"64":{},"73":{},"84":{},"106":{},"107":{},"108":{},"109":{},"113":{},"122":{},"126":{},"131":{},"208":{},"225":{},"226":{},"245":{},"259":{},"261":{},"276":{},"283":{},"284":{},"288":{},"303":{},"306":{},"310":{},"311":{},"314":{},"318":{},"338":{},"340":{},"341":{},"342":{},"486":{},"489":{},"490":{},"534":{},"544":{},"554":{},"555":{},"556":{},"565":{},"666":{},"667":{},"668":{}},"description":{"1":{},"2":{},"3":{},"4":{},"8":{},"9":{},"12":{},"18":{},"22":{},"26":{},"27":{},"29":{},"30":{},"31":{},"32":{},"33":{},"35":{},"39":{},"40":{},"42":{},"43":{},"44":{},"47":{},"49":{},"50":{},"51":{},"52":{},"54":{},"55":{},"57":{},"60":{},"61":{},"62":{},"63":{},"64":{},"65":{},"66":{},"67":{},"69":{},"70":{},"71":{},"72":{},"73":{},"74":{},"84":{},"97":{},"111":{},"120":{},"122":{},"125":{},"126":{},"127":{},"130":{},"134":{},"136":{},"139":{},"141":{},"144":{},"146":{},"147":{},"148":{},"207":{},"208":{},"209":{},"210":{},"223":{},"225":{},"226":{},"238":{},"246":{},"247":{},"259":{},"261":{},"266":{},"270":{},"276":{},"283":{},"284":{},"286":{},"288":{},"290":{},"306":{},"307":{},"310":{},"311":{},"314":{},"331":{},"332":{},"333":{},"334":{},"335":{},"336":{},"338":{},"340":{},"341":{},"378":{},"379":{},"380":{},"381":{},"387":{},"428":{},"429":{},"430":{},"431":{},"442":{},"444":{},"465":{},"472":{},"473":{},"474":{},"485":{},"486":{},"487":{},"488":{},"489":{},"490":{},"495":{},"496":{},"497":{},"498":{},"499":{},"500":{},"501":{},"502":{},"503":{},"505":{},"506":{},"507":{},"508":{},"509":{},"510":{},"511":{},"512":{},"513":{},"514":{},"515":{},"534":{},"537":{},"538":{},"539":{},"540":{},"544":{},"545":{},"546":{},"554":{},"555":{},"556":{},"565":{},"566":{},"573":{},"584":{},"587":{},"589":{},"591":{},"608":{},"609":{},"616":{},"617":{},"620":{},"621":{},"636":{},"638":{},"641":{},"674":{},"676":{},"678":{},"680":{}}}],["cpanel'",{"_index":293,"title":{},"description":{"78":{},"514":{},"653":{},"655":{},"678":{}}}],["cpanel-control",{"_index":1178,"title":{},"description":{"430":{},"431":{}}}],["cpanel-manag",{"_index":1139,"title":{},"description":{"424":{}}}],["cpanel-provid",{"_index":1668,"title":{},"description":{"678":{},"679":{}}}],["cpanel.yml",{"_index":1154,"title":{},"description":{"424":{},"426":{}}}],["cpanel/logs/vc_timestamp_git_create.log",{"_index":1168,"title":{},"description":{"428":{}}}],["cpanel/logs/vc_timestamp_git_deploy.log",{"_index":1140,"title":{},"description":{"424":{},"426":{}}}],["cpdavd/add_deleg",{"_index":1301,"title":{},"description":{"478":{}}}],["cpdavd/list_deleg",{"_index":1302,"title":{},"description":{"479":{}}}],["cpdavd/list_us",{"_index":1303,"title":{},"description":{"480":{}}}],["cpdavd/manage_collect",{"_index":1306,"title":{},"description":{"481":{}}}],["cpdavd/remove_deleg",{"_index":1307,"title":{},"description":{"482":{}}}],["cpdavd/update_deleg",{"_index":1308,"title":{},"description":{"483":{}}}],["cpgreylist/disable_all_domain",{"_index":953,"title":{},"description":{"333":{}}}],["cpgreylist/disable_domain",{"_index":954,"title":{},"description":{"334":{}}}],["cpgreylist/enable_all_domain",{"_index":952,"title":{},"description":{"332":{}}}],["cpgreylist/enable_domain",{"_index":957,"title":{},"description":{"336":{}}}],["cpgreylist/has_greylisting_en",{"_index":951,"title":{},"description":{"331":{}}}],["cpgreylist/list_domain",{"_index":956,"title":{},"description":{"335":{}}}],["creat",{"_index":6,"title":{"1":{},"20":{},"30":{},"75":{},"128":{},"176":{},"180":{},"186":{},"217":{},"224":{},"250":{},"255":{},"269":{},"273":{},"274":{},"313":{},"321":{},"329":{},"378":{},"379":{},"380":{},"381":{},"383":{},"405":{},"406":{},"424":{},"428":{},"438":{},"444":{},"451":{},"517":{},"524":{},"537":{},"598":{},"599":{},"600":{}},"description":{"1":{},"30":{},"75":{},"78":{},"83":{},"96":{},"106":{},"107":{},"108":{},"109":{},"126":{},"180":{},"186":{},"187":{},"194":{},"217":{},"224":{},"255":{},"257":{},"258":{},"269":{},"273":{},"274":{},"283":{},"284":{},"288":{},"321":{},"378":{},"379":{},"380":{},"381":{},"383":{},"406":{},"428":{},"431":{},"438":{},"442":{},"444":{},"451":{},"481":{},"517":{},"523":{},"524":{},"528":{},"633":{},"660":{},"679":{}}}],["create_user_sess",{"_index":1053,"title":{},"description":{"381":{}}}],["credenti",{"_index":872,"title":{"378":{}},"description":{"294":{},"296":{}}}],["csr",{"_index":1490,"title":{},"description":{"574":{},"582":{},"595":{},"596":{},"600":{},"602":{},"607":{}}}],["csv",{"_index":754,"title":{"256":{}},"description":{"256":{},"311":{}}}],["csvimport/doimport",{"_index":755,"title":{},"description":{"256":{}}}],["current",{"_index":123,"title":{"122":{},"133":{},"135":{},"136":{},"222":{},"327":{},"328":{},"379":{},"564":{},"621":{}},"description":{"18":{},"39":{},"94":{},"100":{},"102":{},"129":{},"133":{},"191":{},"306":{},"472":{},"473":{},"474":{},"561":{},"567":{}}}],["currently-authent",{"_index":940,"title":{},"description":{"327":{},"328":{}}}],["custom",{"_index":259,"title":{"72":{},"626":{}},"description":{"69":{},"70":{},"72":{},"346":{},"347":{},"417":{},"594":{},"672":{}}}],["daemon",{"_index":1081,"title":{},"description":{"397":{}}}],["daemon)](https://go.cpanel.net/thecpanelwhmservicedaemon",{"_index":1428,"title":{},"description":{"545":{}}}],["danger",{"_index":1211,"title":{},"description":{"442":{}}}],["data",{"_index":186,"title":{"69":{},"70":{},"533":{}},"description":{"38":{},"69":{},"70":{},"207":{},"209":{},"210":{},"222":{},"430":{},"442":{},"509":{},"511":{},"514":{},"534":{},"535":{},"679":{}}}],["databas",{"_index":403,"title":{"116":{},"291":{},"432":{},"435":{},"437":{},"438":{},"439":{},"440":{},"441":{},"442":{},"443":{},"445":{},"516":{},"517":{},"519":{},"520":{},"521":{},"526":{},"583":{}},"description":{"291":{},"432":{},"435":{},"436":{},"437":{},"438":{},"440":{},"441":{},"442":{},"443":{},"444":{},"445":{},"447":{},"449":{},"451":{},"453":{},"454":{},"455":{},"456":{},"457":{},"458":{},"459":{},"460":{},"516":{},"517":{},"518":{},"519":{},"520":{},"521":{},"523":{},"524":{},"526":{},"527":{},"528":{},"529":{},"530":{},"531":{},"583":{}}}],["database'",{"_index":404,"title":{},"description":{"116":{},"442":{},"453":{}}}],["databases_",{"_index":1396,"title":{},"description":{"523":{}}}],["database’",{"_index":1203,"title":{},"description":{"439":{}}}],["date",{"_index":336,"title":{},"description":{"90":{}}}],["dav",{"_index":1288,"title":{"471":{},"476":{}},"description":{"471":{},"476":{}}}],["dav/disable_shared_global_addressbook",{"_index":1292,"title":{},"description":{"474":{}}}],["dav/enable_shared_global_addressbook",{"_index":1290,"title":{},"description":{"472":{}}}],["dav/get_calendar_contacts_config",{"_index":1295,"title":{},"description":{"475":{}}}],["dav/has_shared_global_addressbook",{"_index":1291,"title":{},"description":{"473":{}}}],["dav/is_dav_service_en",{"_index":1296,"title":{},"description":{"476":{}}}],["dav/is_horde_en",{"_index":1300,"title":{},"description":{"477":{}}}],["db",{"_index":1225,"title":{},"description":{"444":{}}}],["dcv",{"_index":194,"title":{"41":{}},"description":{"41":{},"611":{},"612":{},"613":{}}}],["dcv/check_domains_via_dn",{"_index":1563,"title":{},"description":{"611":{}}}],["dcv/check_domains_via_http",{"_index":1564,"title":{},"description":{"612":{}}}],["dcv/ensure_domains_can_pass_dcv",{"_index":1566,"title":{},"description":{"613":{}}}],["dcv::check_domains_via_http",{"_index":1565,"title":{},"description":{"613":{}}}],["ddn",{"_index":579,"title":{},"description":{"180":{},"181":{},"182":{},"183":{},"184":{}}}],["deactiv",{"_index":565,"title":{},"description":{"174":{}}}],["decid",{"_index":1267,"title":{},"description":{"465":{},"466":{},"467":{},"468":{},"469":{},"470":{}}}],["decod",{"_index":523,"title":{},"description":{"155":{},"163":{},"412":{}}}],["dedic",{"_index":1494,"title":{"577":{},"604":{}},"description":{"577":{},"578":{},"604":{}}}],["default",{"_index":357,"title":{"233":{},"235":{},"244":{},"250":{},"358":{},"652":{}},"description":{"97":{},"233":{},"235":{},"244":{},"250":{},"259":{},"358":{},"652":{}}}],["deleg",{"_index":561,"title":{"485":{},"487":{},"488":{},"489":{}},"description":{"172":{},"485":{},"487":{},"488":{}}}],["delegates](https://docs.cpanel.net/cpanel/email/calendar-deleg",{"_index":1314,"title":{},"description":{"489":{}}}],["delet",{"_index":62,"title":{"37":{},"76":{},"147":{},"182":{},"188":{},"227":{},"253":{},"254":{},"271":{},"275":{},"277":{},"304":{},"305":{},"312":{},"323":{},"344":{},"369":{},"384":{},"411":{},"419":{},"425":{},"430":{},"440":{},"452":{},"497":{},"503":{},"519":{},"525":{},"538":{},"595":{},"596":{},"597":{},"644":{},"665":{}},"description":{"8":{},"76":{},"147":{},"169":{},"176":{},"182":{},"188":{},"227":{},"253":{},"254":{},"271":{},"275":{},"277":{},"304":{},"305":{},"312":{},"323":{},"344":{},"353":{},"354":{},"359":{},"362":{},"369":{},"384":{},"419":{},"425":{},"430":{},"440":{},"442":{},"452":{},"481":{},"519":{},"525":{},"567":{},"595":{},"596":{},"597":{},"634":{},"661":{},"665":{}}}],["deliv",{"_index":991,"title":{},"description":{"352":{},"364":{},"373":{}}}],["deliveri",{"_index":746,"title":{"251":{}},"description":{"251":{}}}],["depend",{"_index":1332,"title":{"632":{}},"description":{"502":{},"632":{},"678":{},"679":{}}}],["deploy",{"_index":1138,"title":{"423":{},"424":{},"425":{},"426":{},"492":{},"493":{}},"description":{"423":{},"424":{},"425":{},"426":{},"493":{}}}],["deployment](https://go.cpanel.net/gitdeploy",{"_index":1152,"title":{},"description":{"424":{},"425":{},"426":{}}}],["deprec",{"_index":470,"title":{},"description":{"135":{},"613":{}}}],["describ",{"_index":1214,"title":{},"description":{"442":{}}}],["descript",{"_index":321,"title":{"86":{},"184":{}},"description":{"184":{}}}],["dest1",{"_index":792,"title":{},"description":{"269":{}}}],["dest2",{"_index":799,"title":{},"description":{"269":{}}}],["destin",{"_index":537,"title":{},"description":{"157":{}}}],["detail",{"_index":233,"title":{"122":{}},"description":{"64":{},"674":{}}}],["determin",{"_index":118,"title":{},"description":{"16":{},"199":{},"306":{},"462":{},"465":{},"507":{},"566":{}}}],["develop",{"_index":3,"title":{},"description":{"0":{},"7":{},"10":{},"594":{}}}],["devic",{"_index":1427,"title":{"545":{}},"description":{"545":{}}}],["differ",{"_index":662,"title":{},"description":{"209":{}}}],["dimens",{"_index":1101,"title":{"407":{}},"description":{"407":{}}}],["direct",{"_index":632,"title":{"202":{},"653":{},"655":{}},"description":{"202":{},"653":{},"655":{}}}],["directori",{"_index":102,"title":{"108":{},"112":{},"115":{},"138":{},"139":{},"140":{},"141":{},"142":{},"143":{},"144":{},"146":{},"147":{},"148":{},"149":{},"150":{},"390":{},"410":{},"413":{},"415":{},"421":{},"422":{}},"description":{"12":{},"108":{},"112":{},"114":{},"115":{},"138":{},"139":{},"140":{},"141":{},"142":{},"143":{},"144":{},"145":{},"146":{},"147":{},"148":{},"149":{},"150":{},"223":{},"311":{},"329":{},"390":{},"406":{},"410":{},"411":{},"413":{},"415":{},"416":{},"421":{},"424":{},"426":{},"430":{},"431":{},"466":{},"468":{},"600":{},"654":{},"665":{},"679":{}}}],["directory'",{"_index":400,"title":{"223":{}},"description":{"115":{},"223":{},"422":{},"678":{},"679":{}}}],["directoryindexes/get_index",{"_index":485,"title":{},"description":{"139":{}}}],["directoryindexes/list_directori",{"_index":487,"title":{},"description":{"140":{}}}],["directoryindexes/set_index",{"_index":488,"title":{},"description":{"141":{}}}],["directoryprivacy/add_us",{"_index":498,"title":{},"description":{"148":{}}}],["directoryprivacy/configure_directory_protect",{"_index":496,"title":{},"description":{"146":{}}}],["directoryprivacy/delete_us",{"_index":497,"title":{},"description":{"147":{}}}],["directoryprivacy/is_directory_protect",{"_index":492,"title":{},"description":{"143":{}}}],["directoryprivacy/list_directori",{"_index":495,"title":{},"description":{"145":{}}}],["directoryprivacy/list_us",{"_index":494,"title":{},"description":{"144":{}}}],["directoryprotection/list_directori",{"_index":501,"title":{},"description":{"150":{}}}],["disabl",{"_index":18,"title":{"146":{},"174":{},"175":{},"203":{},"262":{},"283":{},"307":{},"333":{},"334":{},"338":{},"339":{},"340":{},"350":{},"401":{},"403":{},"449":{},"474":{},"558":{},"559":{},"563":{},"584":{},"588":{},"629":{},"636":{},"637":{},"646":{}},"description":{"1":{},"26":{},"27":{},"112":{},"113":{},"114":{},"115":{},"116":{},"117":{},"118":{},"119":{},"146":{},"167":{},"168":{},"169":{},"170":{},"171":{},"172":{},"173":{},"174":{},"175":{},"176":{},"177":{},"178":{},"180":{},"181":{},"182":{},"183":{},"184":{},"186":{},"187":{},"188":{},"192":{},"203":{},"204":{},"205":{},"212":{},"213":{},"215":{},"217":{},"222":{},"223":{},"224":{},"225":{},"226":{},"227":{},"229":{},"231":{},"232":{},"233":{},"234":{},"235":{},"236":{},"237":{},"238":{},"239":{},"240":{},"241":{},"242":{},"243":{},"244":{},"245":{},"246":{},"247":{},"248":{},"250":{},"252":{},"253":{},"254":{},"255":{},"261":{},"262":{},"263":{},"264":{},"265":{},"266":{},"267":{},"268":{},"269":{},"270":{},"271":{},"273":{},"274":{},"275":{},"276":{},"277":{},"278":{},"279":{},"280":{},"282":{},"283":{},"284":{},"285":{},"286":{},"287":{},"288":{},"289":{},"290":{},"291":{},"293":{},"294":{},"295":{},"296":{},"297":{},"307":{},"309":{},"310":{},"312":{},"313":{},"314":{},"315":{},"316":{},"317":{},"320":{},"321":{},"333":{},"334":{},"338":{},"339":{},"340":{},"341":{},"342":{},"343":{},"348":{},"350":{},"351":{},"352":{},"353":{},"354":{},"355":{},"356":{},"357":{},"358":{},"359":{},"360":{},"361":{},"362":{},"363":{},"364":{},"365":{},"366":{},"367":{},"368":{},"369":{},"370":{},"371":{},"372":{},"373":{},"374":{},"376":{},"383":{},"384":{},"386":{},"387":{},"388":{},"389":{},"390":{},"391":{},"392":{},"393":{},"395":{},"396":{},"398":{},"399":{},"400":{},"401":{},"402":{},"403":{},"405":{},"406":{},"407":{},"408":{},"410":{},"411":{},"412":{},"413":{},"414":{},"415":{},"416":{},"417":{},"419":{},"420":{},"421":{},"422":{},"424":{},"426":{},"433":{},"434":{},"436":{},"437":{},"438":{},"439":{},"440":{},"441":{},"442":{},"443":{},"444":{},"446":{},"447":{},"448":{},"449":{},"451":{},"452":{},"453":{},"454":{},"455":{},"456":{},"457":{},"458":{},"459":{},"460":{},"474":{},"517":{},"518":{},"519":{},"520":{},"521":{},"523":{},"524":{},"525":{},"526":{},"527":{},"528":{},"529":{},"530":{},"531":{},"558":{},"559":{},"560":{},"561":{},"562":{},"563":{},"564":{},"567":{},"569":{},"570":{},"575":{},"577":{},"578":{},"579":{},"580":{},"581":{},"582":{},"584":{},"587":{},"588":{},"589":{},"590":{},"591":{},"592":{},"594":{},"595":{},"596":{},"597":{},"598":{},"599":{},"600":{},"601":{},"602":{},"603":{},"604":{},"605":{},"606":{},"607":{},"608":{},"609":{},"620":{},"621":{},"628":{},"629":{},"630":{},"631":{},"632":{},"633":{},"634":{},"636":{},"637":{},"638":{},"639":{},"640":{},"641":{},"646":{},"648":{},"649":{},"650":{},"651":{},"652":{},"653":{},"654":{},"655":{},"656":{},"657":{},"658":{},"660":{},"661":{},"662":{},"663":{},"670":{},"671":{},"672":{},"678":{},"679":{},"680":{}}}],["disable_mail_sni",{"_index":1529,"title":{},"description":{"592":{}}}],["discov",{"_index":1360,"title":{},"description":{"514":{}}}],["disinfect",{"_index":1270,"title":{"469":{},"470":{}},"description":{"465":{},"466":{},"467":{},"468":{},"469":{},"470":{}}}],["disk",{"_index":235,"title":{"65":{},"66":{},"67":{},"234":{},"236":{},"238":{},"247":{},"314":{},"388":{},"419":{},"420":{},"421":{},"422":{}},"description":{"65":{},"69":{},"70":{},"83":{},"234":{},"236":{},"238":{},"247":{},"314":{},"388":{},"419":{},"420":{},"421":{},"422":{},"558":{},"560":{},"561":{},"562":{},"563":{},"564":{},"567":{},"569":{},"570":{},"575":{},"579":{},"580":{},"581":{},"582":{},"587":{},"589":{},"590":{},"594":{},"595":{},"596":{},"597":{},"598":{},"599":{},"600":{},"601":{},"602":{},"603":{},"604":{},"605":{},"606":{},"607":{},"608":{},"609":{}}}],["disk_",{"_index":1500,"title":{},"description":{"577":{},"592":{}}}],["display",{"_index":112,"title":{},"description":{"15":{},"222":{},"424":{},"426":{},"470":{},"617":{},"672":{}}}],["distribut",{"_index":238,"title":{},"description":{"66":{},"534":{},"616":{}}}],["dkim",{"_index":600,"title":{"193":{},"194":{},"195":{},"196":{},"198":{},"200":{}},"description":{"193":{},"194":{},"195":{},"196":{},"198":{},"200":{}}}],["dmarc",{"_index":594,"title":{"189":{},"190":{},"191":{}},"description":{"189":{},"190":{},"191":{}}}],["dn",{"_index":502,"title":{"151":{},"153":{},"154":{},"155":{},"156":{},"158":{},"159":{},"161":{},"162":{},"163":{},"164":{},"165":{},"166":{},"179":{},"180":{},"181":{},"182":{},"183":{},"184":{},"185":{},"611":{}},"description":{"151":{},"154":{},"155":{},"156":{},"157":{},"158":{},"159":{},"162":{},"163":{},"164":{},"165":{},"166":{},"167":{},"169":{},"170":{},"172":{},"173":{},"174":{},"175":{},"176":{},"177":{},"178":{},"179":{},"180":{},"181":{},"182":{},"183":{},"184":{},"185":{},"188":{},"192":{},"193":{},"196":{},"197":{},"200":{},"257":{},"258":{},"290":{},"611":{}}}],["dns/ensure_domains_reside_only_loc",{"_index":506,"title":{},"description":{"152":{},"160":{}}}],["dns/has_local_author",{"_index":540,"title":{},"description":{"158":{},"165":{}}}],["dns/is_alias_avail",{"_index":513,"title":{},"description":{"153":{},"161":{}}}],["dns/lookup",{"_index":516,"title":{},"description":{"154":{},"162":{}}}],["dns/mass_edit_zon",{"_index":535,"title":{},"description":{"156":{},"164":{}}}],["dns/parse_zon",{"_index":531,"title":{},"description":{"155":{},"163":{}}}],["dns/swap_ip_in_zon",{"_index":538,"title":{},"description":{"157":{}}}],["dns](https://go.cpanel.net/serverrol",{"_index":550,"title":{},"description":{"168":{}}}],["dnskey",{"_index":557,"title":{"171":{}},"description":{"171":{}}}],["dnssec",{"_index":549,"title":{"168":{},"169":{},"170":{},"173":{},"174":{},"175":{},"176":{},"178":{}},"description":{"168":{},"169":{},"170":{},"173":{},"174":{},"175":{},"176":{},"178":{}}}],["dnssec/activate_zone_key",{"_index":578,"title":{},"description":{"178":{}}}],["dnssec/add_zone_key",{"_index":574,"title":{},"description":{"176":{}}}],["dnssec/deactivate_zone_key",{"_index":566,"title":{},"description":{"174":{}}}],["dnssec/disable_dnssec",{"_index":573,"title":{},"description":{"175":{}}}],["dnssec/enable_dnssec",{"_index":555,"title":{},"description":{"169":{}}}],["dnssec/export_zone_dnskey",{"_index":559,"title":{},"description":{"171":{}}}],["dnssec/export_zone_key",{"_index":551,"title":{},"description":{"168":{}}}],["dnssec/fetch_ds_record",{"_index":563,"title":{},"description":{"172":{}}}],["dnssec/import_zone_key",{"_index":556,"title":{},"description":{"170":{}}}],["dnssec/remove_zone_key",{"_index":564,"title":{},"description":{"173":{}}}],["dnssec/set_nsec3",{"_index":576,"title":{},"description":{"177":{}}}],["dnssec/unset_nsec3",{"_index":547,"title":{},"description":{"167":{}}}],["document",{"_index":86,"title":{},"description":{"8":{},"9":{},"117":{},"119":{},"136":{},"137":{},"186":{},"187":{},"188":{},"207":{},"209":{},"210":{},"261":{},"274":{},"286":{},"340":{},"341":{},"347":{},"348":{},"392":{},"415":{},"424":{},"425":{},"426":{},"428":{},"429":{},"430":{},"431":{},"506":{},"512":{},"514":{},"594":{},"621":{},"633":{},"648":{},"649":{},"650":{},"651":{},"653":{},"654":{},"655":{},"656":{},"657":{},"658":{},"679":{},"680":{}}}],["documentation](http://www.exim.org/exim-html-3.30/doc/html/filter.html",{"_index":779,"title":{},"description":{"265":{},"268":{},"269":{},"270":{}}}],["documentation](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profil",{"_index":1582,"title":{},"description":{"620":{}}}],["documentation](https://go.cpanel.net/dns-alias-record",{"_index":512,"title":{},"description":{"153":{},"161":{}}}],["documentation](https://spamassassin.apache.org/full/3.1.x/doc/mail_spamassassin_conf.html#user_prefer",{"_index":978,"title":{},"description":{"346":{}}}],["domain",{"_index":144,"title":{"152":{},"160":{},"167":{},"177":{},"180":{},"181":{},"182":{},"183":{},"184":{},"189":{},"191":{},"193":{},"194":{},"195":{},"196":{},"197":{},"198":{},"199":{},"200":{},"201":{},"205":{},"206":{},"207":{},"208":{},"211":{},"212":{},"213":{},"214":{},"219":{},"220":{},"245":{},"266":{},"270":{},"280":{},"332":{},"333":{},"334":{},"335":{},"336":{},"558":{},"559":{},"560":{},"562":{},"563":{},"566":{},"567":{},"576":{},"578":{},"587":{},"588":{},"610":{},"611":{},"612":{},"613":{},"614":{},"615":{},"616":{},"617":{},"618":{},"636":{},"637":{},"638":{},"639":{},"641":{},"649":{}},"description":{"26":{},"27":{},"41":{},"76":{},"83":{},"152":{},"154":{},"160":{},"162":{},"167":{},"169":{},"175":{},"176":{},"177":{},"180":{},"181":{},"182":{},"183":{},"184":{},"190":{},"191":{},"193":{},"194":{},"197":{},"198":{},"199":{},"200":{},"201":{},"202":{},"205":{},"206":{},"207":{},"208":{},"209":{},"210":{},"211":{},"212":{},"213":{},"214":{},"218":{},"219":{},"220":{},"245":{},"257":{},"258":{},"266":{},"270":{},"280":{},"332":{},"333":{},"334":{},"335":{},"336":{},"558":{},"559":{},"560":{},"562":{},"563":{},"566":{},"567":{},"569":{},"571":{},"576":{},"578":{},"581":{},"584":{},"587":{},"588":{},"597":{},"610":{},"611":{},"612":{},"613":{},"614":{},"616":{},"617":{},"620":{},"621":{},"636":{},"637":{},"638":{},"639":{},"641":{},"649":{},"663":{},"672":{},"674":{},"676":{}}}],["domain'",{"_index":514,"title":{"154":{},"162":{},"172":{},"209":{},"243":{},"244":{},"279":{},"591":{}},"description":{"157":{},"158":{},"165":{},"171":{},"172":{},"195":{},"196":{},"199":{},"243":{},"244":{},"257":{},"258":{},"279":{},"577":{},"591":{},"615":{},"618":{},"680":{}}}],["domain(",{"_index":595,"title":{"190":{}},"description":{"189":{}}}],["domain-level",{"_index":781,"title":{"266":{},"273":{},"275":{},"278":{},"280":{}},"description":{"266":{},"273":{},"275":{},"278":{},"280":{}}}],["domaininfo/domains_data",{"_index":647,"title":{},"description":{"207":{}}}],["domaininfo/list_domain",{"_index":657,"title":{},"description":{"208":{}}}],["domaininfo/main_domain_builtin_subdomain_alias",{"_index":666,"title":{},"description":{"210":{}}}],["domaininfo/single_domain_data",{"_index":663,"title":{},"description":{"209":{}}}],["domainkey",{"_index":601,"title":{},"description":{"193":{},"194":{},"196":{},"198":{},"200":{}}}],["done",{"_index":1273,"title":{},"description":{"465":{},"466":{},"467":{},"468":{},"469":{},"470":{},"514":{}}}],["dovecot",{"_index":855,"title":{},"description":{"289":{}}}],["ds",{"_index":560,"title":{"172":{}},"description":{"172":{},"176":{}}}],["due",{"_index":46,"title":{},"description":{"6":{},"209":{},"573":{},"594":{},"608":{},"609":{}}}],["dure",{"_index":1348,"title":{},"description":{"509":{},"511":{}}}],["dynam",{"_index":187,"title":{"179":{},"180":{},"181":{},"182":{},"183":{},"184":{}},"description":{"38":{},"179":{},"180":{},"181":{},"182":{},"183":{},"184":{}}}],["dynamicdns/cr",{"_index":580,"title":{},"description":{"180":{}}}],["dynamicdns/delet",{"_index":583,"title":{},"description":{"182":{}}}],["dynamicdns/list",{"_index":582,"title":{},"description":{"181":{}}}],["dynamicdns/recr",{"_index":585,"title":{},"description":{"183":{}}}],["dynamicdns/set_descript",{"_index":586,"title":{},"description":{"184":{}}}],["dynamicui.conf",{"_index":427,"title":{"121":{},"124":{}},"description":{"121":{},"124":{}}}],["ea-nginx",{"_index":1616,"title":{},"description":{"643":{},"644":{},"645":{},"646":{}}}],["ea4",{"_index":1589,"title":{"622":{},"623":{}},"description":{"622":{},"623":{}}}],["each",{"_index":65,"title":{},"description":{"8":{},"9":{},"38":{},"156":{},"164":{},"199":{},"219":{},"345":{},"465":{},"466":{},"467":{},"468":{},"469":{},"470":{},"545":{},"584":{},"620":{},"621":{},"680":{}}}],["easyapach",{"_index":1590,"title":{"624":{}},"description":{"623":{},"624":{},"648":{},"649":{},"650":{},"651":{},"653":{},"654":{},"655":{},"656":{},"657":{},"658":{}}}],["edit",{"_index":305,"title":{"99":{}},"description":{"80":{},"156":{},"164":{},"620":{},"628":{}}}],["editor",{"_index":1635,"title":{},"description":{"653":{},"655":{}}}],["editor*](https://go.cpanel.net/whmdocsmultiphpinieditor",{"_index":1638,"title":{},"description":{"655":{}}}],["editor](https://go.cpanel.net/cpanelmultiphpini",{"_index":1633,"title":{},"description":{"653":{}}}],["email",{"_index":207,"title":{"45":{},"46":{},"58":{},"59":{},"93":{},"117":{},"118":{},"185":{},"221":{},"224":{},"226":{},"227":{},"228":{},"229":{},"230":{},"231":{},"232":{},"233":{},"234":{},"235":{},"236":{},"237":{},"238":{},"239":{},"240":{},"241":{},"242":{},"244":{},"246":{},"247":{},"248":{},"249":{},"250":{},"251":{},"252":{},"253":{},"254":{},"255":{},"256":{},"260":{},"261":{},"262":{},"263":{},"264":{},"265":{},"266":{},"267":{},"268":{},"269":{},"270":{},"271":{},"272":{},"274":{},"277":{},"281":{},"286":{},"292":{},"293":{},"294":{},"295":{},"296":{},"297":{},"298":{},"317":{},"343":{},"350":{},"351":{},"356":{},"357":{},"358":{},"361":{},"363":{},"365":{},"368":{},"370":{},"371":{},"372":{},"586":{}},"description":{"45":{},"46":{},"58":{},"59":{},"83":{},"93":{},"117":{},"118":{},"185":{},"186":{},"187":{},"188":{},"195":{},"221":{},"222":{},"224":{},"225":{},"226":{},"227":{},"228":{},"229":{},"230":{},"232":{},"233":{},"234":{},"235":{},"237":{},"239":{},"240":{},"241":{},"242":{},"246":{},"247":{},"248":{},"249":{},"250":{},"251":{},"252":{},"254":{},"255":{},"256":{},"257":{},"258":{},"259":{},"260":{},"261":{},"262":{},"263":{},"264":{},"268":{},"269":{},"271":{},"272":{},"274":{},"276":{},"277":{},"281":{},"283":{},"284":{},"286":{},"288":{},"292":{},"293":{},"294":{},"295":{},"296":{},"297":{},"298":{},"299":{},"302":{},"307":{},"308":{},"310":{},"322":{},"330":{},"337":{},"344":{},"349":{},"350":{},"351":{},"355":{},"356":{},"357":{},"358":{},"363":{},"364":{},"366":{},"368":{},"370":{},"372":{},"373":{},"375":{},"377":{},"586":{}}}],["email/account_nam",{"_index":682,"title":{},"description":{"222":{}}}],["email/add_auto_respond",{"_index":753,"title":{},"description":{"255":{}}}],["email/add_domain_forward",{"_index":810,"title":{},"description":{"273":{}}}],["email/add_forward",{"_index":812,"title":{},"description":{"274":{}}}],["email/add_list",{"_index":929,"title":{},"description":{"321":{}}}],["email/add_mailman_deleg",{"_index":907,"title":{},"description":{"309":{}}}],["email/add_mx",{"_index":591,"title":{},"description":{"186":{}}}],["email/add_pop",{"_index":691,"title":{},"description":{"224":{}}}],["email/add_spam_filt",{"_index":986,"title":{},"description":{"348":{}}}],["email/browse_mailbox",{"_index":685,"title":{},"description":{"223":{}}}],["email/change_mx",{"_index":592,"title":{},"description":{"187":{}}}],["email/check_fastmail",{"_index":824,"title":{},"description":{"282":{}}}],["email/count_auto_respond",{"_index":694,"title":{},"description":{"225":{}}}],["email/count_filt",{"_index":772,"title":{},"description":{"261":{}}}],["email/count_forward",{"_index":815,"title":{},"description":{"276":{}}}],["email/count_list",{"_index":909,"title":{},"description":{"310":{}}}],["email/count_pop",{"_index":696,"title":{},"description":{"226":{}}}],["email/delete_auto_respond",{"_index":751,"title":{},"description":{"253":{}}}],["email/delete_domain_forward",{"_index":813,"title":{},"description":{"275":{}}}],["email/delete_filt",{"_index":809,"title":{},"description":{"271":{}}}],["email/delete_forward",{"_index":816,"title":{},"description":{"277":{}}}],["email/delete_held_messag",{"_index":700,"title":{},"description":{"227":{}}}],["email/delete_list",{"_index":914,"title":{},"description":{"312":{}}}],["email/delete_mx",{"_index":593,"title":{},"description":{"188":{}}}],["email/delete_pop",{"_index":752,"title":{},"description":{"254":{}}}],["email/disable_filt",{"_index":773,"title":{},"description":{"262":{}}}],["email/disable_mailbox_autocr",{"_index":836,"title":{},"description":{"283":{}}}],["email/disable_spam_assassin",{"_index":959,"title":{},"description":{"338":{}}}],["email/disable_spam_autodelet",{"_index":961,"title":{},"description":{"339":{}}}],["email/disable_spam_box",{"_index":965,"title":{},"description":{"340":{}}}],["email/dispatch_client_set",{"_index":703,"title":{},"description":{"229":{}}}],["email/edit_pop_quota",{"_index":702,"title":{},"description":{"228":{}}}],["email/enable_filt",{"_index":774,"title":{},"description":{"263":{}}}],["email/enable_mailbox_autocr",{"_index":838,"title":{},"description":{"284":{}}}],["email/enable_spam_assassin",{"_index":969,"title":{},"description":{"342":{}}}],["email/enable_spam_box",{"_index":968,"title":{},"description":{"341":{}}}],["email/export_list",{"_index":913,"title":{},"description":{"311":{}}}],["email/fetch_charmap",{"_index":839,"title":{},"description":{"285":{}}}],["email/fts_rescan_mailbox",{"_index":851,"title":{},"description":{"286":{}}}],["email/generate_mailman_otp",{"_index":917,"title":{},"description":{"313":{}}}],["email/get_auto_respond",{"_index":711,"title":{},"description":{"231":{}}}],["email/get_charset",{"_index":852,"title":{},"description":{"287":{}}}],["email/get_client_set",{"_index":712,"title":{},"description":{"232":{}}}],["email/get_default_email_quota",{"_index":715,"title":{},"description":{"233":{}}}],["email/get_default_email_quota_mib",{"_index":720,"title":{},"description":{"235":{}}}],["email/get_disk_usag",{"_index":717,"title":{},"description":{"234":{}}}],["email/get_filt",{"_index":776,"title":{},"description":{"264":{}}}],["email/get_held_message_count",{"_index":723,"title":{},"description":{"237":{}}}],["email/get_lists_total_disk_usag",{"_index":919,"title":{},"description":{"314":{}}}],["email/get_mailbox_autocr",{"_index":853,"title":{},"description":{"288":{}}}],["email/get_mailman_deleg",{"_index":921,"title":{},"description":{"315":{}}}],["email/get_main_account_disk_usag",{"_index":721,"title":{},"description":{"236":{}}}],["email/get_main_account_disk_usage_byt",{"_index":724,"title":{},"description":{"238":{}}}],["email/get_max_email_quota",{"_index":726,"title":{},"description":{"239":{}}}],["email/get_max_email_quota_mib",{"_index":729,"title":{},"description":{"240":{}}}],["email/get_pop_quota",{"_index":730,"title":{},"description":{"241":{}}}],["email/get_spam_set",{"_index":971,"title":{},"description":{"343":{}}}],["email/get_webmail_set",{"_index":733,"title":{},"description":{"242":{}}}],["email/has_delegated_mailman_list",{"_index":924,"title":{},"description":{"317":{}}}],["email/has_plaintext_authent",{"_index":856,"title":{},"description":{"289":{}}}],["email/hold_outgo",{"_index":710,"title":{},"description":{"230":{}}}],["email/list_auto_respond",{"_index":734,"title":{},"description":{"243":{}}}],["email/list_default_address",{"_index":735,"title":{},"description":{"244":{}}}],["email/list_domain_forward",{"_index":817,"title":{},"description":{"278":{}}}],["email/list_filt",{"_index":780,"title":{},"description":{"265":{}}}],["email/list_filters_backup",{"_index":782,"title":{},"description":{"266":{}}}],["email/list_forward",{"_index":818,"title":{},"description":{"279":{}}}],["email/list_forwarders_backup",{"_index":819,"title":{},"description":{"280":{}}}],["email/list_list",{"_index":925,"title":{},"description":{"318":{}}}],["email/list_mail_domain",{"_index":737,"title":{},"description":{"245":{}}}],["email/list_mx",{"_index":599,"title":{},"description":{"192":{}}}],["email/list_pop",{"_index":738,"title":{},"description":{"246":{}}}],["email/list_pops_with_disk",{"_index":739,"title":{},"description":{"247":{}}}],["email/list_system_filter_info",{"_index":785,"title":{},"description":{"267":{}}}],["email/passwd_list",{"_index":923,"title":{},"description":{"316":{}}}],["email/passwd_pop",{"_index":740,"title":{},"description":{"248":{}}}],["email/release_outgo",{"_index":743,"title":{},"description":{"249":{}}}],["email/remove_mailman_deleg",{"_index":927,"title":{},"description":{"319":{}}}],["email/reorder_filt",{"_index":786,"title":{},"description":{"268":{}}}],["email/set_always_accept",{"_index":860,"title":{},"description":{"290":{}}}],["email/set_default_address",{"_index":745,"title":{},"description":{"250":{}}}],["email/set_list_privacy_opt",{"_index":928,"title":{},"description":{"320":{}}}],["email/set_manual_mx_redirect",{"_index":762,"title":{},"description":{"257":{}}}],["email/stats_db_statu",{"_index":863,"title":{},"description":{"291":{}}}],["email/store_filt",{"_index":804,"title":{},"description":{"269":{}}}],["email/suspend_incom",{"_index":871,"title":{},"description":{"293":{}}}],["email/suspend_login",{"_index":877,"title":{},"description":{"294":{}}}],["email/suspend_outgo",{"_index":881,"title":{},"description":{"296":{}}}],["email/terminate_mailbox_sess",{"_index":768,"title":{},"description":{"259":{}}}],["email/trace_deliveri",{"_index":748,"title":{},"description":{"251":{}}}],["email/trace_filt",{"_index":808,"title":{},"description":{"270":{}}}],["email/unset_manual_mx_redirect",{"_index":763,"title":{},"description":{"258":{}}}],["email/unsuspend_incom",{"_index":882,"title":{},"description":{"297":{}}}],["email/unsuspend_login",{"_index":879,"title":{},"description":{"295":{}}}],["email/unsuspend_outgo",{"_index":884,"title":{},"description":{"298":{}}}],["email/verify_password",{"_index":750,"title":{},"description":{"252":{}}}],["email::disable_mailbox_autocr",{"_index":837,"title":{},"description":{"284":{},"288":{}}}],["email::disable_spam_autodelet",{"_index":984,"title":{},"description":{"348":{}}}],["email::disable_spam_box",{"_index":966,"title":{},"description":{"341":{}}}],["email::enable_mailbox_autocr",{"_index":831,"title":{},"description":{"283":{},"288":{}}}],["email::enable_spam_box",{"_index":963,"title":{},"description":{"340":{}}}],["email::hold_outgo",{"_index":742,"title":{},"description":{"249":{},"296":{}}}],["email::release_outgo",{"_index":705,"title":{},"description":{"230":{}}}],["email::suspend_incom",{"_index":875,"title":{},"description":{"294":{},"295":{}}}],["email::suspend_login",{"_index":869,"title":{},"description":{"293":{},"295":{},"296":{}}}],["email::suspend_outgo",{"_index":708,"title":{},"description":{"230":{},"298":{}}}],["email::unsuspend_incom",{"_index":870,"title":{},"description":{"293":{}}}],["email::unsuspend_login",{"_index":876,"title":{},"description":{"294":{}}}],["email::unsuspend_outgo",{"_index":880,"title":{},"description":{"296":{}}}],["emailauth/apply_dmarc",{"_index":596,"title":{},"description":{"189":{}}}],["emailauth/disable_dkim",{"_index":630,"title":{},"description":{"200":{}}}],["emailauth/enable_dkim",{"_index":604,"title":{},"description":{"193":{}}}],["emailauth/ensure_dkim_keys_exist",{"_index":606,"title":{},"description":{"194":{}}}],["emailauth/fetch_dkim_private_key",{"_index":614,"title":{},"description":{"195":{}}}],["emailauth/install_dkim_private_key",{"_index":618,"title":{},"description":{"196":{}}}],["emailauth/install_spf_record",{"_index":622,"title":{},"description":{"197":{}}}],["emailauth/remove_dmarc",{"_index":597,"title":{},"description":{"190":{}}}],["emailauth/validate_current_dkim",{"_index":623,"title":{},"description":{"198":{}}}],["emailauth/validate_current_dmarc",{"_index":598,"title":{},"description":{"191":{}}}],["emailauth/validate_current_ptr",{"_index":629,"title":{},"description":{"199":{}}}],["emailauth/validate_current_spf",{"_index":631,"title":{},"description":{"201":{}}}],["emailauth::enable_dkim",{"_index":616,"title":{},"description":{"196":{}}}],["emailauth::install_dkim_private_key",{"_index":617,"title":{},"description":{"196":{}}}],["enabl",{"_index":120,"title":{"32":{},"47":{},"60":{},"146":{},"169":{},"178":{},"193":{},"204":{},"263":{},"284":{},"289":{},"307":{},"331":{},"332":{},"336":{},"341":{},"342":{},"350":{},"401":{},"403":{},"447":{},"472":{},"473":{},"476":{},"477":{},"526":{},"562":{},"584":{},"587":{},"589":{},"630":{},"638":{},"639":{},"643":{}},"description":{"16":{},"20":{},"29":{},"32":{},"92":{},"146":{},"169":{},"176":{},"193":{},"263":{},"282":{},"283":{},"286":{},"288":{},"289":{},"307":{},"331":{},"332":{},"336":{},"340":{},"341":{},"342":{},"350":{},"368":{},"401":{},"403":{},"472":{},"473":{},"476":{},"477":{},"507":{},"533":{},"562":{},"584":{},"587":{},"588":{},"589":{},"591":{},"592":{},"616":{},"621":{},"630":{},"638":{},"639":{},"643":{},"651":{},"653":{},"654":{},"655":{},"656":{},"672":{}}}],["enable_mail_sni",{"_index":1528,"title":{},"description":{"592":{}}}],["encod",{"_index":530,"title":{"285":{},"287":{},"307":{},"414":{}},"description":{"155":{},"163":{},"285":{},"287":{},"414":{},"416":{}}}],["encrypt",{"_index":930,"title":{"322":{}},"description":{"322":{}}}],["end",{"_index":459,"title":{},"description":{"129":{},"259":{},"567":{},"597":{}}}],["enhanc",{"_index":216,"title":{"48":{},"49":{},"50":{}},"description":{"48":{}}}],["enhancement](https://go.cpanel.net/account-enhanc",{"_index":221,"title":{},"description":{"50":{}}}],["enhancements](https://go.cpanel.net/account-enhanc",{"_index":217,"title":{},"description":{"49":{}}}],["ensur",{"_index":67,"title":{},"description":{"8":{},"9":{},"156":{},"164":{},"199":{}}}],["enter",{"_index":1043,"title":{},"description":{"378":{},"379":{},"380":{}}}],["entir",{"_index":1175,"title":{},"description":{"430":{}}}],["entri",{"_index":759,"title":{},"description":{"257":{},"258":{},"290":{},"539":{},"615":{}}}],["entropi",{"_index":945,"title":{},"description":{"329":{}}}],["entropy](https://en.wikipedia.org/wiki/entropy_(comput",{"_index":943,"title":{},"description":{"329":{}}}],["environ",{"_index":1057,"title":{},"description":{"381":{}}}],["env{'remote_dbown",{"_index":1056,"title":{},"description":{"381":{}}}],["epoch",{"_index":1143,"title":{},"description":{"424":{},"426":{},"428":{}}}],["error",{"_index":653,"title":{},"description":{"208":{},"385":{},"428":{},"431":{},"437":{},"442":{},"444":{},"514":{},"615":{}}}],["etc",{"_index":1184,"title":{},"description":{"431":{}}}],["etc/manualmx",{"_index":760,"title":{},"description":{"257":{},"258":{}}}],["event",{"_index":1362,"title":{},"description":{"514":{}}}],["events](https://developer.mozilla.org/en-us/docs/web/api/server-sent_events/using_server-sent_ev",{"_index":1375,"title":{},"description":{"514":{}}}],["exampl",{"_index":17,"title":{},"description":{"1":{},"8":{},"9":{},"66":{},"129":{},"283":{},"284":{},"378":{},"379":{},"380":{},"406":{},"430":{},"546":{},"633":{}}}],["except",{"_index":1032,"title":{},"description":{"378":{}}}],["exchang",{"_index":587,"title":{"186":{},"187":{},"188":{},"192":{},"290":{}},"description":{"186":{},"187":{},"188":{},"192":{},"257":{},"258":{},"290":{}}}],["exchanger'",{"_index":859,"title":{},"description":{"290":{}}}],["exclud",{"_index":1461,"title":{},"description":{"563":{}}}],["exclus",{"_index":505,"title":{},"description":{"152":{},"160":{}}}],["exim",{"_index":741,"title":{"357":{}},"description":{"249":{},"257":{},"258":{},"265":{},"268":{},"269":{},"270":{},"301":{},"357":{}}}],["exim'",{"_index":704,"title":{},"description":{"230":{},"249":{},"268":{},"269":{},"270":{},"296":{},"300":{}}}],["eximstat",{"_index":861,"title":{"291":{}},"description":{"291":{}}}],["exim’",{"_index":778,"title":{},"description":{"265":{}}}],["exist",{"_index":30,"title":{"381":{},"385":{},"568":{}},"description":{"3":{},"76":{},"83":{},"113":{},"117":{},"118":{},"119":{},"129":{},"153":{},"161":{},"182":{},"183":{},"193":{},"194":{},"196":{},"283":{},"284":{},"385":{},"429":{},"430":{},"431":{},"507":{},"513":{},"540":{},"546":{},"584":{}}}],["expedit",{"_index":185,"title":{},"description":{"38":{}}}],["expir",{"_index":325,"title":{"88":{},"90":{}},"description":{"88":{},"89":{},"90":{},"313":{}}}],["export",{"_index":548,"title":{"168":{},"171":{},"311":{},"324":{},"325":{},"605":{},"606":{},"607":{}},"description":{"168":{},"171":{},"311":{},"324":{},"325":{}}}],["extend",{"_index":1080,"title":{},"description":{"397":{}}}],["extens",{"_index":639,"title":{},"description":{"204":{},"660":{}}}],["extern",{"_index":104,"title":{"13":{},"14":{},"15":{},"16":{},"17":{},"18":{}},"description":{"13":{},"14":{},"15":{},"16":{},"17":{},"18":{}}}],["externalauthentication/add_authn_link",{"_index":109,"title":{},"description":{"14":{}}}],["externalauthentication/configured_modul",{"_index":116,"title":{},"description":{"15":{}}}],["externalauthentication/get_authn_link",{"_index":124,"title":{},"description":{"18":{}}}],["externalauthentication/has_external_auth_modules_configur",{"_index":121,"title":{},"description":{"16":{}}}],["externalauthentication/remove_authn_link",{"_index":122,"title":{},"description":{"17":{}}}],["extract",{"_index":1487,"title":{},"description":{"573":{}}}],["extrem",{"_index":54,"title":{},"description":{"6":{}}}],["fail",{"_index":43,"title":{},"description":{"6":{},"270":{},"378":{},"442":{},"446":{},"514":{},"577":{},"587":{},"588":{},"589":{},"591":{},"592":{}}}],["failur",{"_index":1215,"title":{},"description":{"442":{},"555":{},"556":{}}}],["fast",{"_index":1150,"title":{},"description":{"424":{}}}],["fastmail",{"_index":821,"title":{"282":{}},"description":{}}],["fastmail](https://go.cpanel.net/blackberryfastmail",{"_index":823,"title":{},"description":{"282":{}}}],["featur",{"_index":13,"title":{"61":{},"62":{},"63":{},"64":{},"86":{}},"description":{"1":{},"61":{},"63":{},"64":{},"86":{},"261":{},"339":{},"431":{},"589":{},"616":{},"678":{}}}],["feature](https://go.cpanel.net/resetpassdoc",{"_index":688,"title":{},"description":{"224":{}}}],["feature](https://go.cpanel.net/whmdocsfeaturemanager#selectable-featur",{"_index":229,"title":{},"description":{"62":{}}}],["features/get_feature_metadata",{"_index":234,"title":{},"description":{"64":{}}}],["features/has_featur",{"_index":230,"title":{},"description":{"62":{}}}],["features/list_featur",{"_index":231,"title":{},"description":{"63":{}}}],["fetch",{"_index":457,"title":{},"description":{"129":{},"172":{}}}],["ff-onli",{"_index":1145,"title":{},"description":{"424":{}}}],["field",{"_index":331,"title":{},"description":{"89":{},"100":{},"573":{},"608":{},"609":{}}}],["file",{"_index":19,"title":{"69":{},"70":{},"110":{},"111":{},"115":{},"119":{},"128":{},"129":{},"157":{},"215":{},"223":{},"256":{},"267":{},"311":{},"367":{},"409":{},"410":{},"412":{},"413":{},"416":{},"417":{},"467":{},"469":{},"497":{},"503":{},"539":{},"592":{},"654":{},"665":{},"667":{}},"description":{"1":{},"8":{},"9":{},"24":{},"69":{},"70":{},"106":{},"107":{},"108":{},"109":{},"110":{},"111":{},"112":{},"113":{},"114":{},"115":{},"116":{},"117":{},"118":{},"119":{},"121":{},"123":{},"124":{},"157":{},"204":{},"207":{},"208":{},"209":{},"210":{},"215":{},"223":{},"256":{},"257":{},"258":{},"267":{},"270":{},"311":{},"346":{},"367":{},"382":{},"394":{},"404":{},"405":{},"407":{},"409":{},"410":{},"412":{},"413":{},"414":{},"415":{},"416":{},"417":{},"418":{},"424":{},"426":{},"428":{},"465":{},"466":{},"467":{},"468":{},"469":{},"470":{},"506":{},"507":{},"514":{},"537":{},"538":{},"539":{},"540":{},"592":{},"651":{},"654":{},"656":{},"660":{},"665":{},"667":{},"679":{},"680":{}}}],["file'",{"_index":100,"title":{},"description":{"12":{},"412":{}}}],["file](https://spamassassin.apache.org/full/3.1.x/doc/mail_spamassassin_conf.html#user_prefer",{"_index":980,"title":{},"description":{"347":{}}}],["fileman/autocompletedir",{"_index":1108,"title":{},"description":{"410":{}}}],["fileman/empty_trash",{"_index":1112,"title":{},"description":{"411":{}}}],["fileman/get_file_cont",{"_index":1120,"title":{},"description":{"412":{}}}],["fileman/get_file_inform",{"_index":1121,"title":{},"description":{"413":{}}}],["fileman/list_fil",{"_index":1125,"title":{},"description":{"415":{}}}],["fileman/save_file_cont",{"_index":1126,"title":{},"description":{"416":{}}}],["fileman/transcod",{"_index":1123,"title":{},"description":{"414":{}}}],["fileman/upload_fil",{"_index":1131,"title":{},"description":{"417":{}}}],["fileman::upload_fil",{"_index":1127,"title":{},"description":{"417":{}}}],["filenam",{"_index":195,"title":{"41":{}},"description":{"41":{},"106":{},"107":{},"108":{},"109":{},"406":{}}}],["filestorag",{"_index":1111,"title":{},"description":{"411":{},"415":{}}}],["filter",{"_index":422,"title":{"118":{},"260":{},"261":{},"262":{},"263":{},"265":{},"266":{},"267":{},"268":{},"269":{},"270":{},"271":{},"330":{},"339":{},"340":{},"341":{}},"description":{"118":{},"260":{},"262":{},"263":{},"265":{},"266":{},"267":{},"268":{},"269":{},"270":{},"271":{},"330":{},"338":{},"340":{},"341":{},"342":{},"348":{},"507":{}}}],["filter'",{"_index":775,"title":{"264":{}},"description":{"264":{}}}],["filter](https://go.cpanel.net/serverrol",{"_index":967,"title":{},"description":{"341":{}}}],["filters](https://go.cpanel.net/cpaneldocsemailfilt",{"_index":769,"title":{},"description":{"261":{}}}],["filters](https://go.cpanel.net/cpaneldocsspamfilt",{"_index":964,"title":{},"description":{"340":{},"341":{},"348":{}}}],["find",{"_index":1055,"title":{},"description":{"381":{},"512":{}}}],["finish",{"_index":1263,"title":{},"description":{"465":{},"466":{},"467":{},"468":{},"469":{},"470":{},"514":{}}}],["first",{"_index":99,"title":{},"description":{"12":{},"245":{},"269":{},"355":{},"442":{},"679":{}}}],["folder",{"_index":893,"title":{"411":{}},"description":{"303":{},"341":{},"344":{},"411":{}}}],["follow",{"_index":298,"title":{},"description":{"78":{},"83":{},"117":{},"118":{},"119":{},"129":{},"269":{},"378":{},"379":{},"380":{},"424":{},"426":{},"431":{},"442":{},"514":{},"584":{}}}],["footer",{"_index":439,"title":{"126":{}},"description":{"126":{}}}],["forc",{"_index":456,"title":{},"description":{"129":{}}}],["form",{"_index":680,"title":{},"description":{"222":{},"347":{}}}],["format",{"_index":381,"title":{"405":{}},"description":{"106":{},"107":{},"108":{},"109":{},"117":{},"118":{},"119":{},"195":{},"233":{},"239":{},"240":{},"284":{},"405":{},"514":{}}}],["format](https://en.wikipedia.org/wiki/email_address#sub-address",{"_index":833,"title":{},"description":{"283":{},"288":{}}}],["forward",{"_index":410,"title":{"117":{},"272":{},"273":{},"274":{},"275":{},"276":{},"277":{},"278":{},"279":{},"280":{},"366":{},"372":{}},"description":{"117":{},"272":{},"273":{},"274":{},"275":{},"277":{},"278":{},"279":{},"280":{},"366":{},"372":{},"424":{}}}],["forwarders](https://go.cpanel.net/forward",{"_index":814,"title":{},"description":{"276":{}}}],["found",{"_index":1366,"title":{},"description":{"514":{}}}],["fqdn",{"_index":1481,"title":{"571":{}},"description":{"571":{}}}],["framework",{"_index":621,"title":{},"description":{"197":{},"201":{}}}],["friendli",{"_index":1551,"title":{"601":{},"602":{},"603":{}},"description":{"601":{},"602":{},"603":{}}}],["friendly_nam",{"_index":1479,"title":{},"description":{"570":{},"572":{},"574":{},"595":{},"596":{},"597":{},"602":{},"603":{},"605":{},"607":{}}}],["from_charset",{"_index":1117,"title":{},"description":{"412":{}}}],["ftp",{"_index":314,"title":{"107":{},"382":{},"383":{},"384":{},"385":{},"386":{},"387":{},"388":{},"389":{},"390":{},"391":{},"392":{},"393":{},"394":{},"395":{},"396":{},"397":{},"398":{},"399":{},"400":{},"401":{},"403":{}},"description":{"83":{},"107":{},"382":{},"383":{},"384":{},"385":{},"386":{},"387":{},"388":{},"389":{},"390":{},"391":{},"392":{},"393":{},"394":{},"395":{},"396":{},"397":{},"398":{},"399":{},"400":{},"401":{},"402":{},"403":{}}}],["ftp/add_ftp",{"_index":1061,"title":{},"description":{"383":{}}}],["ftp/allows_anonymous_ftp",{"_index":1077,"title":{},"description":{"395":{}}}],["ftp/allows_anonymous_ftp_incom",{"_index":1079,"title":{},"description":{"396":{}}}],["ftp/delete_ftp",{"_index":1062,"title":{},"description":{"384":{}}}],["ftp/ftp_exist",{"_index":1063,"title":{},"description":{"385":{}}}],["ftp/get_ftp_daemon_info",{"_index":1082,"title":{},"description":{"397":{}}}],["ftp/get_port",{"_index":1083,"title":{},"description":{"398":{}}}],["ftp/get_quota",{"_index":1066,"title":{},"description":{"386":{}}}],["ftp/get_welcome_messag",{"_index":1068,"title":{},"description":{"387":{}}}],["ftp/kill_sess",{"_index":1085,"title":{},"description":{"399":{}}}],["ftp/list_ftp",{"_index":1074,"title":{},"description":{"392":{}}}],["ftp/list_ftp_with_disk",{"_index":1069,"title":{},"description":{"388":{}}}],["ftp/list_sess",{"_index":1086,"title":{},"description":{"400":{}}}],["ftp/passwd",{"_index":1070,"title":{},"description":{"389":{}}}],["ftp/server_nam",{"_index":1090,"title":{},"description":{"402":{}}}],["ftp/set_anonymous_ftp",{"_index":1087,"title":{},"description":{"401":{}}}],["ftp/set_anonymous_ftp_incom",{"_index":1091,"title":{},"description":{"403":{}}}],["ftp/set_homedir",{"_index":1071,"title":{},"description":{"390":{}}}],["ftp/set_quota",{"_index":1072,"title":{},"description":{"391":{}}}],["ftp/set_welcome_messag",{"_index":1075,"title":{},"description":{"393":{}}}],["fuction",{"_index":985,"title":{},"description":{"348":{}}}],["full",{"_index":10,"title":{},"description":{"1":{},"106":{},"107":{},"108":{},"109":{},"175":{}}}],["full-text",{"_index":840,"title":{"286":{}},"description":{"286":{}}}],["fulli",{"_index":1482,"title":{},"description":{"571":{}}}],["function",{"_index":8,"title":{"6":{}},"description":{"1":{},"2":{},"3":{},"4":{},"6":{},"8":{},"9":{},"11":{},"12":{},"14":{},"15":{},"16":{},"17":{},"18":{},"20":{},"21":{},"22":{},"23":{},"24":{},"26":{},"27":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"37":{},"38":{},"39":{},"40":{},"41":{},"42":{},"43":{},"45":{},"46":{},"47":{},"49":{},"50":{},"52":{},"53":{},"55":{},"58":{},"59":{},"60":{},"62":{},"63":{},"64":{},"66":{},"67":{},"69":{},"70":{},"72":{},"73":{},"75":{},"76":{},"77":{},"78":{},"79":{},"80":{},"81":{},"82":{},"83":{},"84":{},"86":{},"88":{},"89":{},"90":{},"91":{},"92":{},"93":{},"94":{},"95":{},"96":{},"97":{},"98":{},"99":{},"100":{},"101":{},"102":{},"103":{},"104":{},"106":{},"107":{},"108":{},"109":{},"110":{},"112":{},"113":{},"114":{},"115":{},"116":{},"117":{},"118":{},"119":{},"121":{},"122":{},"123":{},"124":{},"126":{},"128":{},"129":{},"131":{},"132":{},"133":{},"135":{},"136":{},"137":{},"139":{},"140":{},"141":{},"143":{},"144":{},"145":{},"146":{},"147":{},"148":{},"150":{},"152":{},"153":{},"154":{},"155":{},"156":{},"157":{},"158":{},"160":{},"161":{},"162":{},"163":{},"164":{},"165":{},"167":{},"168":{},"169":{},"170":{},"171":{},"172":{},"173":{},"174":{},"175":{},"176":{},"177":{},"178":{},"180":{},"181":{},"182":{},"183":{},"184":{},"186":{},"187":{},"188":{},"189":{},"190":{},"191":{},"192":{},"193":{},"194":{},"195":{},"196":{},"197":{},"198":{},"199":{},"200":{},"201":{},"203":{},"204":{},"205":{},"207":{},"208":{},"209":{},"210":{},"212":{},"213":{},"214":{},"215":{},"217":{},"219":{},"220":{},"222":{},"223":{},"224":{},"225":{},"226":{},"227":{},"228":{},"229":{},"230":{},"231":{},"232":{},"233":{},"234":{},"235":{},"236":{},"237":{},"238":{},"239":{},"240":{},"241":{},"242":{},"243":{},"244":{},"245":{},"246":{},"247":{},"248":{},"249":{},"250":{},"251":{},"252":{},"253":{},"254":{},"255":{},"256":{},"257":{},"258":{},"259":{},"261":{},"262":{},"263":{},"264":{},"265":{},"266":{},"267":{},"268":{},"269":{},"270":{},"271":{},"273":{},"274":{},"275":{},"276":{},"277":{},"278":{},"279":{},"280":{},"282":{},"283":{},"284":{},"285":{},"286":{},"287":{},"288":{},"289":{},"290":{},"291":{},"293":{},"294":{},"295":{},"296":{},"297":{},"298":{},"300":{},"301":{},"303":{},"304":{},"305":{},"306":{},"307":{},"309":{},"310":{},"311":{},"312":{},"313":{},"314":{},"315":{},"316":{},"317":{},"318":{},"319":{},"320":{},"321":{},"323":{},"324":{},"325":{},"326":{},"327":{},"328":{},"329":{},"331":{},"332":{},"333":{},"334":{},"335":{},"336":{},"338":{},"339":{},"340":{},"341":{},"342":{},"343":{},"344":{},"345":{},"346":{},"347":{},"348":{},"350":{},"351":{},"352":{},"353":{},"354":{},"355":{},"356":{},"357":{},"358":{},"359":{},"360":{},"361":{},"362":{},"363":{},"364":{},"365":{},"366":{},"367":{},"368":{},"369":{},"370":{},"371":{},"372":{},"373":{},"374":{},"376":{},"378":{},"379":{},"380":{},"381":{},"383":{},"384":{},"385":{},"386":{},"387":{},"388":{},"389":{},"390":{},"391":{},"392":{},"393":{},"395":{},"396":{},"397":{},"398":{},"399":{},"400":{},"401":{},"402":{},"403":{},"405":{},"406":{},"407":{},"408":{},"410":{},"411":{},"412":{},"413":{},"414":{},"415":{},"416":{},"417":{},"419":{},"420":{},"421":{},"422":{},"424":{},"425":{},"426":{},"428":{},"429":{},"430":{},"431":{},"433":{},"434":{},"436":{},"437":{},"438":{},"439":{},"440":{},"441":{},"442":{},"443":{},"444":{},"446":{},"447":{},"448":{},"449":{},"451":{},"452":{},"453":{},"454":{},"455":{},"456":{},"457":{},"458":{},"459":{},"460":{},"462":{},"465":{},"466":{},"467":{},"468":{},"469":{},"470":{},"472":{},"473":{},"474":{},"475":{},"476":{},"477":{},"478":{},"479":{},"480":{},"481":{},"482":{},"483":{},"485":{},"486":{},"487":{},"488":{},"489":{},"491":{},"492":{},"493":{},"495":{},"496":{},"497":{},"498":{},"499":{},"500":{},"501":{},"502":{},"503":{},"505":{},"506":{},"507":{},"508":{},"509":{},"510":{},"511":{},"512":{},"513":{},"514":{},"515":{},"517":{},"518":{},"519":{},"520":{},"521":{},"523":{},"524":{},"525":{},"526":{},"527":{},"528":{},"529":{},"530":{},"531":{},"533":{},"534":{},"535":{},"537":{},"538":{},"539":{},"540":{},"542":{},"543":{},"545":{},"546":{},"548":{},"550":{},"552":{},"554":{},"555":{},"556":{},"558":{},"559":{},"560":{},"561":{},"562":{},"563":{},"564":{},"566":{},"567":{},"568":{},"569":{},"570":{},"571":{},"572":{},"573":{},"574":{},"575":{},"576":{},"577":{},"578":{},"579":{},"580":{},"581":{},"582":{},"583":{},"584":{},"585":{},"587":{},"588":{},"589":{},"590":{},"591":{},"592":{},"594":{},"595":{},"596":{},"597":{},"598":{},"599":{},"600":{},"601":{},"602":{},"603":{},"604":{},"605":{},"606":{},"607":{},"608":{},"609":{},"611":{},"612":{},"613":{},"615":{},"616":{},"617":{},"618":{},"620":{},"621":{},"623":{},"626":{},"628":{},"629":{},"630":{},"631":{},"632":{},"633":{},"634":{},"636":{},"637":{},"638":{},"639":{},"640":{},"641":{},"643":{},"644":{},"645":{},"646":{},"648":{},"649":{},"650":{},"651":{},"652":{},"653":{},"654":{},"655":{},"656":{},"657":{},"658":{},"660":{},"661":{},"662":{},"663":{},"666":{},"667":{},"668":{},"670":{},"671":{},"672":{},"674":{},"676":{},"678":{},"679":{},"680":{}}}],["function'",{"_index":524,"title":{},"description":{"155":{},"163":{},"209":{},"346":{},"442":{},"678":{}}}],["further",{"_index":45,"title":{},"description":{"6":{}}}],["futur",{"_index":874,"title":{},"description":{"294":{},"523":{}}}],["gain",{"_index":341,"title":{},"description":{"91":{},"96":{},"103":{}}}],["gener",{"_index":129,"title":{},"description":{"20":{},"128":{},"176":{},"196":{},"313":{},"329":{},"514":{},"598":{},"599":{},"600":{},"630":{}}}],["get",{"_index":1256,"title":{},"description":{"465":{},"468":{}}}],["get_inst",{"_index":1365,"title":{},"description":{"514":{}}}],["get_instance_by_id",{"_index":1342,"title":{},"description":{"507":{},"514":{}}}],["get_php_recommend",{"_index":1593,"title":{},"description":{"626":{}}}],["get_recommend",{"_index":1591,"title":{},"description":{"623":{}}}],["git",{"_index":72,"title":{"424":{},"425":{},"426":{},"428":{},"429":{},"430":{},"431":{}},"description":{"8":{},"9":{},"423":{},"424":{},"425":{},"426":{},"427":{},"428":{},"429":{},"430":{},"431":{}}}],["git](https://go.cpanel.net/gitdeploy",{"_index":1163,"title":{},"description":{"428":{},"429":{},"430":{},"431":{}}}],["gitweb",{"_index":1188,"title":{},"description":{"431":{}}}],["give",{"_index":322,"title":{},"description":{"86":{},"183":{},"412":{},"439":{}}}],["given",{"_index":356,"title":{},"description":{"97":{},"155":{},"156":{},"163":{},"164":{}}}],["global",{"_index":890,"title":{"472":{},"473":{},"474":{}},"description":{"303":{},"472":{},"473":{},"474":{}}}],["gnupg",{"_index":931,"title":{"322":{},"323":{},"324":{},"325":{},"326":{},"327":{},"328":{},"329":{}},"description":{"322":{},"323":{},"324":{},"325":{},"326":{},"327":{},"328":{},"329":{}}}],["gpg",{"_index":933,"title":{},"description":{"323":{},"324":{},"325":{},"326":{},"327":{},"328":{},"329":{}}}],["gpg/delete_keypair",{"_index":934,"title":{},"description":{"323":{}}}],["gpg/export_public_key",{"_index":936,"title":{},"description":{"324":{}}}],["gpg/export_secret_key",{"_index":938,"title":{},"description":{"325":{}}}],["gpg/generate_key",{"_index":948,"title":{},"description":{"329":{}}}],["gpg/import_key",{"_index":939,"title":{},"description":{"326":{}}}],["gpg/list_public_key",{"_index":941,"title":{},"description":{"327":{}}}],["gpg/list_secret_key",{"_index":942,"title":{},"description":{"328":{}}}],["grant",{"_index":15,"title":{},"description":{"1":{},"309":{},"442":{},"523":{},"526":{}}}],["grants_",{"_index":1394,"title":{},"description":{"523":{}}}],["greylist",{"_index":950,"title":{"330":{},"331":{},"332":{},"333":{},"334":{},"335":{},"336":{}},"description":{"330":{},"331":{},"332":{},"333":{},"334":{},"336":{}}}],["greylisting'",{"_index":955,"title":{},"description":{"335":{}}}],["group",{"_index":431,"title":{},"description":{"122":{}}}],["guid",{"_index":892,"title":{"305":{}},"description":{"303":{},"424":{},"425":{},"426":{},"428":{},"429":{},"430":{},"431":{},"679":{},"680":{}}}],["handl",{"_index":526,"title":{},"description":{"155":{},"163":{},"465":{},"466":{},"467":{},"468":{},"469":{},"470":{}}}],["handler",{"_index":1622,"title":{"648":{},"659":{},"660":{},"661":{},"662":{}},"description":{"648":{},"659":{},"660":{},"661":{},"662":{}}}],["hash",{"_index":358,"title":{},"description":{"97":{},"528":{}}}],["head",{"_index":1147,"title":{},"description":{"424":{}}}],["header",{"_index":438,"title":{"126":{}},"description":{"126":{}}}],["health",{"_index":1429,"title":{},"description":{"545":{}}}],["held",{"_index":699,"title":{},"description":{"227":{},"237":{}}}],["hold",{"_index":709,"title":{},"description":{"230":{},"296":{}}}],["holder",{"_index":1251,"title":{},"description":{"462":{}}}],["home",{"_index":76,"title":{"108":{},"112":{},"390":{},"421":{},"422":{}},"description":{"8":{},"9":{},"78":{},"108":{},"112":{},"286":{},"311":{},"390":{},"411":{},"421":{},"422":{},"616":{},"653":{},"654":{},"655":{},"679":{}}}],["home/user/.ssh/known_host",{"_index":1418,"title":{},"description":{"537":{},"538":{},"539":{},"540":{}}}],["home/username/var/cpanel/reseller/site_templ",{"_index":1666,"title":{},"description":{"678":{},"679":{}}}],["hord",{"_index":1297,"title":{"477":{}},"description":{"477":{}}}],["host",{"_index":214,"title":{"207":{},"209":{},"218":{},"219":{},"433":{},"434":{},"446":{},"447":{},"448":{},"449":{},"536":{},"537":{},"538":{},"539":{},"540":{}},"description":{"47":{},"60":{},"218":{},"219":{},"340":{},"341":{},"433":{},"434":{},"447":{},"448":{},"536":{},"537":{},"538":{},"555":{},"556":{},"654":{},"658":{}}}],["host'",{"_index":1235,"title":{"651":{},"656":{},"657":{},"658":{}},"description":{"449":{},"539":{},"540":{},"651":{},"653":{},"656":{},"657":{}}}],["hostnam",{"_index":1041,"title":{"543":{},"575":{}},"description":{"378":{},"379":{},"380":{},"543":{},"575":{}}}],["hotlink",{"_index":633,"title":{"202":{},"203":{},"204":{},"205":{}},"description":{"202":{},"203":{},"204":{},"205":{}}}],["htaccess",{"_index":670,"title":{"215":{}},"description":{"215":{}}}],["html",{"_index":440,"title":{"126":{}},"description":{"126":{}}}],["htpasswd",{"_index":1181,"title":{},"description":{"431":{}}}],["http",{"_index":51,"title":{"612":{}},"description":{"6":{},"378":{},"379":{},"380":{},"573":{},"584":{},"608":{},"609":{},"612":{}}}],["https://$url_authty:2096$token/login",{"_index":1038,"title":{},"description":{"378":{},"379":{},"380":{}}}],["https://example.com/styled/basic/sprites/icon_spritemap.css",{"_index":461,"title":{},"description":{"129":{}}}],["https://example.com/styled/basic/sprites/icon_spritemap.css?<cachebusterid",{"_index":462,"title":{},"description":{"129":{}}}],["https://hostname.example.com:2096/cpsess2462418786/login",{"_index":1046,"title":{},"description":{"378":{},"379":{},"380":{}}}],["hypothet",{"_index":282,"title":{},"description":{"76":{}}}],["id",{"_index":448,"title":{"128":{},"129":{},"183":{}},"description":{"128":{},"129":{},"183":{},"381":{},"570":{},"572":{},"574":{},"595":{},"596":{},"597":{},"602":{},"603":{},"605":{},"607":{}}}],["ident",{"_index":115,"title":{},"description":{"15":{},"17":{}}}],["identifi",{"_index":602,"title":{},"description":{"193":{},"194":{},"196":{},"198":{},"200":{},"303":{},"429":{}}}],["ignor",{"_index":1004,"title":{"357":{}},"description":{"357":{}}}],["ignorelist",{"_index":996,"title":{"354":{},"359":{}},"description":{"354":{},"359":{}}}],["imag",{"_index":1092,"title":{"404":{},"405":{},"406":{},"407":{},"408":{}},"description":{"404":{},"405":{},"406":{},"407":{},"408":{}}}],["imagemanager/convert_fil",{"_index":1094,"title":{},"description":{"405":{}}}],["imagemanager/create_thumbnail",{"_index":1100,"title":{},"description":{"406":{}}}],["imagemanager/get_dimens",{"_index":1102,"title":{},"description":{"407":{}}}],["imagemanager/resize_imag",{"_index":1104,"title":{},"description":{"408":{}}}],["imap",{"_index":764,"title":{"259":{},"286":{}},"description":{"259":{},"286":{}}}],["immedi",{"_index":360,"title":{},"description":{"98":{},"294":{}}}],["imped",{"_index":69,"title":{},"description":{"8":{},"9":{}}}],["imperson",{"_index":612,"title":{},"description":{"195":{}}}],["import",{"_index":145,"title":{"256":{},"326":{},"608":{},"609":{}},"description":{"26":{},"27":{},"38":{},"83":{},"112":{},"114":{},"115":{},"116":{},"117":{},"118":{},"119":{},"155":{},"163":{},"167":{},"168":{},"169":{},"170":{},"171":{},"172":{},"173":{},"174":{},"175":{},"176":{},"177":{},"178":{},"180":{},"181":{},"182":{},"183":{},"184":{},"186":{},"187":{},"188":{},"192":{},"203":{},"204":{},"205":{},"209":{},"212":{},"213":{},"215":{},"217":{},"222":{},"223":{},"224":{},"225":{},"226":{},"227":{},"229":{},"231":{},"232":{},"233":{},"234":{},"235":{},"236":{},"237":{},"238":{},"239":{},"240":{},"241":{},"242":{},"243":{},"244":{},"245":{},"246":{},"247":{},"248":{},"250":{},"252":{},"253":{},"254":{},"255":{},"256":{},"261":{},"262":{},"263":{},"264":{},"265":{},"266":{},"267":{},"268":{},"269":{},"270":{},"271":{},"273":{},"274":{},"275":{},"276":{},"277":{},"278":{},"279":{},"280":{},"282":{},"285":{},"286":{},"287":{},"289":{},"290":{},"291":{},"293":{},"294":{},"295":{},"296":{},"297":{},"309":{},"310":{},"312":{},"313":{},"314":{},"315":{},"316":{},"317":{},"320":{},"321":{},"326":{},"338":{},"339":{},"340":{},"341":{},"342":{},"343":{},"344":{},"348":{},"350":{},"351":{},"352":{},"353":{},"354":{},"355":{},"356":{},"357":{},"358":{},"359":{},"360":{},"361":{},"362":{},"363":{},"364":{},"365":{},"366":{},"367":{},"368":{},"369":{},"370":{},"371":{},"372":{},"373":{},"374":{},"376":{},"381":{},"383":{},"384":{},"386":{},"387":{},"388":{},"389":{},"390":{},"391":{},"392":{},"393":{},"395":{},"396":{},"398":{},"399":{},"400":{},"401":{},"402":{},"403":{},"405":{},"406":{},"407":{},"408":{},"410":{},"411":{},"412":{},"413":{},"414":{},"415":{},"416":{},"417":{},"419":{},"420":{},"421":{},"422":{},"424":{},"426":{},"428":{},"431":{},"433":{},"434":{},"436":{},"437":{},"438":{},"439":{},"440":{},"441":{},"442":{},"443":{},"444":{},"446":{},"447":{},"448":{},"449":{},"451":{},"452":{},"453":{},"454":{},"455":{},"456":{},"457":{},"458":{},"459":{},"460":{},"507":{},"517":{},"518":{},"519":{},"520":{},"521":{},"523":{},"524":{},"525":{},"526":{},"527":{},"528":{},"529":{},"530":{},"531":{},"558":{},"560":{},"561":{},"562":{},"563":{},"564":{},"567":{},"569":{},"570":{},"575":{},"577":{},"578":{},"579":{},"580":{},"581":{},"582":{},"584":{},"587":{},"589":{},"590":{},"592":{},"594":{},"595":{},"596":{},"597":{},"598":{},"599":{},"600":{},"601":{},"602":{},"603":{},"604":{},"605":{},"606":{},"607":{},"608":{},"609":{},"620":{},"621":{},"629":{},"630":{},"631":{},"632":{},"633":{},"636":{},"637":{},"638":{},"639":{},"640":{},"641":{},"648":{},"649":{},"650":{},"651":{},"652":{},"653":{},"654":{},"655":{},"656":{},"657":{},"658":{},"660":{},"661":{},"662":{},"663":{},"670":{},"671":{},"672":{},"678":{},"679":{},"680":{}}}],["inbound",{"_index":1078,"title":{},"description":{"396":{},"403":{}}}],["inbox",{"_index":962,"title":{},"description":{"340":{}}}],["includ",{"_index":183,"title":{},"description":{"38":{},"69":{},"70":{},"86":{},"220":{},"259":{},"344":{},"429":{},"572":{},"574":{},"595":{},"596":{},"597":{},"605":{},"607":{}}}],["incom",{"_index":865,"title":{"293":{},"297":{},"403":{}},"description":{"293":{},"294":{},"295":{},"297":{}}}],["incompat",{"_index":687,"title":{},"description":{"224":{}}}],["incorrect",{"_index":1033,"title":{},"description":{"378":{}}}],["index",{"_index":483,"title":{"138":{},"139":{},"140":{},"141":{}},"description":{"138":{},"139":{},"286":{}}}],["indexing](https://go.cpanel.net/cpaneldocsindex",{"_index":486,"title":{},"description":{"140":{},"141":{}}}],["indic",{"_index":504,"title":{},"description":{"152":{},"160":{},"470":{},"613":{}}}],["infect",{"_index":1266,"title":{"467":{}},"description":{"465":{},"466":{},"467":{},"468":{},"469":{},"470":{}}}],["info",{"_index":426,"title":{"121":{},"123":{},"124":{},"577":{}},"description":{}}],["inform",{"_index":83,"title":{"9":{},"44":{},"51":{},"57":{},"66":{},"67":{},"79":{},"81":{},"120":{},"154":{},"159":{},"162":{},"206":{},"218":{},"231":{},"247":{},"264":{},"267":{},"281":{},"299":{},"397":{},"413":{},"432":{},"433":{},"434":{},"475":{},"541":{},"544":{},"570":{},"571":{},"578":{},"663":{},"673":{},"674":{},"680":{}},"description":{"8":{},"9":{},"15":{},"44":{},"51":{},"57":{},"76":{},"79":{},"81":{},"117":{},"119":{},"120":{},"121":{},"122":{},"123":{},"124":{},"133":{},"136":{},"137":{},"153":{},"154":{},"159":{},"161":{},"162":{},"186":{},"187":{},"188":{},"206":{},"209":{},"218":{},"231":{},"247":{},"261":{},"264":{},"265":{},"267":{},"268":{},"269":{},"270":{},"274":{},"281":{},"286":{},"299":{},"340":{},"341":{},"346":{},"347":{},"348":{},"388":{},"392":{},"397":{},"413":{},"415":{},"417":{},"424":{},"425":{},"426":{},"428":{},"429":{},"430":{},"431":{},"432":{},"433":{},"434":{},"475":{},"506":{},"512":{},"514":{},"541":{},"544":{},"549":{},"570":{},"571":{},"573":{},"577":{},"578":{},"620":{},"621":{},"648":{},"663":{},"673":{},"674":{},"679":{},"680":{}}}],["inher",{"_index":1531,"title":{},"description":{"594":{}}}],["ini",{"_index":1632,"title":{},"description":{"653":{},"655":{}}}],["initi",{"_index":1464,"title":{},"description":{"564":{}}}],["input",{"_index":684,"title":{},"description":{"223":{},"429":{}}}],["insid",{"_index":1096,"title":{},"description":{"406":{}}}],["instal",{"_index":603,"title":{"594":{},"632":{},"640":{},"650":{},"675":{},"676":{}},"description":{"193":{},"195":{},"196":{},"197":{},"286":{},"477":{},"485":{},"486":{},"487":{},"488":{},"489":{},"495":{},"496":{},"497":{},"498":{},"499":{},"500":{},"501":{},"502":{},"503":{},"505":{},"506":{},"507":{},"508":{},"509":{},"510":{},"511":{},"512":{},"513":{},"514":{},"515":{},"577":{},"594":{},"632":{},"640":{},"643":{},"644":{},"645":{},"646":{},"674":{},"675":{},"676":{}}}],["install_dovecot_ft",{"_index":849,"title":{},"description":{"286":{}}}],["instanc",{"_index":1320,"title":{"493":{}},"description":{"493":{},"507":{},"509":{},"514":{}}}],["instance'",{"_index":1318,"title":{"492":{}},"description":{"492":{},"505":{},"507":{},"511":{}}}],["instead",{"_index":248,"title":{},"description":{"66":{},"167":{},"224":{},"528":{},"567":{},"595":{},"596":{},"597":{}}}],["integ",{"_index":450,"title":{},"description":{"128":{}}}],["integr",{"_index":92,"title":{"11":{},"28":{},"437":{}},"description":{"11":{},"28":{},"36":{}}}],["integration/fetch_url",{"_index":94,"title":{},"description":{"11":{}}}],["interfac",{"_index":75,"title":{},"description":{"8":{},"9":{},"47":{},"60":{},"78":{},"122":{},"132":{},"136":{},"222":{},"286":{},"514":{},"523":{},"616":{},"653":{},"655":{}}}],["intern",{"_index":1227,"title":{},"description":{"444":{}}}],["invalid",{"_index":1177,"title":{},"description":{"430":{}}}],["ip",{"_index":142,"title":{"25":{},"26":{},"27":{},"157":{},"542":{},"577":{},"604":{}},"description":{"25":{},"26":{},"27":{},"199":{},"261":{},"542":{},"577":{},"578":{},"604":{}}}],["ipv4",{"_index":536,"title":{},"description":{"157":{},"199":{}}}],["ipv6",{"_index":626,"title":{},"description":{"199":{}}}],["irrevers",{"_index":568,"title":{},"description":{"175":{}}}],["iso-8859-1",{"_index":1116,"title":{},"description":{"412":{}}}],["it'",{"_index":337,"title":{},"description":{"90":{}}}],["item",{"_index":60,"title":{"8":{},"33":{},"581":{}},"description":{"33":{},"114":{},"223":{},"581":{}}}],["item'",{"_index":396,"title":{},"description":{"114":{}}}],["json",{"_index":1114,"title":{},"description":{"412":{}}}],["json-encod",{"_index":1363,"title":{},"description":{"514":{}}}],["key",{"_index":262,"title":{"109":{},"168":{},"170":{},"173":{},"174":{},"176":{},"178":{},"194":{},"195":{},"196":{},"322":{},"323":{},"324":{},"325":{},"326":{},"327":{},"328":{},"329":{},"572":{},"573":{},"580":{},"585":{},"596":{},"599":{},"606":{},"609":{}},"description":{"69":{},"70":{},"109":{},"168":{},"169":{},"170":{},"173":{},"174":{},"175":{},"176":{},"178":{},"194":{},"195":{},"196":{},"322":{},"323":{},"324":{},"325":{},"326":{},"327":{},"328":{},"329":{},"540":{},"569":{},"572":{},"573":{},"574":{},"580":{},"585":{},"595":{},"596":{},"599":{},"600":{},"606":{},"609":{}}}],["key'",{"_index":1489,"title":{"574":{},"603":{}},"description":{"603":{}}}],["keysiz",{"_index":1547,"title":{},"description":{"599":{}}}],["keytyp",{"_index":1546,"title":{},"description":{"599":{}}}],["kill",{"_index":1084,"title":{},"description":{"399":{}}}],["knowledg",{"_index":1226,"title":{},"description":{"444":{}}}],["known",{"_index":1417,"title":{"536":{}},"description":{"536":{}}}],["known_host",{"_index":1421,"title":{"539":{}},"description":{}}],["knownhosts/cr",{"_index":1419,"title":{},"description":{"537":{}}}],["knownhosts/delet",{"_index":1420,"title":{},"description":{"538":{}}}],["knownhosts/upd",{"_index":1422,"title":{},"description":{"539":{}}}],["knownhosts/verifi",{"_index":1423,"title":{},"description":{"540":{}}}],["langphp/php_get_domain_handl",{"_index":1623,"title":{},"description":{"648":{}}}],["langphp/php_get_impacted_domain",{"_index":1624,"title":{},"description":{"649":{}}}],["langphp/php_get_installed_vers",{"_index":1625,"title":{},"description":{"650":{}}}],["langphp/php_get_system_default_vers",{"_index":1630,"title":{},"description":{"652":{}}}],["langphp/php_get_vhost_vers",{"_index":1642,"title":{},"description":{"658":{}}}],["langphp/php_ini_get_user_basic_direct",{"_index":1636,"title":{},"description":{"653":{}}}],["langphp/php_ini_get_user_cont",{"_index":1628,"title":{},"description":{"651":{}}}],["langphp/php_ini_get_user_path",{"_index":1637,"title":{},"description":{"654":{}}}],["langphp/php_ini_set_user_basic_direct",{"_index":1639,"title":{},"description":{"655":{}}}],["langphp/php_ini_set_user_cont",{"_index":1640,"title":{},"description":{"656":{}}}],["langphp/php_set_vhost_vers",{"_index":1641,"title":{},"description":{"657":{}}}],["languag",{"_index":466,"title":{"130":{}},"description":{"130":{},"132":{},"414":{}}}],["last",{"_index":1424,"title":{"542":{}},"description":{}}],["lastlogin/get_last_or_current_logged_in_ip",{"_index":1425,"title":{},"description":{"542":{}}}],["latest",{"_index":1352,"title":{"510":{}},"description":{}}],["layer",{"_index":677,"title":{},"description":{"220":{}}}],["leech",{"_index":499,"title":{},"description":{"150":{}}}],["legaci",{"_index":1339,"title":{},"description":{"507":{}}}],["length",{"_index":48,"title":{"453":{},"518":{}},"description":{"6":{},"453":{},"518":{},"573":{},"608":{},"609":{}}}],["let",{"_index":756,"title":{},"description":{"257":{},"258":{},"556":{}}}],["level",{"_index":343,"title":{},"description":{"91":{},"96":{},"103":{},"329":{}}}],["limit",{"_index":264,"title":{},"description":{"69":{},"70":{},"444":{},"573":{},"608":{},"609":{}}}],["line",{"_index":533,"title":{"355":{}},"description":{"156":{},"164":{},"355":{},"381":{},"431":{}}}],["link",{"_index":107,"title":{"14":{},"17":{},"18":{},"78":{},"92":{},"202":{}},"description":{"14":{},"17":{},"18":{},"78":{},"83":{},"92":{},"202":{}}}],["list",{"_index":24,"title":{"26":{},"27":{},"86":{},"97":{},"308":{},"309":{},"310":{},"311":{},"312":{},"313":{},"314":{},"315":{},"316":{},"317":{},"318":{},"319":{},"320":{},"321":{},"357":{},"467":{},"479":{},"481":{},"486":{},"489":{},"667":{}},"description":{"2":{},"6":{},"15":{},"18":{},"29":{},"32":{},"39":{},"49":{},"52":{},"63":{},"64":{},"77":{},"79":{},"81":{},"84":{},"86":{},"97":{},"110":{},"112":{},"113":{},"114":{},"132":{},"137":{},"181":{},"192":{},"205":{},"207":{},"208":{},"209":{},"210":{},"215":{},"219":{},"220":{},"223":{},"243":{},"245":{},"246":{},"247":{},"265":{},"266":{},"278":{},"279":{},"280":{},"285":{},"287":{},"301":{},"303":{},"308":{},"309":{},"311":{},"312":{},"313":{},"315":{},"317":{},"318":{},"319":{},"321":{},"327":{},"328":{},"345":{},"347":{},"353":{},"354":{},"361":{},"364":{},"366":{},"370":{},"372":{},"376":{},"388":{},"392":{},"400":{},"415":{},"428":{},"431":{},"441":{},"453":{},"455":{},"457":{},"465":{},"466":{},"467":{},"468":{},"469":{},"470":{},"479":{},"480":{},"486":{},"489":{},"491":{},"492":{},"493":{},"498":{},"509":{},"520":{},"527":{},"533":{},"559":{},"560":{},"563":{},"578":{},"579":{},"580":{},"581":{},"582":{},"616":{},"620":{},"623":{},"626":{},"631":{},"649":{},"650":{},"652":{},"653":{},"654":{},"655":{},"662":{},"667":{},"672":{},"678":{},"680":{}}}],["list'",{"_index":920,"title":{},"description":{"315":{},"316":{},"320":{}}}],["listen",{"_index":888,"title":{},"description":{"301":{}}}],["lists](https://go.cpanel.net/cpaneldocsmailinglist",{"_index":918,"title":{},"description":{"314":{}}}],["lists](https://go.cpanel.net/mailinglist",{"_index":908,"title":{},"description":{"310":{}}}],["load",{"_index":1373,"title":{},"description":{"514":{}}}],["local",{"_index":237,"title":{"66":{},"101":{},"131":{},"132":{},"133":{},"152":{},"158":{},"160":{},"165":{}},"description":{"66":{},"101":{},"131":{},"133":{},"158":{},"165":{},"196":{},"230":{},"424":{},"426":{},"465":{}}}],["locale/get_attribut",{"_index":469,"title":{},"description":{"133":{}}}],["locale/list_local",{"_index":468,"title":{},"description":{"132":{}}}],["locale/set_local",{"_index":467,"title":{},"description":{"131":{}}}],["locat",{"_index":395,"title":{"114":{},"421":{}},"description":{"114":{},"115":{},"311":{},"678":{},"679":{}}}],["log",{"_index":868,"title":{"367":{},"506":{},"615":{},"664":{},"665":{},"666":{},"668":{}},"description":{"293":{},"294":{},"295":{},"367":{},"378":{},"379":{},"380":{},"424":{},"426":{},"428":{},"431":{},"506":{},"542":{},"615":{},"620":{},"621":{},"664":{},"665":{},"666":{},"668":{},"679":{}}}],["login",{"_index":168,"title":{"31":{},"35":{},"294":{},"295":{},"401":{},"541":{},"542":{}},"description":{"31":{},"35":{},"294":{},"296":{},"378":{},"401":{},"541":{}}}],["logmanager/delete_arch",{"_index":1650,"title":{},"description":{"665":{}}}],["logmanager/get_set",{"_index":1651,"title":{},"description":{"666":{}}}],["logmanager/list_arch",{"_index":1652,"title":{},"description":{"667":{}}}],["logmanager/set_set",{"_index":1656,"title":{},"description":{"668":{}}}],["long",{"_index":55,"title":{},"description":{"6":{},"329":{},"632":{}}}],["longer",{"_index":1298,"title":{},"description":{"477":{}}}],["lookup",{"_index":758,"title":{},"description":{"257":{},"258":{}}}],["loop",{"_index":1261,"title":{},"description":{"465":{},"466":{},"467":{},"468":{},"469":{},"470":{}}}],["lose",{"_index":569,"title":{},"description":{"175":{}}}],["low",{"_index":944,"title":{},"description":{"329":{}}}],["mail",{"_index":412,"title":{"186":{},"187":{},"188":{},"192":{},"223":{},"230":{},"245":{},"249":{},"276":{},"287":{},"290":{},"293":{},"296":{},"297":{},"298":{},"299":{},"300":{},"301":{},"308":{},"309":{},"310":{},"311":{},"312":{},"313":{},"314":{},"315":{},"316":{},"317":{},"318":{},"319":{},"320":{},"321":{},"587":{},"588":{},"589":{},"590":{},"591":{}},"description":{"117":{},"118":{},"186":{},"187":{},"188":{},"192":{},"193":{},"194":{},"195":{},"196":{},"198":{},"199":{},"200":{},"222":{},"223":{},"224":{},"225":{},"226":{},"227":{},"229":{},"230":{},"231":{},"232":{},"234":{},"236":{},"237":{},"240":{},"243":{},"244":{},"245":{},"246":{},"247":{},"248":{},"249":{},"250":{},"252":{},"253":{},"254":{},"255":{},"257":{},"258":{},"261":{},"262":{},"263":{},"265":{},"266":{},"267":{},"269":{},"270":{},"271":{},"273":{},"275":{},"276":{},"277":{},"278":{},"279":{},"280":{},"282":{},"285":{},"286":{},"287":{},"289":{},"290":{},"291":{},"293":{},"294":{},"295":{},"296":{},"297":{},"298":{},"299":{},"304":{},"308":{},"309":{},"310":{},"311":{},"312":{},"313":{},"314":{},"315":{},"316":{},"317":{},"318":{},"319":{},"320":{},"321":{},"339":{},"352":{},"353":{},"354":{},"356":{},"357":{},"359":{},"361":{},"362":{},"364":{},"367":{},"368":{},"373":{},"376":{},"431":{},"558":{},"560":{},"561":{},"562":{},"563":{},"564":{},"567":{},"569":{},"570":{},"575":{},"579":{},"580":{},"581":{},"582":{},"587":{},"588":{},"589":{},"590":{},"591":{},"592":{},"594":{},"595":{},"596":{},"597":{},"598":{},"599":{},"600":{},"601":{},"602":{},"603":{},"604":{},"605":{},"606":{},"607":{},"608":{},"609":{}}}],["mail*](https://go.cpanel.net/serverroles#rol",{"_index":1027,"title":{},"description":{"374":{}}}],["mail/exported_list",{"_index":911,"title":{},"description":{"311":{}}}],["mail](https://go.cpanel.net/serverrol",{"_index":714,"title":{},"description":{"233":{},"235":{},"238":{},"239":{},"241":{},"264":{},"270":{},"315":{},"350":{},"351":{},"355":{},"358":{},"363":{},"365":{},"366":{},"369":{},"370":{},"371":{},"372":{}}}],["mail_",{"_index":732,"title":{},"description":{"242":{},"268":{},"360":{},"577":{},"592":{}}}],["mail_](https://go.cpanel.net/serverrol",{"_index":922,"title":{},"description":{"316":{}}}],["mailbox",{"_index":825,"title":{"283":{},"284":{},"288":{},"302":{},"303":{},"304":{},"305":{},"306":{},"307":{}},"description":{"283":{},"284":{},"288":{},"302":{},"303":{},"306":{},"307":{}}}],["mailbox'",{"_index":898,"title":{},"description":{"305":{}}}],["mailboxes/expunge_mailbox_messag",{"_index":897,"title":{},"description":{"304":{}}}],["mailboxes/expunge_messages_for_mailbox_guid",{"_index":899,"title":{},"description":{"305":{}}}],["mailboxes/get_mailbox_status_list",{"_index":894,"title":{},"description":{"303":{}}}],["mailboxes/has_utf8_mailbox_nam",{"_index":902,"title":{},"description":{"306":{}}}],["mailboxes/set_utf8_mailbox_nam",{"_index":905,"title":{},"description":{"307":{}}}],["mailman",{"_index":910,"title":{"311":{}},"description":{"311":{},"312":{},"318":{},"320":{},"321":{}}}],["mailrec",{"_index":811,"title":{},"description":{"274":{},"578":{}}}],["main",{"_index":660,"title":{"270":{}},"description":{"209":{},"210":{},"223":{},"236":{},"245":{},"270":{}}}],["maintain",{"_index":256,"title":{},"description":{"69":{},"70":{}}}],["make",{"_index":553,"title":{},"description":{"169":{},"176":{},"587":{},"588":{},"589":{},"591":{},"592":{}}}],["manag",{"_index":2,"title":{"0":{},"7":{},"54":{},"74":{},"125":{},"127":{},"302":{},"337":{},"409":{},"427":{},"435":{},"450":{},"494":{},"504":{},"508":{},"516":{},"522":{},"536":{},"565":{},"593":{},"627":{},"659":{},"669":{},"677":{}},"description":{"0":{},"7":{},"54":{},"74":{},"120":{},"125":{},"127":{},"130":{},"134":{},"138":{},"142":{},"149":{},"202":{},"206":{},"211":{},"218":{},"286":{},"302":{},"337":{},"409":{},"423":{},"427":{},"435":{},"450":{},"494":{},"504":{},"508":{},"513":{},"514":{},"516":{},"522":{},"536":{},"565":{},"593":{},"621":{},"627":{},"647":{},"659":{},"669":{},"677":{}}}],["manager*](https://go.cpanel.net/cpaneldocsfilemanag",{"_index":20,"title":{},"description":{"1":{}}}],["manager*](https://go.cpanel.net/cpaneldocsusermanag",{"_index":294,"title":{},"description":{"78":{}}}],["manager](https://go.cpanel.net/wordpressmanag",{"_index":1323,"title":{},"description":{"495":{},"496":{},"497":{},"498":{},"499":{},"500":{},"501":{},"502":{},"503":{},"505":{},"506":{},"507":{},"508":{},"509":{},"510":{},"511":{},"512":{},"514":{},"515":{}}}],["manager_",{"_index":297,"title":{},"description":{"78":{},"616":{}}}],["manager_](https://go.cpanel.net/whmdocsfeaturemanag",{"_index":1572,"title":{},"description":{"616":{}}}],["mani",{"_index":477,"title":{},"description":{"136":{},"137":{},"156":{},"164":{}}}],["manual",{"_index":202,"title":{"257":{},"258":{}},"description":{"43":{},"257":{},"258":{},"523":{},"634":{}}}],["mariadb",{"_index":1192,"title":{},"description":{"432":{},"435":{},"445":{},"450":{}}}],["mark",{"_index":896,"title":{},"description":{"304":{},"305":{},"341":{},"357":{}}}],["market",{"_index":152,"title":{"28":{}},"description":{"28":{},"29":{},"31":{},"32":{},"33":{},"35":{},"39":{},"40":{},"42":{}}}],["market'",{"_index":203,"title":{},"description":{"43":{}}}],["market/cancel_pending_ssl_certif",{"_index":181,"title":{},"description":{"37":{}}}],["market/create_shopping_cart",{"_index":167,"title":{},"description":{"30":{}}}],["market/get_all_product",{"_index":157,"title":{},"description":{"29":{}}}],["market/get_certificate_status_detail",{"_index":191,"title":{},"description":{"38":{}}}],["market/get_login_url",{"_index":169,"title":{},"description":{"31":{}}}],["market/get_pending_ssl_certif",{"_index":192,"title":{},"description":{"39":{}}}],["market/get_provider_specific_dcv_constraint",{"_index":197,"title":{},"description":{"41":{}}}],["market/get_providers_list",{"_index":170,"title":{},"description":{"32":{}}}],["market/get_ssl_certificate_if_avail",{"_index":193,"title":{},"description":{"40":{}}}],["market/process_ssl_pending_queu",{"_index":204,"title":{},"description":{"43":{}}}],["market/request_ssl_certif",{"_index":199,"title":{},"description":{"42":{}}}],["market/set_status_of_pending_queue_item",{"_index":172,"title":{},"description":{"33":{}}}],["market/set_url_after_checkout",{"_index":176,"title":{},"description":{"34":{}}}],["market/validate_login_token",{"_index":178,"title":{},"description":{"35":{}}}],["market::request_ssl_certif",{"_index":166,"title":{},"description":{"30":{}}}],["match",{"_index":285,"title":{},"description":{"76":{},"155":{},"163":{},"353":{},"354":{},"359":{},"362":{},"364":{},"373":{}}}],["match1",{"_index":793,"title":{},"description":{"269":{}}}],["match2",{"_index":800,"title":{},"description":{"269":{}}}],["max",{"_index":725,"title":{"239":{},"240":{}},"description":{}}],["maximum",{"_index":368,"title":{},"description":{"102":{},"239":{},"240":{}}}],["md5",{"_index":1403,"title":{},"description":{"528":{}}}],["mebibyt",{"_index":727,"title":{},"description":{"240":{}}}],["mebibytes](https://en.wikipedia.org/wiki/mebibyt",{"_index":719,"title":{},"description":{"235":{}}}],["mechan",{"_index":255,"title":{},"description":{"69":{},"70":{},"128":{}}}],["meet",{"_index":605,"title":{},"description":{"194":{},"424":{},"426":{}}}],["messag",{"_index":656,"title":{"227":{},"237":{},"304":{},"305":{},"352":{},"358":{},"360":{},"361":{},"369":{},"374":{},"387":{},"393":{}},"description":{"208":{},"227":{},"237":{},"304":{},"305":{},"340":{},"341":{},"351":{},"352":{},"353":{},"354":{},"356":{},"357":{},"358":{},"359":{},"360":{},"361":{},"362":{},"363":{},"366":{},"369":{},"372":{},"374":{},"378":{},"379":{},"380":{},"387":{},"393":{},"424":{},"426":{},"431":{},"462":{},"514":{}}}],["message'",{"_index":807,"title":{"355":{}},"description":{"270":{}}}],["metadata",{"_index":232,"title":{"64":{},"113":{}},"description":{"76":{},"113":{},"385":{},"555":{},"556":{},"620":{}}}],["method",{"_index":53,"title":{},"description":{"6":{},"573":{},"608":{},"609":{}}}],["method](https://developer.mozilla.org/en-us/docs/web/http/methods/post",{"_index":419,"title":{},"description":{"117":{},"119":{}}}],["mib",{"_index":718,"title":{"235":{},"240":{}},"description":{"235":{}}}],["mib)](https://en.wikipedia.org/wiki/mebibyt",{"_index":728,"title":{},"description":{"240":{}}}],["mime",{"_index":1643,"title":{"660":{},"661":{},"662":{},"669":{},"670":{},"671":{},"672":{}},"description":{"660":{},"661":{},"662":{},"669":{},"670":{},"671":{},"672":{}}}],["mime/add_handl",{"_index":1644,"title":{},"description":{"660":{}}}],["mime/add_hotlink",{"_index":642,"title":{},"description":{"204":{}}}],["mime/add_mim",{"_index":1657,"title":{},"description":{"670":{}}}],["mime/add_redirect",{"_index":667,"title":{},"description":{"212":{}}}],["mime/delete_handl",{"_index":1645,"title":{},"description":{"661":{}}}],["mime/delete_hotlink",{"_index":635,"title":{},"description":{"203":{}}}],["mime/delete_mim",{"_index":1658,"title":{},"description":{"671":{}}}],["mime/delete_redirect",{"_index":668,"title":{},"description":{"213":{}}}],["mime/get_redirect",{"_index":669,"title":{},"description":{"214":{}}}],["mime/list_handl",{"_index":1647,"title":{},"description":{"662":{}}}],["mime/list_hotlink",{"_index":643,"title":{},"description":{"205":{}}}],["mime/list_mim",{"_index":1660,"title":{},"description":{"672":{}}}],["mime/list_redirect",{"_index":671,"title":{},"description":{"215":{}}}],["mime/redirect_info",{"_index":1648,"title":{},"description":{"663":{}}}],["minimum",{"_index":982,"title":{"348":{},"550":{}},"description":{"348":{},"550":{}}}],["mode",{"_index":1631,"title":{},"description":{"653":{},"655":{}}}],["modifi",{"_index":362,"title":{},"description":{"99":{},"136":{},"137":{},"169":{},"176":{},"268":{},"320":{},"371":{},"429":{}}}],["modify_account",{"_index":478,"title":{},"description":{"136":{},"137":{}}}],["modsecur",{"_index":1606,"title":{"635":{},"636":{},"637":{},"638":{},"639":{},"640":{},"641":{}},"description":{"635":{},"636":{},"637":{},"638":{},"639":{},"640":{}}}],["modsecurity'",{"_index":1612,"title":{},"description":{"641":{}}}],["modsecurity/disable_all_domain",{"_index":1607,"title":{},"description":{"636":{}}}],["modsecurity/disable_domain",{"_index":1608,"title":{},"description":{"637":{}}}],["modsecurity/enable_all_domain",{"_index":1609,"title":{},"description":{"638":{}}}],["modsecurity/enable_domain",{"_index":1610,"title":{},"description":{"639":{}}}],["modsecurity/has_modsecurity_instal",{"_index":1611,"title":{},"description":{"640":{}}}],["modsecurity/list_domain",{"_index":1613,"title":{},"description":{"641":{}}}],["modul",{"_index":35,"title":{},"description":{"5":{},"15":{},"16":{},"48":{},"56":{},"68":{},"85":{},"87":{},"105":{},"151":{},"216":{},"461":{},"463":{},"532":{},"547":{},"551":{},"553":{},"622":{},"635":{},"642":{}}}],["monitor",{"_index":1410,"title":{"533":{}},"description":{}}],["monitor](https://go.cpanel.net/whmdocstaskqueuemonitor",{"_index":85,"title":{},"description":{"8":{},"9":{}}}],["more",{"_index":82,"title":{},"description":{"8":{},"9":{},"76":{},"77":{},"117":{},"119":{},"136":{},"137":{},"153":{},"161":{},"186":{},"187":{},"188":{},"191":{},"193":{},"194":{},"198":{},"200":{},"201":{},"261":{},"265":{},"268":{},"269":{},"270":{},"274":{},"286":{},"340":{},"341":{},"346":{},"347":{},"348":{},"392":{},"415":{},"417":{},"424":{},"425":{},"426":{},"428":{},"429":{},"430":{},"431":{},"506":{},"512":{},"514":{},"620":{},"621":{},"648":{},"679":{},"680":{}}}],["move",{"_index":1208,"title":{},"description":{"442":{}}}],["mozilla'",{"_index":418,"title":{},"description":{"117":{},"119":{},"514":{}}}],["multipart/form-data",{"_index":414,"title":{},"description":{"117":{},"118":{},"119":{}}}],["multiphp",{"_index":1627,"title":{},"description":{"651":{},"653":{},"654":{},"655":{},"656":{}}}],["multipl",{"_index":38,"title":{"6":{},"121":{}},"description":{"6":{},"69":{},"70":{},"77":{},"83":{},"269":{},"523":{}}}],["mx",{"_index":588,"title":{"257":{},"258":{}},"description":{"186":{},"187":{},"188":{},"192":{},"257":{},"258":{},"290":{}}}],["mysql",{"_index":405,"title":{"433":{},"434":{},"436":{},"437":{},"438":{},"439":{},"440":{},"441":{},"442":{},"443":{},"444":{},"446":{},"447":{},"448":{},"449":{},"451":{},"452":{},"453":{},"454":{},"455":{},"456":{},"457":{},"458":{},"459":{},"460":{}},"description":{"116":{},"381":{},"432":{},"433":{},"434":{},"435":{},"436":{},"437":{},"438":{},"439":{},"440":{},"441":{},"442":{},"443":{},"444":{},"445":{},"446":{},"447":{},"448":{},"449":{},"450":{},"451":{},"452":{},"453":{},"454":{},"455":{},"456":{},"457":{},"458":{},"459":{},"460":{}}}],["mysql/add_host",{"_index":1233,"title":{},"description":{"447":{}}}],["mysql/add_host_not",{"_index":1232,"title":{},"description":{"446":{}}}],["mysql/check_databas",{"_index":1198,"title":{},"description":{"437":{}}}],["mysql/create_databas",{"_index":1199,"title":{},"description":{"438":{}}}],["mysql/create_us",{"_index":1237,"title":{},"description":{"451":{}}}],["mysql/delete_databas",{"_index":1205,"title":{},"description":{"440":{}}}],["mysql/delete_host",{"_index":1236,"title":{},"description":{"449":{}}}],["mysql/delete_us",{"_index":1238,"title":{},"description":{"452":{}}}],["mysql/dump_database_schema",{"_index":1204,"title":{},"description":{"439":{}}}],["mysql/get_host_not",{"_index":1234,"title":{},"description":{"448":{}}}],["mysql/get_privileges_on_databas",{"_index":1245,"title":{},"description":{"457":{}}}],["mysql/get_restrict",{"_index":1240,"title":{},"description":{"453":{}}}],["mysql/get_server_inform",{"_index":1193,"title":{},"description":{"433":{}}}],["mysql/list_databas",{"_index":1206,"title":{},"description":{"441":{}}}],["mysql/list_routin",{"_index":1242,"title":{},"description":{"454":{}}}],["mysql/list_us",{"_index":1243,"title":{},"description":{"455":{}}}],["mysql/locate_serv",{"_index":1195,"title":{},"description":{"434":{}}}],["mysql/mariadb",{"_index":1194,"title":{},"description":{"434":{},"436":{},"438":{},"439":{},"440":{},"441":{},"442":{},"443":{},"444":{},"448":{},"453":{},"454":{},"455":{},"459":{}}}],["mysql/rename_databas",{"_index":1219,"title":{},"description":{"442":{}}}],["mysql/rename_us",{"_index":1244,"title":{},"description":{"456":{}}}],["mysql/repair_databas",{"_index":1221,"title":{},"description":{"443":{}}}],["mysql/revoke_access_to_databas",{"_index":1247,"title":{},"description":{"458":{}}}],["mysql/set_password",{"_index":1249,"title":{},"description":{"460":{}}}],["mysql/set_privileges_on_databas",{"_index":1248,"title":{},"description":{"459":{}}}],["mysql/setup_db_and_us",{"_index":1230,"title":{},"description":{"444":{}}}],["mysql/update_privileg",{"_index":1196,"title":{},"description":{"436":{}}}],["name",{"_index":28,"title":{"3":{},"219":{},"222":{},"410":{},"442":{},"444":{},"453":{},"518":{},"521":{},"601":{},"602":{},"603":{}},"description":{"32":{},"219":{},"257":{},"258":{},"269":{},"306":{},"307":{},"444":{},"453":{},"518":{},"571":{},"601":{},"602":{},"603":{},"658":{}}}],["navig",{"_index":638,"title":{},"description":{"204":{}}}],["need",{"_index":1036,"title":{},"description":{"378":{},"379":{},"380":{},"444":{}}}],["new",{"_index":9,"title":{"405":{}},"description":{"1":{},"90":{},"94":{},"96":{},"100":{},"129":{},"136":{},"183":{},"193":{},"194":{},"269":{},"283":{},"284":{},"348":{},"405":{},"406":{},"428":{},"429":{},"442":{},"523":{},"604":{}}}],["newli",{"_index":1359,"title":{},"description":{"514":{}}}],["newmailbox",{"_index":835,"title":{},"description":{"283":{},"284":{}}}],["next",{"_index":542,"title":{},"description":{"167":{},"177":{}}}],["nginx",{"_index":1615,"title":{"643":{},"644":{},"645":{},"646":{}},"description":{"643":{},"644":{},"645":{},"646":{}}}],["nginxcach",{"_index":1614,"title":{"642":{}},"description":{"642":{}}}],["nginxcaching/clear_cach",{"_index":1618,"title":{},"description":{"644":{}}}],["nginxcaching/disable_cach",{"_index":1620,"title":{},"description":{"646":{}}}],["nginxcaching/enable_cach",{"_index":1617,"title":{},"description":{"643":{}}}],["nginxcaching/reset_cache_config",{"_index":1619,"title":{},"description":{"645":{}}}],["node",{"_index":245,"title":{},"description":{"66":{}}}],["non-ded",{"_index":1495,"title":{},"description":{"577":{}}}],["non-utf-8",{"_index":1115,"title":{},"description":{"412":{}}}],["note",{"_index":14,"title":{"100":{},"446":{},"448":{}},"description":{"1":{},"6":{},"66":{},"69":{},"70":{},"76":{},"77":{},"78":{},"83":{},"91":{},"96":{},"100":{},"103":{},"113":{},"116":{},"117":{},"118":{},"119":{},"129":{},"136":{},"137":{},"169":{},"176":{},"193":{},"194":{},"196":{},"207":{},"208":{},"210":{},"222":{},"223":{},"230":{},"245":{},"249":{},"257":{},"258":{},"259":{},"270":{},"283":{},"284":{},"286":{},"288":{},"290":{},"293":{},"294":{},"295":{},"296":{},"298":{},"313":{},"329":{},"340":{},"341":{},"346":{},"347":{},"348":{},"363":{},"378":{},"380":{},"385":{},"412":{},"417":{},"429":{},"446":{},"448":{},"465":{},"466":{},"467":{},"468":{},"469":{},"470":{},"485":{},"486":{},"487":{},"488":{},"489":{},"495":{},"496":{},"497":{},"498":{},"499":{},"500":{},"501":{},"502":{},"503":{},"505":{},"506":{},"507":{},"508":{},"509":{},"510":{},"511":{},"512":{},"513":{},"514":{},"515":{},"534":{},"555":{},"556":{},"567":{},"572":{},"573":{},"574":{},"588":{},"591":{},"592":{},"594":{},"595":{},"596":{},"597":{},"600":{},"605":{},"607":{},"609":{},"616":{},"620":{},"628":{},"632":{},"634":{},"643":{},"644":{},"645":{},"646":{},"648":{},"649":{},"650":{},"651":{},"653":{},"654":{},"655":{},"656":{},"657":{},"658":{},"668":{},"672":{},"678":{},"679":{},"680":{}}}],["notif",{"_index":994,"title":{"547":{},"548":{}},"description":{"353":{},"354":{},"359":{},"362":{},"547":{},"548":{}}}],["notifications/get_notifications_count",{"_index":1433,"title":{},"description":{"548":{}}}],["nsec",{"_index":541,"title":{"167":{}},"description":{"167":{}}}],["nsec3",{"_index":546,"title":{"177":{}},"description":{"167":{},"177":{}}}],["null",{"_index":1042,"title":{},"description":{"378":{},"379":{},"380":{}}}],["number",{"_index":367,"title":{"102":{}},"description":{"102":{},"156":{},"164":{},"225":{},"226":{},"261":{},"269":{},"276":{},"310":{},"548":{}}}],["nvdata",{"_index":252,"title":{"69":{},"70":{},"463":{}},"description":{"69":{},"70":{},"463":{}}}],["object",{"_index":189,"title":{},"description":{"38":{},"514":{}}}],["obtain",{"_index":611,"title":{},"description":{"195":{},"649":{}}}],["occupi",{"_index":532,"title":{},"description":{"156":{},"164":{}}}],["occur",{"_index":654,"title":{},"description":{"208":{},"429":{}}}],["octet",{"_index":528,"title":{},"description":{"155":{},"163":{}}}],["old",{"_index":1209,"title":{},"description":{"442":{}}}],["on",{"_index":68,"title":{},"description":{"8":{},"9":{},"76":{},"77":{},"78":{},"83":{},"94":{},"117":{},"118":{},"119":{},"191":{},"193":{},"194":{},"198":{},"199":{},"200":{},"201":{},"269":{},"313":{},"378":{},"414":{},"424":{},"426":{},"528":{},"584":{},"668":{}}}],["one-tim",{"_index":915,"title":{"313":{}},"description":{"313":{}}}],["oper",{"_index":1304,"title":{"481":{}},"description":{"514":{}}}],["opt1",{"_index":794,"title":{},"description":{"269":{}}}],["opt2",{"_index":801,"title":{},"description":{"269":{}}}],["option",{"_index":213,"title":{"47":{},"60":{},"320":{}},"description":{"78":{},"320":{},"424":{},"429":{},"464":{},"469":{},"471":{},"484":{},"490":{},"494":{},"504":{},"658":{}}}],["order",{"_index":39,"title":{"6":{},"37":{},"42":{},"268":{}},"description":{"6":{},"8":{},"9":{},"30":{},"37":{},"42":{},"268":{},"429":{},"465":{},"466":{},"467":{},"468":{},"469":{},"470":{}}}],["origin",{"_index":401,"title":{},"description":{"115":{},"406":{},"442":{}}}],["other",{"_index":610,"title":{},"description":{"195":{}}}],["otp",{"_index":916,"title":{},"description":{"313":{}}}],["out",{"_index":175,"title":{},"description":{"34":{},"514":{}}}],["outbound",{"_index":698,"title":{},"description":{"227":{},"237":{}}}],["outgo",{"_index":697,"title":{"227":{},"230":{},"237":{},"249":{},"296":{},"298":{},"300":{},"301":{}},"description":{"230":{},"249":{},"296":{},"298":{}}}],["output",{"_index":471,"title":{},"description":{"135":{},"155":{},"163":{},"207":{},"209":{},"210":{},"502":{},"678":{}}}],["overrid",{"_index":447,"title":{"128":{},"129":{}},"description":{}}],["own",{"_index":1484,"title":{},"description":{"571":{},"678":{},"679":{}}}],["owner",{"_index":342,"title":{},"description":{"91":{},"96":{},"103":{},"678":{}}}],["ownership",{"_index":1562,"title":{"610":{},"611":{},"612":{},"613":{}},"description":{"610":{}}}],["packag",{"_index":1574,"title":{},"description":{"616":{},"643":{},"644":{},"645":{},"646":{}}}],["page",{"_index":441,"title":{},"description":{"126":{},"465":{}}}],["pair",{"_index":932,"title":{"323":{}},"description":{"323":{}}}],["paramet",{"_index":299,"title":{},"description":{"78":{},"83":{},"116":{},"117":{},"118":{},"119":{},"223":{},"269":{},"429":{},"570":{},"572":{},"574":{},"595":{},"596":{},"597":{},"599":{},"602":{},"603":{},"605":{},"607":{},"668":{}}}],["parent",{"_index":243,"title":{},"description":{"66":{}}}],["park",{"_index":659,"title":{},"description":{"209":{}}}],["pars",{"_index":91,"title":{"10":{},"155":{},"163":{}},"description":{"10":{},"155":{},"163":{}}}],["parser/firstfile_relative_uri",{"_index":103,"title":{},"description":{"12":{}}}],["part",{"_index":413,"title":{},"description":{"117":{},"118":{},"119":{}}}],["part1",{"_index":795,"title":{},"description":{"269":{}}}],["part2",{"_index":802,"title":{},"description":{"269":{}}}],["particular",{"_index":1202,"title":{},"description":{"439":{}}}],["pass",{"_index":408,"title":{},"description":{"116":{},"444":{},"611":{},"612":{},"613":{},"668":{}}}],["passeng",{"_index":1594,"title":{"628":{},"629":{},"630":{},"631":{},"632":{},"633":{},"634":{}},"description":{"628":{},"629":{},"630":{},"631":{},"632":{},"633":{},"634":{}}}],["passengerapps/disable_appl",{"_index":1596,"title":{},"description":{"629":{}}}],["passengerapps/edit_appl",{"_index":1595,"title":{},"description":{"628":{}}}],["passengerapps/enable_appl",{"_index":1597,"title":{},"description":{"630":{}}}],["passengerapps/ensure_dep",{"_index":1600,"title":{},"description":{"632":{}}}],["passengerapps/list_appl",{"_index":1598,"title":{},"description":{"631":{}}}],["passengerapps/register_appl",{"_index":1603,"title":{},"description":{"633":{}}}],["passengerapps/unregister_appl",{"_index":1605,"title":{},"description":{"634":{}}}],["passwdstrength/get_required_strength",{"_index":1435,"title":{},"description":{"550":{}}}],["password",{"_index":226,"title":{"55":{},"92":{},"94":{},"106":{},"143":{},"248":{},"252":{},"313":{},"316":{},"389":{},"420":{},"460":{},"505":{},"528":{},"530":{},"549":{},"550":{}},"description":{"55":{},"92":{},"94":{},"106":{},"143":{},"146":{},"224":{},"248":{},"252":{},"313":{},"316":{},"378":{},"389":{},"420":{},"460":{},"505":{},"528":{},"530":{},"549":{},"550":{}}}],["password-protect",{"_index":493,"title":{},"description":{"144":{}}}],["path",{"_index":1180,"title":{"654":{}},"description":{"431":{},"465":{},"514":{},"654":{}}}],["payload’",{"_index":1119,"title":{},"description":{"412":{}}}],["pdn",{"_index":511,"title":{},"description":{"153":{},"161":{}}}],["pem)](https://en.wikipedia.org/wiki/privacy-enhanced_mail",{"_index":608,"title":{},"description":{"195":{}}}],["pend",{"_index":171,"title":{"33":{},"39":{},"43":{}},"description":{"33":{},"37":{},"39":{},"43":{}}}],["per-account",{"_index":253,"title":{},"description":{"69":{},"70":{}}}],["perform",{"_index":42,"title":{"481":{}},"description":{"6":{},"374":{},"442":{}}}],["period",{"_index":1415,"title":{"535":{}},"description":{"535":{}}}],["perl5",{"_index":1185,"title":{},"description":{"431":{}}}],["perman",{"_index":1174,"title":{},"description":{"430":{}}}],["permiss",{"_index":652,"title":{"422":{}},"description":{"208":{},"296":{},"422":{},"679":{}}}],["permit",{"_index":1257,"title":{},"description":{"465":{}}}],["persist",{"_index":257,"title":{},"description":{"69":{},"70":{}}}],["person",{"_index":251,"title":{"68":{}},"description":{"68":{}}}],["personalization/get",{"_index":269,"title":{},"description":{"69":{}}}],["personalization/set",{"_index":270,"title":{},"description":{"70":{}}}],["php",{"_index":1592,"title":{"625":{},"626":{},"647":{},"648":{},"649":{},"650":{},"652":{},"653":{},"655":{},"657":{},"658":{}},"description":{"625":{},"626":{},"647":{},"648":{},"649":{},"650":{},"652":{},"653":{},"655":{},"657":{},"658":{},"672":{}}}],["php-fpm",{"_index":1659,"title":{},"description":{"672":{}}}],["php.ini",{"_index":1626,"title":{"651":{},"654":{},"656":{}},"description":{"651":{},"654":{},"656":{}}}],["phppgadmin",{"_index":1391,"title":{},"description":{"523":{}}}],["place",{"_index":707,"title":{},"description":{"230":{},"298":{}}}],["plaintext",{"_index":854,"title":{"289":{}},"description":{"289":{}}}],["plu",{"_index":832,"title":{},"description":{"283":{},"284":{},"288":{}}}],["plugin",{"_index":261,"title":{"508":{}},"description":{"69":{},"70":{},"286":{},"381":{},"485":{},"486":{},"487":{},"488":{},"489":{},"495":{},"496":{},"497":{},"498":{},"499":{},"500":{},"501":{},"502":{},"503":{},"505":{},"506":{},"507":{},"508":{},"509":{},"510":{},"511":{},"512":{},"513":{},"514":{},"515":{}}}],["plugin'",{"_index":1346,"title":{},"description":{"508":{}}}],["plugins*](https://go.cpanel.net/whmdocsmanageplugin",{"_index":848,"title":{},"description":{"286":{}}}],["point",{"_index":628,"title":{},"description":{"199":{},"545":{}}}],["pointer",{"_index":625,"title":{},"description":{"199":{}}}],["polici",{"_index":620,"title":{},"description":{"197":{},"201":{}}}],["poll",{"_index":180,"title":{},"description":{"37":{},"39":{}}}],["pop3",{"_index":765,"title":{"259":{}},"description":{"259":{}}}],["popul",{"_index":1358,"title":{},"description":{"514":{}}}],["port",{"_index":886,"title":{"300":{},"301":{},"398":{},"552":{}},"description":{"300":{},"301":{},"398":{},"552":{}}}],["possess",{"_index":650,"title":{},"description":{"208":{},"560":{},"577":{}}}],["possibl",{"_index":520,"title":{},"description":{"155":{},"163":{},"220":{}}}],["post",{"_index":52,"title":{},"description":{"6":{},"117":{},"119":{},"378":{},"379":{},"380":{},"573":{},"608":{},"609":{}}}],["postgr",{"_index":1381,"title":{},"description":{"519":{},"520":{},"530":{}}}],["postgresql",{"_index":1378,"title":{"516":{},"517":{},"518":{},"519":{},"520":{},"521":{},"522":{},"523":{},"524":{},"525":{},"526":{},"527":{},"528":{},"529":{},"530":{},"531":{}},"description":{"516":{},"517":{},"518":{},"519":{},"520":{},"521":{},"522":{},"523":{},"524":{},"525":{},"526":{},"527":{},"528":{},"529":{},"530":{},"531":{}}}],["postgresql/create_databas",{"_index":1379,"title":{},"description":{"517":{}}}],["postgresql/create_us",{"_index":1399,"title":{},"description":{"524":{}}}],["postgresql/delete_databas",{"_index":1382,"title":{},"description":{"519":{}}}],["postgresql/delete_us",{"_index":1400,"title":{},"description":{"525":{}}}],["postgresql/get_restrict",{"_index":1380,"title":{},"description":{"518":{}}}],["postgresql/grant_all_privileg",{"_index":1401,"title":{},"description":{"526":{}}}],["postgresql/list_databas",{"_index":1383,"title":{},"description":{"520":{}}}],["postgresql/list_us",{"_index":1402,"title":{},"description":{"527":{}}}],["postgresql/rename_databas",{"_index":1384,"title":{},"description":{"521":{}}}],["postgresql/rename_us",{"_index":1408,"title":{},"description":{"531":{}}}],["postgresql/rename_user_no_password",{"_index":1405,"title":{},"description":{"528":{}}}],["postgresql/revoke_all_privileg",{"_index":1406,"title":{},"description":{"529":{}}}],["postgresql/set_password",{"_index":1407,"title":{},"description":{"530":{}}}],["postgresql/update_privileg",{"_index":1398,"title":{},"description":{"523":{}}}],["postgresql::rename_us",{"_index":1404,"title":{},"description":{"528":{}}}],["potenti",{"_index":47,"title":{},"description":{"6":{},"442":{}}}],["power",{"_index":843,"title":{},"description":{"286":{}}}],["powerdn",{"_index":510,"title":{},"description":{"153":{},"161":{}}}],["prefer",{"_index":296,"title":{},"description":{"78":{},"585":{}}}],["prefix",{"_index":1239,"title":{},"description":{"453":{}}}],["prepend",{"_index":1097,"title":{},"description":{"406":{}}}],["present",{"_index":1533,"title":{},"description":{"594":{}}}],["prevent",{"_index":873,"title":{"349":{}},"description":{"294":{},"296":{},"349":{}}}],["previou",{"_index":571,"title":{},"description":{"175":{},"497":{}}}],["previous",{"_index":1013,"title":{},"description":{"363":{},"470":{},"563":{}}}],["primari",{"_index":349,"title":{"236":{},"238":{}},"description":{"93":{},"604":{},"674":{},"676":{}}}],["privaci",{"_index":489,"title":{"142":{},"145":{},"320":{}},"description":{"142":{},"145":{},"320":{}}}],["privacy-enhanc",{"_index":607,"title":{},"description":{"195":{}}}],["privat",{"_index":388,"title":{"194":{},"195":{},"572":{},"573":{},"574":{},"580":{},"596":{},"599":{},"603":{},"606":{},"609":{}},"description":{"109":{},"195":{},"569":{},"572":{},"573":{},"574":{},"580":{},"595":{},"596":{},"599":{},"606":{},"609":{}}}],["privileg",{"_index":344,"title":{"317":{},"319":{},"436":{},"457":{},"458":{},"459":{},"523":{},"526":{},"529":{}},"description":{"91":{},"96":{},"103":{},"309":{},"317":{},"319":{},"436":{},"457":{},"458":{},"459":{},"523":{},"526":{},"529":{}}}],["problem",{"_index":1456,"title":{"560":{}},"description":{"560":{},"594":{}}}],["process",{"_index":63,"title":{"43":{},"470":{}},"description":{"8":{},"9":{},"38":{},"43":{},"442":{},"470":{},"506":{},"512":{},"632":{}}}],["product",{"_index":155,"title":{"29":{}},"description":{"29":{},"477":{}}}],["profil",{"_index":1073,"title":{},"description":{"392":{},"415":{},"620":{},"621":{},"648":{}}}],["profiles](https://go.cpanel.net/howtouseserverprofil",{"_index":771,"title":{},"description":{"261":{},"274":{}}}],["proftpd",{"_index":1088,"title":{"402":{}},"description":{"402":{}}}],["progress",{"_index":1280,"title":{"561":{}},"description":{"470":{},"502":{},"561":{}}}],["protect",{"_index":490,"title":{"143":{},"144":{},"146":{},"147":{},"148":{},"149":{},"150":{},"202":{},"203":{},"204":{},"205":{},"464":{}},"description":{"143":{},"146":{},"147":{},"148":{},"149":{},"195":{},"202":{},"203":{},"204":{},"205":{},"464":{}}}],["protection](https://go.cpanel.net/cpaneldocsleechprotect",{"_index":500,"title":{},"description":{"150":{}}}],["protocol",{"_index":379,"title":{},"description":{"106":{},"107":{},"109":{},"533":{}}}],["provid",{"_index":111,"title":{"15":{},"32":{}},"description":{"15":{},"17":{},"29":{},"31":{},"32":{},"34":{},"35":{},"39":{},"40":{},"42":{},"47":{},"60":{},"222":{},"340":{},"341":{},"514":{},"620":{},"658":{}}}],["provider'",{"_index":154,"title":{"29":{},"31":{},"38":{},"39":{},"40":{},"41":{}},"description":{"41":{}}}],["proxi",{"_index":1439,"title":{"554":{},"555":{},"556":{}},"description":{"555":{},"556":{}}}],["proxying](https://go.cpanel.net/serviceproxi",{"_index":1441,"title":{},"description":{"554":{},"555":{},"556":{}}}],["prune_arch",{"_index":1654,"title":{},"description":{"668":{}}}],["ptr",{"_index":624,"title":{"199":{}},"description":{"199":{}}}],["public",{"_index":935,"title":{"324":{},"327":{}},"description":{"324":{},"327":{},"540":{},"663":{}}}],["publish",{"_index":1663,"title":{"677":{},"678":{},"679":{},"680":{}},"description":{"677":{},"679":{},"680":{}}}],["publisher](https://go.cpanel.net/cpaneldocssitepublish",{"_index":1664,"title":{},"description":{"678":{},"679":{},"680":{}}}],["pull",{"_index":1144,"title":{},"description":{"424":{},"429":{}}}],["purchas",{"_index":675,"title":{"220":{}},"description":{"220":{}}}],["pure-ftpd",{"_index":1089,"title":{"402":{}},"description":{"402":{}}}],["purg",{"_index":1110,"title":{},"description":{"411":{}}}],["pushbullet",{"_index":1250,"title":{"461":{},"462":{}},"description":{"461":{},"462":{}}}],["pushbullet/send_test_messag",{"_index":1252,"title":{},"description":{"462":{}}}],["put",{"_index":883,"title":{},"description":{"298":{}}}],["qualifi",{"_index":1483,"title":{},"description":{"571":{}}}],["queri",{"_index":420,"title":{},"description":{"117":{},"118":{},"119":{},"209":{},"534":{},"680":{}}}],["query-str",{"_index":460,"title":{},"description":{"129":{}}}],["queu",{"_index":1009,"title":{"361":{}},"description":{"470":{}}}],["queue",{"_index":61,"title":{"8":{},"9":{},"33":{},"352":{},"355":{},"369":{}},"description":{"8":{},"9":{},"33":{},"43":{},"227":{},"230":{},"237":{},"249":{},"296":{},"352":{},"355":{},"361":{},"363":{},"369":{},"374":{},"465":{},"466":{},"467":{},"468":{},"469":{},"470":{}}}],["queue'",{"_index":201,"title":{"43":{}},"description":{}}],["quota",{"_index":236,"title":{"65":{},"66":{},"67":{},"228":{},"233":{},"235":{},"239":{},"240":{},"241":{},"386":{},"391":{}},"description":{"65":{},"66":{},"67":{},"228":{},"233":{},"235":{},"239":{},"240":{},"241":{},"386":{},"391":{},"444":{}}}],["quota/get_local_quota_info",{"_index":249,"title":{},"description":{"66":{}}}],["quota/get_quota_info",{"_index":250,"title":{},"description":{"67":{}}}],["quota::get_quota",{"_index":247,"title":{},"description":{"66":{}}}],["random",{"_index":449,"title":{},"description":{"128":{}}}],["randomli",{"_index":1222,"title":{"444":{}},"description":{"444":{}}}],["randomly-gener",{"_index":584,"title":{},"description":{"183":{}}}],["rare",{"_index":1216,"title":{},"description":{"442":{}}}],["re-creat",{"_index":554,"title":{},"description":{"169":{},"176":{}}}],["read",{"_index":84,"title":{},"description":{"8":{},"9":{},"117":{},"119":{},"136":{},"137":{},"153":{},"161":{},"186":{},"187":{},"188":{},"261":{},"265":{},"268":{},"269":{},"270":{},"274":{},"286":{},"293":{},"340":{},"341":{},"346":{},"347":{},"348":{},"392":{},"415":{},"417":{},"424":{},"425":{},"426":{},"428":{},"429":{},"430":{},"431":{},"506":{},"512":{},"514":{},"594":{},"620":{},"621":{},"633":{},"648":{},"679":{},"680":{}}}],["reason",{"_index":330,"title":{},"description":{"89":{},"90":{},"207":{},"210":{},"573":{},"608":{},"609":{}}}],["rebuild",{"_index":1444,"title":{"583":{},"592":{}},"description":{"555":{},"556":{},"583":{},"592":{}}}],["rebuild_mail_sni_config",{"_index":1522,"title":{},"description":{"588":{}}}],["receiv",{"_index":411,"title":{},"description":{"117":{},"118":{},"186":{},"187":{},"222":{},"223":{},"224":{},"225":{},"226":{},"227":{},"229":{},"231":{},"232":{},"233":{},"234":{},"235":{},"236":{},"237":{},"238":{},"239":{},"240":{},"241":{},"243":{},"244":{},"245":{},"246":{},"247":{},"248":{},"250":{},"252":{},"253":{},"254":{},"255":{},"261":{},"262":{},"263":{},"264":{},"265":{},"266":{},"267":{},"269":{},"270":{},"271":{},"273":{},"275":{},"276":{},"277":{},"278":{},"279":{},"280":{},"282":{},"283":{},"284":{},"285":{},"286":{},"287":{},"288":{},"289":{},"291":{},"293":{},"294":{},"295":{},"297":{},"309":{},"310":{},"312":{},"313":{},"314":{},"315":{},"317":{},"320":{},"321":{},"339":{},"350":{},"351":{},"352":{},"353":{},"354":{},"355":{},"356":{},"357":{},"358":{},"359":{},"361":{},"362":{},"363":{},"364":{},"365":{},"366":{},"367":{},"368":{},"369":{},"370":{},"371":{},"372":{},"373":{},"374":{},"376":{},"462":{},"558":{},"560":{},"561":{},"562":{},"563":{},"564":{},"567":{},"569":{},"570":{},"575":{},"579":{},"580":{},"581":{},"582":{},"587":{},"589":{},"590":{},"594":{},"595":{},"596":{},"597":{},"598":{},"599":{},"600":{},"601":{},"602":{},"603":{},"604":{},"605":{},"606":{},"607":{},"608":{},"609":{}}}],["recent",{"_index":1350,"title":{},"description":{"509":{},"511":{},"542":{}}}],["recommend",{"_index":49,"title":{"623":{},"626":{}},"description":{"6":{},"195":{},"196":{},"224":{},"412":{},"442":{},"528":{},"623":{},"625":{},"626":{}}}],["record",{"_index":508,"title":{"153":{},"161":{},"171":{},"172":{},"186":{},"187":{},"188":{},"189":{},"190":{},"191":{},"192":{},"193":{},"196":{},"197":{},"198":{},"199":{},"200":{},"201":{}},"description":{"153":{},"156":{},"158":{},"161":{},"164":{},"165":{},"167":{},"169":{},"171":{},"172":{},"175":{},"176":{},"177":{},"186":{},"187":{},"188":{},"189":{},"190":{},"191":{},"192":{},"193":{},"196":{},"197":{},"198":{},"199":{},"200":{},"201":{},"470":{},"616":{}}}],["record](https://tools.ietf.org/html/rfc4470",{"_index":543,"title":{},"description":{"167":{}}}],["recov",{"_index":1176,"title":{},"description":{"430":{}}}],["recreat",{"_index":1201,"title":{},"description":{"439":{},"442":{}}}],["recurs",{"_index":1389,"title":{},"description":{"523":{}}}],["redirect",{"_index":637,"title":{"211":{},"212":{},"213":{},"214":{},"215":{},"257":{},"258":{},"566":{},"584":{},"663":{}},"description":{"204":{},"211":{},"212":{},"213":{},"214":{},"215":{},"257":{},"258":{},"566":{},"584":{},"663":{}}}],["refer",{"_index":640,"title":{},"description":{"204":{}}}],["reflect",{"_index":1349,"title":{},"description":{"509":{},"511":{}}}],["regist",{"_index":313,"title":{"83":{},"633":{}},"description":{"514":{},"537":{},"633":{}}}],["register-fail",{"_index":1369,"title":{},"description":{"514":{}}}],["register-load-fail",{"_index":1372,"title":{},"description":{"514":{}}}],["registrar",{"_index":552,"title":{},"description":{"169":{},"175":{},"176":{}}}],["registri",{"_index":1371,"title":{},"description":{"514":{}}}],["reinstat",{"_index":327,"title":{"89":{}},"description":{"89":{}}}],["reject",{"_index":706,"title":{},"description":{"230":{},"293":{},"296":{},"298":{}}}],["rel",{"_index":96,"title":{"12":{}},"description":{"12":{}}}],["releas",{"_index":1326,"title":{},"description":{"497":{}}}],["remot",{"_index":376,"title":{"445":{},"446":{},"447":{},"448":{},"449":{}},"description":{"106":{},"107":{},"109":{},"424":{},"426":{},"429":{},"433":{},"434":{},"436":{},"437":{},"438":{},"439":{},"440":{},"441":{},"442":{},"443":{},"444":{},"445":{},"446":{},"447":{},"448":{},"449":{},"451":{},"452":{},"453":{},"454":{},"455":{},"456":{},"457":{},"458":{},"459":{},"460":{}}}],["remov",{"_index":32,"title":{"4":{},"8":{},"17":{},"24":{},"27":{},"78":{},"95":{},"104":{},"173":{},"190":{},"200":{},"213":{},"258":{},"319":{},"458":{},"482":{},"485":{},"506":{},"529":{},"555":{},"567":{},"661":{},"671":{}},"description":{"4":{},"17":{},"24":{},"37":{},"78":{},"89":{},"95":{},"104":{},"156":{},"164":{},"173":{},"175":{},"190":{},"200":{},"203":{},"213":{},"257":{},"258":{},"294":{},"319":{},"449":{},"482":{},"485":{},"538":{},"555":{},"556":{},"567":{},"671":{}}}],["renam",{"_index":29,"title":{},"description":{"3":{},"442":{},"456":{},"521":{},"528":{},"531":{}}}],["render",{"_index":1281,"title":{},"description":{"470":{}}}],["repair",{"_index":1220,"title":{"443":{}},"description":{"443":{}}}],["replac",{"_index":338,"title":{},"description":{"90":{},"94":{},"100":{},"157":{},"194":{},"563":{}}}],["report",{"_index":98,"title":{"534":{}},"description":{"12":{},"465":{},"466":{},"467":{},"468":{},"469":{},"470":{},"512":{},"534":{},"554":{}}}],["repositori",{"_index":79,"title":{"427":{},"428":{},"429":{},"430":{},"431":{}},"description":{"8":{},"9":{},"424":{},"426":{},"427":{},"428":{},"429":{},"430":{},"431":{}}}],["repository'",{"_index":1170,"title":{},"description":{"429":{}}}],["repository_root",{"_index":1172,"title":{},"description":{"429":{}}}],["repres",{"_index":645,"title":{},"description":{"207":{},"208":{},"209":{},"210":{},"378":{},"379":{},"380":{},"424":{},"426":{},"428":{},"514":{},"678":{},"679":{}}}],["request",{"_index":182,"title":{"38":{},"42":{},"78":{},"92":{},"468":{},"470":{},"569":{},"574":{},"576":{},"582":{},"595":{},"600":{},"607":{}},"description":{"38":{},"42":{},"43":{},"92":{},"117":{},"118":{},"119":{},"286":{},"574":{},"582":{},"595":{},"596":{},"600":{},"607":{},"611":{},"612":{}}}],["request'",{"_index":1553,"title":{"602":{}},"description":{"602":{}}}],["requir",{"_index":196,"title":{"41":{},"550":{}},"description":{"41":{},"194":{},"340":{},"341":{},"378":{},"381":{},"424":{},"426":{},"528":{},"550":{},"594":{},"600":{},"616":{}}}],["rescan",{"_index":846,"title":{},"description":{"286":{}}}],["resel",{"_index":1586,"title":{},"description":{"621":{},"658":{},"678":{},"679":{}}}],["reseller'",{"_index":223,"title":{"52":{}},"description":{"52":{},"113":{},"678":{},"679":{}}}],["resellers/list_account",{"_index":224,"title":{},"description":{"52":{}}}],["resembl",{"_index":1045,"title":{},"description":{"378":{},"379":{},"380":{}}}],["reset",{"_index":346,"title":{"92":{},"645":{}},"description":{"92":{},"224":{},"645":{}}}],["resiz",{"_index":1103,"title":{"408":{}},"description":{"408":{}}}],["resolv",{"_index":503,"title":{"152":{},"153":{},"160":{},"161":{}},"description":{"152":{},"153":{},"160":{},"161":{}}}],["resourc",{"_index":271,"title":{"71":{},"72":{}},"description":{"71":{},"72":{},"129":{},"497":{},"503":{}}}],["resourceusage/get_usag",{"_index":274,"title":{},"description":{"72":{}}}],["respect",{"_index":268,"title":{},"description":{"69":{},"70":{}}}],["respons",{"_index":1213,"title":{},"description":{"442":{}}}],["restart",{"_index":1446,"title":{},"description":{"555":{},"556":{}}}],["restor",{"_index":391,"title":{"111":{},"115":{},"116":{},"117":{},"118":{},"119":{},"358":{},"501":{},"502":{},"503":{}},"description":{"111":{},"115":{},"116":{},"117":{},"118":{},"119":{},"295":{},"358":{},"442":{},"501":{},"502":{},"503":{}}}],["restore/directory_list",{"_index":393,"title":{},"description":{"112":{}}}],["restore/get_us",{"_index":394,"title":{},"description":{"113":{}}}],["restore/query_file_info",{"_index":399,"title":{},"description":{"114":{}}}],["restore/restore_fil",{"_index":402,"title":{},"description":{"115":{}}}],["restrict",{"_index":1164,"title":{"453":{},"518":{}},"description":{"428":{},"453":{},"518":{}}}],["result",{"_index":340,"title":{"512":{}},"description":{"91":{},"96":{},"103":{},"512":{}}}],["result{data}{detail",{"_index":1283,"title":{},"description":{"470":{}}}],["retent",{"_index":1414,"title":{"535":{}},"description":{"535":{}}}],["retention_day",{"_index":1655,"title":{},"description":{"668":{}}}],["retriev",{"_index":88,"title":{"69":{},"666":{}},"description":{"9":{},"21":{},"22":{},"31":{},"40":{},"53":{},"66":{},"67":{},"69":{},"72":{},"73":{},"121":{},"122":{},"123":{},"124":{},"133":{},"175":{},"198":{},"199":{},"201":{},"207":{},"209":{},"210":{},"214":{},"231":{},"232":{},"233":{},"234":{},"235":{},"239":{},"240":{},"241":{},"242":{},"244":{},"264":{},"267":{},"300":{},"343":{},"353":{},"354":{},"356":{},"363":{},"364":{},"365":{},"366":{},"387":{},"397":{},"412":{},"426":{},"498":{},"508":{},"509":{},"511":{},"518":{},"535":{},"543":{},"546":{},"550":{},"552":{},"560":{},"569":{},"570":{},"571":{},"572":{},"574":{},"575":{},"576":{},"577":{},"578":{},"591":{},"605":{},"606":{},"607":{},"616":{},"623":{},"663":{},"666":{},"674":{},"680":{}}}],["return",{"_index":23,"title":{"2":{},"9":{},"11":{},"12":{},"15":{},"16":{},"18":{},"21":{},"22":{},"29":{},"31":{},"32":{},"38":{},"39":{},"40":{},"41":{},"47":{},"49":{},"52":{},"53":{},"60":{},"63":{},"64":{},"66":{},"67":{},"72":{},"73":{},"77":{},"79":{},"81":{},"84":{},"110":{},"112":{},"113":{},"114":{},"121":{},"122":{},"123":{},"124":{},"126":{},"129":{},"132":{},"133":{},"135":{},"137":{},"139":{},"140":{},"143":{},"144":{},"145":{},"150":{},"152":{},"153":{},"154":{},"155":{},"158":{},"160":{},"161":{},"162":{},"163":{},"165":{},"172":{},"181":{},"192":{},"195":{},"205":{},"207":{},"208":{},"209":{},"210":{},"214":{},"215":{},"219":{},"220":{},"222":{},"223":{},"225":{},"226":{},"231":{},"232":{},"233":{},"234":{},"235":{},"236":{},"237":{},"238":{},"239":{},"240":{},"241":{},"242":{},"243":{},"244":{},"245":{},"246":{},"247":{},"261":{},"264":{},"265":{},"266":{},"267":{},"276":{},"278":{},"279":{},"280":{},"282":{},"285":{},"287":{},"288":{},"289":{},"291":{},"300":{},"301":{},"303":{},"306":{},"310":{},"314":{},"315":{},"317":{},"318":{},"327":{},"328":{},"331":{},"335":{},"343":{},"345":{},"347":{},"353":{},"354":{},"355":{},"356":{},"361":{},"364":{},"365":{},"366":{},"367":{},"368":{},"370":{},"376":{},"385":{},"386":{},"387":{},"388":{},"392":{},"395":{},"396":{},"397":{},"398":{},"400":{},"402":{},"407":{},"410":{},"412":{},"413":{},"415":{},"426":{},"431":{},"433":{},"434":{},"439":{},"441":{},"448":{},"453":{},"454":{},"455":{},"457":{},"465":{},"467":{},"473":{},"475":{},"476":{},"477":{},"491":{},"492":{},"493":{},"496":{},"498":{},"499":{},"502":{},"508":{},"509":{},"510":{},"511":{},"512":{},"518":{},"520":{},"527":{},"533":{},"534":{},"535":{},"542":{},"543":{},"545":{},"546":{},"548":{},"550":{},"552":{},"554":{},"559":{},"560":{},"561":{},"566":{},"568":{},"570":{},"571":{},"572":{},"573":{},"574":{},"575":{},"577":{},"578":{},"579":{},"580":{},"581":{},"582":{},"589":{},"590":{},"591":{},"615":{},"616":{},"617":{},"618":{},"620":{},"631":{},"640":{},"641":{},"648":{},"649":{},"650":{},"651":{},"652":{},"653":{},"654":{},"658":{},"662":{},"663":{},"667":{},"672":{},"674":{},"678":{},"680":{}},"description":{"2":{},"11":{},"35":{},"38":{},"41":{},"50":{},"76":{},"77":{},"102":{},"126":{},"129":{},"135":{},"139":{},"140":{},"144":{},"145":{},"150":{},"153":{},"154":{},"161":{},"162":{},"195":{},"207":{},"208":{},"209":{},"210":{},"222":{},"223":{},"225":{},"226":{},"236":{},"237":{},"238":{},"245":{},"261":{},"276":{},"291":{},"310":{},"314":{},"335":{},"346":{},"347":{},"355":{},"361":{},"367":{},"378":{},"379":{},"380":{},"385":{},"398":{},"407":{},"410":{},"412":{},"413":{},"415":{},"433":{},"434":{},"439":{},"442":{},"448":{},"454":{},"470":{},"475":{},"477":{},"502":{},"507":{},"510":{},"514":{},"533":{},"534":{},"542":{},"545":{},"548":{},"555":{},"556":{},"615":{},"616":{},"618":{},"620":{},"626":{},"641":{},"648":{},"651":{},"658":{},"667":{}}}],["revok",{"_index":1246,"title":{},"description":{"458":{},"529":{}}}],["role",{"_index":147,"title":{"85":{},"86":{},"91":{},"95":{},"102":{},"103":{}},"description":{"26":{},"27":{},"85":{},"86":{},"91":{},"95":{},"102":{},"103":{},"168":{},"203":{},"205":{},"233":{},"235":{},"238":{},"239":{},"241":{},"264":{},"270":{},"274":{},"315":{},"316":{},"341":{},"350":{},"351":{},"355":{},"358":{},"363":{},"365":{},"366":{},"369":{},"370":{},"371":{},"372":{},"374":{},"412":{},"413":{},"417":{},"555":{},"556":{},"620":{},"621":{},"660":{},"670":{},"679":{}}}],["role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#rol",{"_index":787,"title":{},"description":{"269":{},"352":{},"367":{},"368":{},"405":{},"407":{},"408":{},"411":{}}}],["role](https://go.cpanel.net/howtouseserverprofiles#rol",{"_index":407,"title":{},"description":{"116":{},"117":{},"118":{},"119":{},"177":{},"240":{},"290":{},"357":{},"360":{},"376":{},"392":{},"396":{},"410":{},"415":{},"416":{},"438":{},"444":{},"517":{},"526":{},"630":{},"648":{},"649":{},"650":{},"651":{},"653":{},"654":{},"656":{},"657":{},"658":{},"680":{}}}],["role](https://go.cpanel.net/serverol",{"_index":1135,"title":{},"description":{"421":{}}}],["role](https://go.cpanel.net/serverrol",{"_index":392,"title":{},"description":{"112":{},"113":{},"167":{},"169":{},"170":{},"171":{},"172":{},"173":{},"174":{},"175":{},"176":{},"178":{},"180":{},"181":{},"182":{},"183":{},"184":{},"186":{},"187":{},"188":{},"192":{},"204":{},"212":{},"222":{},"224":{},"227":{},"229":{},"231":{},"232":{},"234":{},"236":{},"237":{},"242":{},"243":{},"244":{},"245":{},"246":{},"247":{},"248":{},"250":{},"252":{},"254":{},"255":{},"261":{},"262":{},"263":{},"265":{},"266":{},"267":{},"268":{},"271":{},"273":{},"275":{},"277":{},"278":{},"279":{},"280":{},"285":{},"286":{},"287":{},"289":{},"291":{},"293":{},"294":{},"296":{},"297":{},"309":{},"312":{},"313":{},"314":{},"317":{},"320":{},"321":{},"338":{},"339":{},"340":{},"342":{},"343":{},"353":{},"354":{},"356":{},"359":{},"361":{},"362":{},"364":{},"373":{},"383":{},"384":{},"387":{},"388":{},"389":{},"390":{},"391":{},"393":{},"395":{},"398":{},"399":{},"400":{},"401":{},"402":{},"403":{},"406":{},"414":{},"419":{},"420":{},"422":{},"433":{},"436":{},"437":{},"439":{},"441":{},"442":{},"443":{},"446":{},"447":{},"448":{},"449":{},"451":{},"452":{},"453":{},"454":{},"455":{},"456":{},"457":{},"458":{},"459":{},"460":{},"518":{},"519":{},"520":{},"521":{},"523":{},"524":{},"525":{},"527":{},"528":{},"529":{},"530":{},"531":{},"628":{},"631":{},"632":{},"633":{},"634":{},"652":{},"655":{},"661":{},"662":{},"663":{},"671":{},"672":{},"678":{}}}],["role](https://go.cpanel.net/serverroles#rol",{"_index":398,"title":{},"description":{"114":{},"115":{},"213":{},"215":{},"217":{},"223":{},"225":{},"226":{},"253":{},"276":{},"282":{},"295":{},"310":{},"348":{},"434":{},"440":{},"629":{},"636":{},"637":{},"638":{},"639":{},"640":{},"641":{}}}],["role_](https://go.cpanel.net/serverrol",{"_index":1065,"title":{},"description":{"386":{}}}],["roles](https://go.cpanel.com/serverrol",{"_index":1510,"title":{},"description":{"581":{}}}],["roles](https://go.cpanel.net/howtouseserverprofiles#rol",{"_index":1503,"title":{},"description":{"577":{},"579":{},"580":{},"582":{},"587":{},"595":{},"596":{},"597":{},"598":{},"599":{},"600":{},"605":{},"607":{},"608":{},"609":{}}}],["roles](https://go.cpanel.net/serverrol",{"_index":1453,"title":{},"description":{"558":{},"560":{},"561":{},"562":{},"563":{},"564":{},"567":{},"569":{},"570":{},"575":{},"578":{},"589":{},"590":{},"592":{},"594":{},"601":{},"602":{},"603":{},"604":{},"606":{}}}],["root",{"_index":1587,"title":{},"description":{"621":{},"654":{},"678":{},"679":{},"680":{}}}],["roundcub",{"_index":904,"title":{},"description":{"307":{}}}],["rout",{"_index":589,"title":{"251":{}},"description":{"186":{},"187":{},"188":{},"251":{}}}],["routin",{"_index":1241,"title":{"454":{}},"description":{"454":{}}}],["rpm-base",{"_index":1340,"title":{},"description":{"507":{},"513":{}}}],["rubi",{"_index":1601,"title":{},"description":{"633":{}}}],["rule",{"_index":788,"title":{"353":{},"354":{},"364":{}},"description":{"269":{},"353":{},"354":{},"359":{},"362":{},"364":{},"373":{}}}],["run",{"_index":37,"title":{"6":{},"251":{},"270":{},"374":{}},"description":{"6":{},"66":{},"153":{},"161":{},"465":{},"466":{},"467":{},"468":{},"469":{},"470":{},"507":{},"588":{},"592":{},"648":{},"649":{},"650":{},"651":{},"653":{},"654":{},"655":{},"656":{},"657":{},"658":{}}}],["same",{"_index":279,"title":{},"description":{"76":{},"83":{},"126":{},"156":{},"164":{},"514":{}}}],["save",{"_index":137,"title":{"23":{},"70":{},"360":{},"408":{},"416":{},"621":{},"668":{}},"description":{"70":{},"329":{},"360":{},"406":{},"416":{},"621":{},"668":{}}}],["scan",{"_index":842,"title":{"286":{},"465":{},"466":{},"468":{},"506":{},"512":{},"514":{},"515":{}},"description":{"465":{},"466":{},"467":{},"468":{},"469":{},"470":{},"506":{},"512":{},"514":{},"515":{}}}],["schema",{"_index":1200,"title":{"439":{}},"description":{"439":{}}}],["score",{"_index":975,"title":{"345":{},"348":{}},"description":{"345":{},"348":{}}}],["scp",{"_index":375,"title":{"106":{},"109":{}},"description":{"106":{},"109":{}}}],["script",{"_index":475,"title":{},"description":{"136":{},"137":{},"381":{},"679":{}}}],["script](https://go.cpanel.net/installdovecotftsscript",{"_index":850,"title":{},"description":{"286":{}}}],["script](https://go.cpanel.net/modifyaccount",{"_index":479,"title":{},"description":{"136":{},"137":{}}}],["scripts/process_site_templ",{"_index":1670,"title":{},"description":{"679":{}}}],["search",{"_index":841,"title":{"286":{}},"description":{"286":{}}}],["second",{"_index":797,"title":{},"description":{"269":{},"442":{}}}],["secondari",{"_index":350,"title":{},"description":{"93":{}}}],["secret",{"_index":937,"title":{"325":{},"328":{}},"description":{"325":{},"328":{}}}],["section",{"_index":1583,"title":{},"description":{"620":{},"653":{},"655":{}}}],["secur",{"_index":377,"title":{"166":{},"168":{},"170":{},"173":{},"174":{},"176":{},"178":{},"566":{},"584":{}},"description":{"106":{},"109":{},"166":{},"167":{},"168":{},"169":{},"170":{},"173":{},"174":{},"176":{},"177":{},"178":{},"194":{},"220":{},"536":{},"541":{},"576":{},"584":{}}}],["see",{"_index":1189,"title":{},"description":{"431":{}}}],["select",{"_index":895,"title":{"304":{},"305":{},"637":{},"639":{}},"description":{"304":{},"305":{},"334":{},"336":{},"469":{}}}],["self-sign",{"_index":1543,"title":{"598":{}},"description":{"598":{}}}],["semant",{"_index":544,"title":{},"description":{"167":{},"177":{}}}],["send",{"_index":160,"title":{"92":{},"229":{},"352":{}},"description":{"30":{},"34":{},"92":{},"199":{},"229":{},"230":{},"249":{},"293":{},"296":{},"340":{},"341":{},"353":{},"354":{},"359":{},"362":{},"378":{},"379":{},"380":{},"462":{}}}],["sender",{"_index":613,"title":{"351":{},"363":{}},"description":{"195":{},"197":{},"201":{},"351":{},"353":{},"354":{},"357":{},"359":{},"362":{},"363":{}}}],["sent",{"_index":1361,"title":{},"description":{"514":{}}}],["separ",{"_index":66,"title":{},"description":{"8":{},"9":{},"269":{},"290":{}}}],["sequenc",{"_index":522,"title":{},"description":{"155":{},"163":{}}}],["server",{"_index":71,"title":{"158":{},"165":{},"281":{},"299":{},"394":{},"402":{},"433":{},"434":{},"484":{},"544":{},"548":{},"590":{},"660":{},"661":{},"670":{},"671":{}},"description":{"8":{},"9":{},"26":{},"27":{},"66":{},"106":{},"107":{},"109":{},"117":{},"118":{},"119":{},"129":{},"136":{},"137":{},"152":{},"158":{},"160":{},"165":{},"193":{},"196":{},"197":{},"200":{},"212":{},"213":{},"215":{},"217":{},"261":{},"274":{},"281":{},"287":{},"289":{},"299":{},"340":{},"341":{},"378":{},"379":{},"380":{},"392":{},"394":{},"402":{},"415":{},"446":{},"484":{},"514":{},"544":{},"545":{},"546":{},"549":{},"555":{},"556":{},"558":{},"560":{},"561":{},"562":{},"563":{},"564":{},"567":{},"569":{},"570":{},"575":{},"579":{},"580":{},"581":{},"582":{},"587":{},"589":{},"590":{},"594":{},"595":{},"596":{},"597":{},"598":{},"599":{},"601":{},"602":{},"603":{},"604":{},"605":{},"606":{},"607":{},"608":{},"609":{},"620":{},"621":{},"624":{},"627":{},"628":{},"629":{},"630":{},"631":{},"632":{},"633":{},"634":{},"640":{},"647":{},"648":{},"652":{},"655":{},"658":{},"663":{},"672":{},"678":{},"680":{}}}],["server'",{"_index":110,"title":{"15":{},"285":{},"287":{},"397":{},"398":{},"400":{},"543":{},"546":{},"662":{},"672":{}},"description":{"15":{},"194":{},"196":{},"397":{},"400":{},"533":{},"543":{},"552":{}}}],["server-s",{"_index":1374,"title":{},"description":{"514":{}}}],["server-wid",{"_index":1432,"title":{},"description":{"548":{}}}],["server](https://go.cpanel.net/calendarandcontactsserv",{"_index":1309,"title":{},"description":{"485":{},"486":{},"487":{},"488":{},"489":{}}}],["server](https://go.cpanel.net/howtouseserverprofiles#rol",{"_index":1443,"title":{},"description":{"555":{},"556":{}}}],["server](https://go.cpanel.net/serverrol",{"_index":634,"title":{},"description":{"203":{},"205":{},"660":{},"670":{}}}],["server_",{"_index":1502,"title":{},"description":{"577":{},"592":{}}}],["server_](https://go.cpanel.net/howtouseserverprofiles#rol",{"_index":1679,"title":{},"description":{"679":{}}}],["serverinformation/get_inform",{"_index":1430,"title":{},"description":{"545":{}}}],["servic",{"_index":278,"title":{"77":{},"78":{},"79":{},"82":{},"83":{},"533":{},"545":{},"554":{},"555":{},"556":{},"576":{},"587":{},"588":{},"591":{}},"description":{"76":{},"77":{},"78":{},"79":{},"82":{},"83":{},"220":{},"476":{},"545":{},"554":{},"555":{},"556":{},"576":{},"587":{},"588":{},"589":{},"591":{}}}],["serviceproxi",{"_index":1437,"title":{"553":{}},"description":{"553":{}}}],["serviceproxy/get_service_proxy_backend",{"_index":1442,"title":{},"description":{"554":{}}}],["serviceproxy/set_service_proxy_backend",{"_index":1450,"title":{},"description":{"556":{}}}],["serviceproxy/unset_all_service_proxy_backend",{"_index":1448,"title":{},"description":{"555":{}}}],["services.email.dismiss",{"_index":300,"title":{},"description":{"78":{}}}],["services.email.merg",{"_index":315,"title":{},"description":{"83":{}}}],["services.ftp.dismiss",{"_index":301,"title":{},"description":{"78":{}}}],["services.ftp.merg",{"_index":316,"title":{},"description":{"83":{}}}],["services.webdisk.dismiss",{"_index":302,"title":{},"description":{"78":{}}}],["services.webdisk.merg",{"_index":317,"title":{},"description":{"83":{}}}],["session",{"_index":95,"title":{"12":{},"377":{},"378":{},"379":{},"380":{},"381":{},"399":{},"400":{}},"description":{"69":{},"70":{},"222":{},"377":{},"378":{},"379":{},"380":{},"381":{},"399":{},"400":{},"573":{},"608":{},"609":{}}}],["session/create_temp_us",{"_index":1060,"title":{},"description":{"381":{}}}],["session/create_webmail_session_for_mail_us",{"_index":1050,"title":{},"description":{"380":{}}}],["session/create_webmail_session_for_mail_user_check_password",{"_index":1048,"title":{},"description":{"378":{}}}],["session/create_webmail_session_for_self",{"_index":1049,"title":{},"description":{"379":{}}}],["session::create_webmail_session_for_mail_us",{"_index":1031,"title":{},"description":{"378":{}}}],["session=$sess",{"_index":1039,"title":{},"description":{"378":{},"379":{},"380":{}}}],["session=username:d7niazv1nf4bxeg9:create_webmail_session_for_mail_user,728fb86a7df1cf20690c65f349ac3137",{"_index":1047,"title":{},"description":{"378":{},"379":{},"380":{}}}],["set",{"_index":126,"title":{"19":{},"46":{},"53":{},"59":{},"80":{},"90":{},"93":{},"94":{},"100":{},"101":{},"103":{},"133":{},"134":{},"139":{},"140":{},"141":{},"150":{},"185":{},"229":{},"232":{},"242":{},"343":{},"346":{},"347":{},"394":{},"418":{},"423":{},"429":{},"444":{},"492":{},"504":{},"507":{},"511":{},"546":{},"586":{},"619":{},"624":{},"628":{},"647":{},"666":{},"668":{}},"description":{"19":{},"21":{},"22":{},"23":{},"33":{},"45":{},"46":{},"53":{},"58":{},"59":{},"69":{},"70":{},"90":{},"93":{},"101":{},"103":{},"131":{},"133":{},"134":{},"139":{},"140":{},"141":{},"150":{},"153":{},"161":{},"184":{},"185":{},"186":{},"187":{},"188":{},"229":{},"230":{},"232":{},"242":{},"249":{},"269":{},"290":{},"343":{},"346":{},"347":{},"348":{},"358":{},"359":{},"362":{},"373":{},"393":{},"394":{},"416":{},"418":{},"423":{},"424":{},"429":{},"459":{},"460":{},"465":{},"470":{},"475":{},"492":{},"504":{},"507":{},"528":{},"546":{},"555":{},"585":{},"586":{},"604":{},"619":{},"624":{},"647":{},"655":{},"657":{},"666":{},"668":{}}}],["set_email_address",{"_index":209,"title":{},"description":{"45":{},"58":{}}}],["set_service_proxy_backend",{"_index":1447,"title":{},"description":{"555":{}}}],["setup",{"_index":1440,"title":{"554":{}},"description":{}}],["share",{"_index":318,"title":{"478":{},"479":{},"480":{},"482":{},"483":{},"568":{},"649":{}},"description":{"83":{},"472":{},"473":{},"474":{},"478":{},"479":{},"482":{},"483":{},"568":{}}}],["shop",{"_index":158,"title":{"30":{}},"description":{"30":{}}}],["sign",{"_index":562,"title":{"322":{},"574":{},"582":{},"595":{},"600":{},"602":{},"607":{}},"description":{"172":{},"195":{},"322":{},"574":{},"582":{},"595":{},"596":{},"600":{},"602":{},"607":{}}}],["signifi",{"_index":464,"title":{},"description":{"129":{}}}],["simpli",{"_index":1229,"title":{},"description":{"444":{}}}],["singl",{"_index":308,"title":{"124":{}},"description":{"81":{},"156":{},"164":{},"498":{},"500":{},"501":{},"599":{},"658":{}}}],["site",{"_index":636,"title":{"495":{},"496":{},"498":{},"499":{},"500":{},"501":{},"502":{},"505":{},"507":{},"509":{},"511":{},"512":{},"514":{},"515":{},"673":{},"674":{},"675":{},"676":{},"677":{},"678":{},"679":{},"680":{}},"description":{"204":{},"495":{},"496":{},"497":{},"498":{},"499":{},"500":{},"501":{},"502":{},"503":{},"673":{},"674":{},"675":{},"676":{},"677":{},"678":{},"679":{},"680":{}}}],["site'",{"_index":1334,"title":{"503":{}},"description":{}}],["site_publisher/backup",{"_index":1677,"title":{},"description":{"679":{}}}],["sitemap.json",{"_index":434,"title":{"123":{}},"description":{"123":{}}}],["sitetemplates/list_site_templ",{"_index":1669,"title":{},"description":{"678":{}}}],["sitetemplates/list_user_set",{"_index":1681,"title":{},"description":{"680":{}}}],["sitetemplates/publish",{"_index":1680,"title":{},"description":{"679":{}}}],["size",{"_index":713,"title":{"239":{},"240":{}},"description":{"233":{},"235":{},"239":{},"240":{},"303":{}}}],["smtp",{"_index":866,"title":{"293":{},"300":{},"301":{}},"description":{}}],["sni",{"_index":1519,"title":{"586":{},"587":{},"588":{},"589":{},"590":{},"591":{},"592":{}},"description":{"586":{},"587":{},"588":{},"589":{},"590":{},"591":{},"592":{}}}],["socket",{"_index":676,"title":{},"description":{"220":{}}}],["softwar",{"_index":1634,"title":{},"description":{"653":{},"655":{}}}],["solr",{"_index":845,"title":{},"description":{"286":{}}}],["sort",{"_index":1124,"title":{},"description":{"415":{}}}],["sourc",{"_index":188,"title":{},"description":{"38":{}}}],["space",{"_index":716,"title":{},"description":{"234":{},"236":{},"238":{}}}],["spam",{"_index":949,"title":{"330":{},"337":{},"339":{},"340":{},"341":{},"344":{},"348":{},"349":{}},"description":{"330":{},"337":{},"338":{},"339":{},"340":{},"341":{},"342":{},"344":{},"348":{},"349":{}}}],["spamassassin",{"_index":958,"title":{"338":{},"342":{},"343":{},"345":{},"346":{},"347":{}},"description":{"338":{},"339":{},"340":{},"341":{},"342":{},"343":{},"345":{},"346":{},"347":{},"348":{},"431":{}}}],["spamassassin/clear_spam_box",{"_index":973,"title":{},"description":{"344":{}}}],["spamassassin/get_symbolic_test_nam",{"_index":976,"title":{},"description":{"345":{}}}],["spamassassin/get_user_prefer",{"_index":981,"title":{},"description":{"347":{}}}],["spamassassin/update_user_prefer",{"_index":979,"title":{},"description":{"346":{}}}],["spamfilt",{"_index":970,"title":{},"description":{"343":{}}}],["specif",{"_index":220,"title":{"374":{},"562":{},"563":{}},"description":{"50":{},"121":{},"123":{},"155":{},"163":{},"470":{},"665":{}}}],["specifi",{"_index":284,"title":{"334":{},"336":{},"356":{},"615":{},"618":{}},"description":{"76":{},"77":{},"90":{},"157":{},"189":{},"204":{},"209":{},"227":{},"237":{},"374":{},"407":{},"408":{},"410":{},"413":{},"429":{},"430":{},"478":{},"482":{},"483":{},"558":{},"562":{},"563":{},"584":{},"587":{},"588":{},"637":{},"639":{},"649":{},"679":{}}}],["spf",{"_index":619,"title":{"197":{},"201":{}},"description":{"197":{},"201":{}}}],["sql-92",{"_index":1387,"title":{},"description":{"523":{}}}],["sqlite",{"_index":862,"title":{"291":{}},"description":{"291":{}}}],["sse",{"_index":58,"title":{"7":{}},"description":{"7":{},"514":{}}}],["ssh",{"_index":387,"title":{"109":{},"536":{},"551":{},"552":{}},"description":{"109":{},"431":{},"536":{},"551":{},"552":{}}}],["ssh/get_port",{"_index":1436,"title":{},"description":{"552":{}}}],["ssl",{"_index":163,"title":{"36":{},"38":{},"39":{},"40":{},"42":{},"43":{},"220":{},"557":{},"565":{},"567":{},"568":{},"569":{},"570":{},"571":{},"572":{},"576":{},"577":{},"578":{},"579":{},"583":{},"585":{},"593":{},"594":{},"597":{},"598":{},"601":{},"604":{},"605":{},"608":{}},"description":{"30":{},"36":{},"38":{},"39":{},"40":{},"43":{},"220":{},"300":{},"431":{},"557":{},"565":{},"566":{},"567":{},"568":{},"572":{},"583":{},"584":{},"586":{},"587":{},"589":{},"591":{},"593":{},"594":{},"597":{},"598":{},"600":{},"604":{},"610":{}}}],["ssl-relat",{"_index":1509,"title":{"581":{}},"description":{"581":{},"594":{}}}],["ssl-secur",{"_index":885,"title":{"300":{}},"description":{}}],["ssl/add_autossl_excluded_domain",{"_index":1454,"title":{},"description":{"558":{}}}],["ssl/can_ssl_redirect",{"_index":1467,"title":{},"description":{"566":{}}}],["ssl/check_shared_cert",{"_index":1472,"title":{},"description":{"568":{}}}],["ssl/delete_cert",{"_index":1542,"title":{},"description":{"597":{}}}],["ssl/delete_csr",{"_index":1538,"title":{},"description":{"595":{}}}],["ssl/delete_key",{"_index":1540,"title":{},"description":{"596":{}}}],["ssl/delete_ssl",{"_index":1471,"title":{},"description":{"567":{}}}],["ssl/disable_mail_sni",{"_index":1523,"title":{},"description":{"588":{}}}],["ssl/enable_mail_sni",{"_index":1521,"title":{},"description":{"587":{}}}],["ssl/fetch_best_for_domain",{"_index":1478,"title":{},"description":{"569":{}}}],["ssl/fetch_cert_info",{"_index":1480,"title":{},"description":{"570":{}}}],["ssl/fetch_certificates_for_fqdn",{"_index":1485,"title":{},"description":{"571":{}}}],["ssl/fetch_key_and_cabundle_for_certif",{"_index":1488,"title":{},"description":{"573":{}}}],["ssl/find_certificates_for_key",{"_index":1486,"title":{},"description":{"572":{}}}],["ssl/find_csrs_for_key",{"_index":1491,"title":{},"description":{"574":{}}}],["ssl/generate_cert",{"_index":1544,"title":{},"description":{"598":{}}}],["ssl/generate_csr",{"_index":1550,"title":{},"description":{"600":{}}}],["ssl/generate_key",{"_index":1548,"title":{},"description":{"599":{}}}],["ssl/get_autossl_excluded_domain",{"_index":1455,"title":{},"description":{"559":{}}}],["ssl/get_autossl_problem",{"_index":1457,"title":{},"description":{"560":{}}}],["ssl/get_cabundl",{"_index":1492,"title":{},"description":{"575":{}}}],["ssl/get_cn_nam",{"_index":1493,"title":{},"description":{"576":{}}}],["ssl/install_ssl",{"_index":1536,"title":{},"description":{"594":{}}}],["ssl/installed_host",{"_index":1504,"title":{},"description":{"577":{},"578":{}}}],["ssl/is_autossl_check_in_progress",{"_index":1459,"title":{},"description":{"561":{}}}],["ssl/is_mail_sni_support",{"_index":1525,"title":{},"description":{"589":{}}}],["ssl/is_sni_support",{"_index":1526,"title":{},"description":{"590":{}}}],["ssl/list_cert",{"_index":1507,"title":{},"description":{"579":{}}}],["ssl/list_csr",{"_index":1512,"title":{},"description":{"582":{}}}],["ssl/list_key",{"_index":1508,"title":{},"description":{"580":{}}}],["ssl/list_ssl_item",{"_index":1511,"title":{},"description":{"581":{}}}],["ssl/mail_sni_statu",{"_index":1527,"title":{},"description":{"591":{}}}],["ssl/rebuild_mail_sni_config",{"_index":1530,"title":{},"description":{"592":{}}}],["ssl/rebuildssldb",{"_index":1513,"title":{},"description":{"583":{}}}],["ssl/remove_autossl_excluded_domain",{"_index":1460,"title":{},"description":{"562":{}}}],["ssl/set_autossl_excluded_domain",{"_index":1463,"title":{},"description":{"563":{}}}],["ssl/set_cert_friendly_nam",{"_index":1552,"title":{},"description":{"601":{}}}],["ssl/set_csr_friendly_nam",{"_index":1554,"title":{},"description":{"602":{}}}],["ssl/set_default_key_typ",{"_index":1518,"title":{},"description":{"585":{}}}],["ssl/set_key_friendly_nam",{"_index":1555,"title":{},"description":{"603":{}}}],["ssl/set_primary_ssl",{"_index":1556,"title":{},"description":{"604":{}}}],["ssl/show_cert",{"_index":1557,"title":{},"description":{"605":{}}}],["ssl/show_csr",{"_index":1559,"title":{},"description":{"607":{}}}],["ssl/show_key",{"_index":1558,"title":{},"description":{"606":{}}}],["ssl/start_autossl_check",{"_index":1466,"title":{},"description":{"564":{}}}],["ssl/tl",{"_index":1517,"title":{},"description":{"585":{}}}],["ssl/toggle_ssl_redirect_for_domain",{"_index":1515,"title":{},"description":{"584":{}}}],["ssl/upload_cert",{"_index":1560,"title":{},"description":{"608":{}}}],["ssl/upload_key",{"_index":1561,"title":{},"description":{"609":{}}}],["ssl::add_autossl_excluded_domain",{"_index":1462,"title":{},"description":{"563":{}}}],["ssl::delete_cert",{"_index":1470,"title":{},"description":{"567":{}}}],["ssl::delete_csr",{"_index":1539,"title":{},"description":{"596":{}}}],["ssl::delete_key",{"_index":1537,"title":{},"description":{"595":{}}}],["ssl::delete_ssl",{"_index":1541,"title":{},"description":{"597":{}}}],["ssl::generate_key",{"_index":1549,"title":{},"description":{"600":{}}}],["ssl::install_ssl",{"_index":1534,"title":{},"description":{"594":{}}}],["ssl::installed_host",{"_index":1496,"title":{},"description":{"577":{},"578":{}}}],["sslinstal",{"_index":1524,"title":{},"description":{"589":{}}}],["start",{"_index":200,"title":{"43":{},"249":{},"286":{},"466":{},"469":{},"514":{},"564":{},"583":{},"592":{}},"description":{"465":{},"466":{},"467":{},"468":{},"469":{},"470":{},"500":{},"501":{},"515":{},"632":{}}}],["state",{"_index":572,"title":{},"description":{"175":{},"442":{},"502":{}}}],["statist",{"_index":273,"title":{"71":{},"72":{},"73":{},"614":{},"616":{},"617":{},"618":{}},"description":{"71":{},"72":{},"73":{},"614":{},"617":{},"618":{},"619":{}}}],["stats/get_bandwidth",{"_index":1575,"title":{},"description":{"616":{}}}],["stats/get_site_error",{"_index":1567,"title":{},"description":{"615":{}}}],["stats/list_sit",{"_index":1577,"title":{},"description":{"617":{}}}],["stats/list_stats_by_domain",{"_index":1578,"title":{},"description":{"618":{}}}],["stats_",{"_index":1570,"title":{},"description":{"616":{}}}],["statsbar/get_stat",{"_index":275,"title":{},"description":{"73":{}}}],["statsmanager/get_configur",{"_index":1584,"title":{},"description":{"620":{}}}],["statsmanager/save_configur",{"_index":1588,"title":{},"description":{"621":{}}}],["statu",{"_index":117,"title":{"16":{},"33":{},"38":{},"145":{},"282":{},"288":{},"291":{},"303":{},"335":{},"426":{},"468":{},"470":{},"496":{},"499":{},"502":{},"545":{},"591":{},"640":{},"641":{}},"description":{"33":{},"38":{},"145":{},"291":{},"335":{},"426":{},"465":{},"466":{},"467":{},"468":{},"469":{},"470":{},"512":{},"545":{},"588":{},"591":{},"592":{},"641":{},"674":{}}}],["status",{"_index":329,"title":{},"description":{"89":{}}}],["step",{"_index":1166,"title":{},"description":{"428":{},"442":{},"470":{},"594":{}}}],["still",{"_index":867,"title":{},"description":{"293":{},"294":{},"555":{},"556":{}}}],["stop",{"_index":324,"title":{"88":{},"230":{},"259":{},"399":{},"495":{},"515":{}},"description":{"88":{}}}],["storag",{"_index":254,"title":{"114":{}},"description":{"69":{},"70":{},"112":{},"113":{},"114":{},"115":{},"119":{},"410":{},"414":{},"416":{},"567":{},"597":{}}}],["storage](https://go.cpanel.net/serverrol",{"_index":1113,"title":{},"description":{"412":{},"413":{},"417":{}}}],["store",{"_index":161,"title":{},"description":{"30":{},"442":{},"509":{},"511":{},"528":{}}}],["strength",{"_index":1434,"title":{"549":{},"550":{}},"description":{"549":{},"550":{}}}],["string",{"_index":1107,"title":{},"description":{"410":{},"412":{},"439":{},"514":{}}}],["strongli",{"_index":609,"title":{},"description":{"195":{},"442":{},"528":{}}}],["structur",{"_index":417,"title":{},"description":{"117":{},"119":{}}}],["style",{"_index":481,"title":{},"description":{"137":{}}}],["subaccount",{"_index":276,"title":{"74":{},"75":{},"76":{},"77":{},"80":{},"82":{},"83":{},"84":{}},"description":{"74":{},"75":{},"76":{},"77":{},"78":{},"80":{},"82":{},"83":{},"84":{}}}],["subaccount'",{"_index":307,"title":{"81":{}},"description":{"81":{}}}],["subdirectori",{"_index":484,"title":{"140":{},"145":{},"223":{}},"description":{"139":{},"140":{},"145":{},"150":{},"223":{},"406":{}}}],["subdomain",{"_index":665,"title":{"210":{},"216":{},"217":{}},"description":{"210":{},"216":{},"217":{}}}],["subdomain/addsubdomain",{"_index":672,"title":{},"description":{"217":{}}}],["subdomains.](https://go.cpanel.net/serviceproxysubdomain",{"_index":678,"title":{},"description":{"220":{}}}],["submit",{"_index":198,"title":{},"description":{"42":{}}}],["succe",{"_index":648,"title":{},"description":{"208":{},"424":{},"555":{},"556":{},"587":{},"588":{},"589":{},"591":{},"592":{}}}],["success",{"_index":1218,"title":{},"description":{"442":{}}}],["successfulli",{"_index":1035,"title":{},"description":{"378":{},"379":{},"380":{},"442":{},"594":{}}}],["such",{"_index":1228,"title":{},"description":{"444":{},"620":{}}}],["suggest",{"_index":1151,"title":{},"description":{"424":{}}}],["support",{"_index":822,"title":{"282":{},"285":{},"287":{},"590":{}},"description":{"282":{},"287":{},"428":{},"429":{},"430":{},"431":{},"523":{},"590":{}}}],["suspend",{"_index":328,"title":{"98":{},"293":{},"294":{},"296":{}},"description":{"89":{},"98":{},"293":{},"294":{},"295":{},"296":{},"298":{},"378":{}}}],["suspens",{"_index":864,"title":{"292":{}},"description":{"292":{},"294":{},"298":{}}}],["symbol",{"_index":974,"title":{"345":{}},"description":{"345":{}}}],["symlink",{"_index":397,"title":{},"description":{"114":{}}}],["synchron",{"_index":1385,"title":{},"description":{"523":{}}}],["system",{"_index":148,"title":{},"description":{"26":{},"27":{},"30":{},"39":{},"78":{},"106":{},"107":{},"108":{},"109":{},"112":{},"113":{},"114":{},"115":{},"116":{},"117":{},"118":{},"119":{},"129":{},"167":{},"168":{},"169":{},"170":{},"171":{},"172":{},"173":{},"174":{},"175":{},"176":{},"177":{},"178":{},"180":{},"181":{},"182":{},"183":{},"184":{},"186":{},"187":{},"188":{},"192":{},"194":{},"196":{},"203":{},"204":{},"205":{},"212":{},"213":{},"215":{},"217":{},"222":{},"223":{},"224":{},"225":{},"226":{},"227":{},"229":{},"231":{},"232":{},"233":{},"234":{},"235":{},"236":{},"237":{},"238":{},"239":{},"240":{},"241":{},"242":{},"243":{},"244":{},"245":{},"246":{},"247":{},"248":{},"250":{},"252":{},"253":{},"254":{},"255":{},"257":{},"258":{},"261":{},"262":{},"263":{},"264":{},"265":{},"266":{},"267":{},"268":{},"269":{},"270":{},"271":{},"273":{},"274":{},"275":{},"276":{},"277":{},"278":{},"279":{},"280":{},"282":{},"283":{},"284":{},"285":{},"286":{},"287":{},"289":{},"290":{},"291":{},"293":{},"294":{},"295":{},"296":{},"297":{},"309":{},"310":{},"312":{},"313":{},"314":{},"315":{},"316":{},"317":{},"320":{},"321":{},"329":{},"338":{},"339":{},"340":{},"341":{},"342":{},"343":{},"344":{},"348":{},"350":{},"351":{},"352":{},"353":{},"354":{},"355":{},"356":{},"357":{},"358":{},"359":{},"360":{},"361":{},"362":{},"363":{},"364":{},"365":{},"366":{},"367":{},"368":{},"369":{},"370":{},"371":{},"372":{},"373":{},"374":{},"376":{},"381":{},"383":{},"384":{},"386":{},"387":{},"388":{},"389":{},"390":{},"391":{},"392":{},"393":{},"395":{},"396":{},"398":{},"399":{},"400":{},"401":{},"402":{},"403":{},"405":{},"406":{},"407":{},"408":{},"410":{},"411":{},"412":{},"413":{},"414":{},"415":{},"416":{},"417":{},"419":{},"420":{},"421":{},"422":{},"424":{},"426":{},"428":{},"430":{},"433":{},"434":{},"436":{},"437":{},"438":{},"439":{},"440":{},"441":{},"442":{},"443":{},"444":{},"446":{},"447":{},"448":{},"449":{},"451":{},"452":{},"453":{},"454":{},"455":{},"456":{},"457":{},"458":{},"459":{},"460":{},"465":{},"497":{},"503":{},"509":{},"511":{},"513":{},"514":{},"517":{},"518":{},"519":{},"520":{},"521":{},"523":{},"524":{},"525":{},"526":{},"527":{},"528":{},"529":{},"530":{},"531":{},"555":{},"556":{},"558":{},"560":{},"561":{},"562":{},"563":{},"564":{},"566":{},"567":{},"569":{},"570":{},"575":{},"577":{},"578":{},"579":{},"580":{},"581":{},"582":{},"587":{},"589":{},"590":{},"592":{},"594":{},"595":{},"596":{},"597":{},"598":{},"599":{},"600":{},"601":{},"602":{},"603":{},"604":{},"605":{},"606":{},"607":{},"608":{},"609":{},"620":{},"621":{},"628":{},"629":{},"630":{},"631":{},"632":{},"633":{},"634":{},"636":{},"637":{},"638":{},"639":{},"640":{},"641":{},"648":{},"649":{},"650":{},"651":{},"652":{},"653":{},"654":{},"655":{},"656":{},"657":{},"658":{},"660":{},"661":{},"662":{},"663":{},"670":{},"671":{},"672":{},"678":{},"679":{},"680":{}}}],["system'",{"_index":827,"title":{},"description":{"283":{},"329":{},"650":{}}}],["system-level",{"_index":783,"title":{"267":{}},"description":{"267":{}}}],["system’",{"_index":1629,"title":{},"description":{"652":{}}}],["tabl",{"_index":1197,"title":{"443":{}},"description":{"437":{},"443":{},"523":{}}}],["take",{"_index":1599,"title":{},"description":{"632":{}}}],["taken",{"_index":1284,"title":{},"description":{"470":{}}}],["tarbal",{"_index":1675,"title":{},"description":{"679":{}}}],["target",{"_index":1676,"title":{},"description":{"679":{}}}],["task",{"_index":59,"title":{"7":{},"8":{},"9":{},"424":{},"425":{},"426":{},"481":{}},"description":{"7":{},"8":{},"9":{},"425":{},"426":{},"561":{}}}],["team",{"_index":131,"title":{"21":{},"85":{},"87":{},"88":{},"89":{},"90":{},"91":{},"92":{},"93":{},"94":{},"95":{},"96":{},"97":{},"98":{},"99":{},"100":{},"101":{},"102":{},"103":{},"104":{}},"description":{"21":{},"85":{},"86":{},"87":{},"88":{},"89":{},"90":{},"91":{},"92":{},"95":{},"96":{},"97":{},"98":{},"99":{},"101":{},"102":{},"103":{},"104":{}}}],["team/add_rol",{"_index":345,"title":{},"description":{"91":{}}}],["team/add_team_us",{"_index":354,"title":{},"description":{"96":{}}}],["team/cancel_expir",{"_index":326,"title":{},"description":{"88":{}}}],["team/edit_team_us",{"_index":363,"title":{},"description":{"99":{}}}],["team/get_team_users_with_roles_count",{"_index":369,"title":{},"description":{"102":{}}}],["team/list_team",{"_index":359,"title":{},"description":{"97":{}}}],["team/password_reset_request",{"_index":347,"title":{},"description":{"92":{}}}],["team/reinstate_team_us",{"_index":333,"title":{},"description":{"89":{}}}],["team/remove_rol",{"_index":353,"title":{},"description":{"95":{}}}],["team/remove_team_us",{"_index":371,"title":{},"description":{"104":{}}}],["team/set_contact_email",{"_index":351,"title":{},"description":{"93":{}}}],["team/set_expir",{"_index":339,"title":{},"description":{"90":{}}}],["team/set_local",{"_index":366,"title":{},"description":{"101":{}}}],["team/set_not",{"_index":365,"title":{},"description":{"100":{}}}],["team/set_password",{"_index":352,"title":{},"description":{"94":{}}}],["team/set_rol",{"_index":370,"title":{},"description":{"103":{}}}],["team/suspend_team_us",{"_index":361,"title":{},"description":{"98":{}}}],["teamroles/list_feature_descript",{"_index":323,"title":{},"description":{"86":{}}}],["templat",{"_index":1002,"title":{"356":{},"358":{},"360":{},"370":{},"678":{}},"description":{"356":{},"358":{},"360":{},"370":{},"381":{},"678":{},"679":{}}}],["templates](https://go.cpanel.net/sitepublishertempl",{"_index":1674,"title":{},"description":{"679":{},"680":{}}}],["temporari",{"_index":1030,"title":{"497":{},"503":{}},"description":{"378":{},"379":{},"380":{},"381":{},"503":{}}}],["termin",{"_index":766,"title":{},"description":{"259":{},"514":{}}}],["test",{"_index":805,"title":{"270":{},"345":{}},"description":{"270":{},"345":{},"462":{}}}],["text",{"_index":364,"title":{},"description":{"100":{}}}],["theme",{"_index":260,"title":{"126":{},"134":{},"135":{},"136":{},"137":{}},"description":{"69":{},"70":{},"120":{},"125":{},"126":{},"127":{},"130":{},"134":{},"136":{},"137":{}}}],["theme'",{"_index":429,"title":{},"description":{"121":{},"123":{}}}],["themes/get_theme_bas",{"_index":472,"title":{},"description":{"135":{}}}],["themes/list",{"_index":482,"title":{},"description":{"137":{}}}],["themes/upd",{"_index":480,"title":{},"description":{"136":{}}}],["third-parti",{"_index":1054,"title":{},"description":{"381":{},"594":{}}}],["those",{"_index":1469,"title":{},"description":{"567":{}}}],["three",{"_index":1212,"title":{},"description":{"442":{}}}],["threshold",{"_index":983,"title":{"348":{}},"description":{"348":{}}}],["through",{"_index":156,"title":{},"description":{"29":{},"417":{},"592":{}}}],["thumbnail",{"_index":1095,"title":{"406":{}},"description":{"406":{}}}],["time",{"_index":288,"title":{},"description":{"77":{},"90":{},"329":{},"424":{},"426":{},"428":{},"514":{},"632":{}}}],["timedout",{"_index":1368,"title":{},"description":{"514":{}}}],["timeout",{"_index":947,"title":{},"description":{"329":{}}}],["timestamp",{"_index":1141,"title":{},"description":{"424":{},"426":{},"428":{}}}],["tl",{"_index":1516,"title":{"585":{}},"description":{}}],["tmp",{"_index":1186,"title":{},"description":{"431":{}}}],["tn_",{"_index":1098,"title":{},"description":{"406":{}}}],["tn_picture.jpg",{"_index":1099,"title":{},"description":{"406":{}}}],["to_charset",{"_index":1118,"title":{},"description":{"412":{}}}],["token",{"_index":1,"title":{"0":{},"1":{},"2":{},"4":{},"35":{},"462":{}},"description":{"0":{},"1":{},"2":{},"3":{},"4":{},"35":{},"378":{},"379":{},"380":{},"462":{}}}],["token'",{"_index":27,"title":{"3":{}},"description":{}}],["tokens/create_full_access",{"_index":22,"title":{},"description":{"1":{}}}],["tokens/list",{"_index":25,"title":{},"description":{"2":{}}}],["tokens/renam",{"_index":31,"title":{},"description":{"3":{}}}],["tokens/revok",{"_index":33,"title":{},"description":{"4":{}}}],["tool",{"_index":4,"title":{"404":{}},"description":{"0":{},"7":{},"10":{},"404":{},"444":{}}}],["toolkit",{"_index":1051,"title":{},"description":{"381":{}}}],["top",{"_index":999,"title":{"355":{}},"description":{}}],["top-level",{"_index":1155,"title":{},"description":{"424":{},"426":{}}}],["total",{"_index":246,"title":{"225":{},"226":{},"261":{},"276":{},"310":{},"548":{}},"description":{"66":{},"314":{}}}],["trace",{"_index":747,"title":{"251":{}},"description":{"251":{}}}],["transfer",{"_index":383,"title":{"396":{},"403":{}},"description":{"107":{},"396":{},"403":{}}}],["trash",{"_index":1109,"title":{"411":{}},"description":{"411":{},"431":{}}}],["treat",{"_index":1217,"title":{},"description":{"442":{}}}],["tree",{"_index":1158,"title":{},"description":{"424":{},"426":{}}}],["tri",{"_index":1190,"title":{},"description":{"431":{}}}],["troubleshoot",{"_index":1165,"title":{},"description":{"428":{}}}],["tutorial](https://go.cpanel.net/tutorial-use-uapis-fileman-upload-files-function-in-custom-cod",{"_index":1128,"title":{},"description":{"417":{}}}],["two",{"_index":281,"title":{},"description":{"76":{},"269":{}}}],["two-factor",{"_index":125,"title":{"19":{}},"description":{"19":{},"20":{},"21":{},"22":{},"23":{},"24":{}}}],["twofactorauth/generate_user_configur",{"_index":130,"title":{},"description":{"20":{}}}],["twofactorauth/get_team_user_configur",{"_index":134,"title":{},"description":{"21":{}}}],["twofactorauth/get_user_configur",{"_index":136,"title":{},"description":{"22":{}}}],["twofactorauth/remove_user_configur",{"_index":140,"title":{},"description":{"24":{}}}],["twofactorauth/set_user_configur",{"_index":138,"title":{},"description":{"23":{}}}],["type",{"_index":857,"title":{"290":{},"465":{},"585":{},"660":{},"661":{},"669":{},"670":{},"671":{},"672":{}},"description":{"290":{},"429":{},"465":{},"470":{},"585":{},"660":{},"661":{},"669":{},"670":{},"671":{},"672":{}}}],["typic",{"_index":162,"title":{},"description":{"30":{}}}],["uapi",{"_index":36,"title":{"6":{}},"description":{"5":{},"6":{},"48":{},"56":{},"66":{},"68":{},"85":{},"87":{},"105":{},"151":{},"196":{},"216":{},"224":{},"230":{},"249":{},"257":{},"258":{},"284":{},"293":{},"294":{},"295":{},"296":{},"298":{},"340":{},"341":{},"348":{},"363":{},"378":{},"461":{},"463":{},"506":{},"512":{},"514":{},"532":{},"547":{},"551":{},"553":{},"555":{},"556":{},"563":{},"567":{},"578":{},"595":{},"596":{},"597":{},"622":{},"635":{},"642":{}}}],["uapi'",{"_index":830,"title":{},"description":{"283":{},"288":{},"417":{},"588":{},"592":{},"594":{},"600":{},"613":{}}}],["uapi_cpanel](https://go.cpanel.net/usewhmapitocallcpanelapianduapi",{"_index":1130,"title":{},"description":{"417":{}}}],["uapi’",{"_index":165,"title":{},"description":{"30":{}}}],["unauthor",{"_index":1231,"title":{},"description":{"446":{}}}],["unblock",{"_index":150,"title":{},"description":{"27":{}}}],["under",{"_index":912,"title":{},"description":{"311":{}}}],["uniqu",{"_index":891,"title":{},"description":{"303":{}}}],["unix",{"_index":1142,"title":{},"description":{"424":{},"426":{},"428":{}}}],["unlink",{"_index":311,"title":{},"description":{"82":{}}}],["unregist",{"_index":310,"title":{"82":{},"634":{}},"description":{"634":{}}}],["unset",{"_index":206,"title":{"45":{},"58":{}},"description":{"45":{},"46":{},"58":{},"59":{}}}],["unset_all_service_proxy_backend",{"_index":1449,"title":{},"description":{"556":{}}}],["unset_email_address",{"_index":211,"title":{},"description":{"46":{},"59":{}}}],["unset_manual_mx_redirect",{"_index":761,"title":{},"description":{"257":{},"258":{}}}],["unsuspend",{"_index":878,"title":{"295":{},"297":{},"298":{}},"description":{"297":{}}}],["until",{"_index":1262,"title":{},"description":{"465":{},"466":{},"467":{},"468":{},"469":{},"470":{}}}],["up",{"_index":374,"title":{"106":{},"107":{},"108":{},"109":{}},"description":{"269":{},"424":{},"475":{},"503":{},"506":{}}}],["up-to-d",{"_index":1149,"title":{},"description":{"424":{}}}],["updat",{"_index":26,"title":{"3":{},"33":{},"34":{},"55":{},"80":{},"131":{},"136":{},"141":{},"156":{},"157":{},"164":{},"167":{},"177":{},"183":{},"184":{},"187":{},"228":{},"248":{},"268":{},"290":{},"316":{},"320":{},"346":{},"348":{},"359":{},"362":{},"371":{},"373":{},"389":{},"390":{},"391":{},"393":{},"414":{},"420":{},"421":{},"422":{},"429":{},"436":{},"442":{},"456":{},"459":{},"460":{},"480":{},"483":{},"487":{},"505":{},"507":{},"510":{},"521":{},"523":{},"528":{},"530":{},"531":{},"539":{},"585":{},"601":{},"602":{},"603":{},"604":{},"628":{},"655":{},"656":{},"657":{}},"description":{"34":{},"55":{},"129":{},"156":{},"164":{},"196":{},"381":{},"429":{},"436":{},"481":{},"483":{},"487":{},"505":{},"507":{},"510":{},"539":{}}}],["upload",{"_index":416,"title":{"417":{}},"description":{"117":{},"118":{},"119":{},"256":{},"417":{},"608":{},"609":{}}}],["uri",{"_index":97,"title":{"12":{}},"description":{"12":{}}}],["uri-encod",{"_index":689,"title":{},"description":{"224":{}}}],["url",{"_index":90,"title":{"10":{},"11":{},"31":{},"34":{},"214":{},"566":{}},"description":{"10":{},"11":{},"31":{},"34":{},"38":{},"129":{},"204":{},"214":{},"222":{},"381":{},"429":{},"573":{},"608":{},"609":{},"663":{}}}],["url_authti",{"_index":1040,"title":{},"description":{"378":{},"379":{},"380":{}}}],["us",{"_index":50,"title":{"143":{},"167":{},"177":{},"306":{},"368":{},"402":{}},"description":{"6":{},"8":{},"9":{},"45":{},"46":{},"58":{},"59":{},"66":{},"69":{},"70":{},"76":{},"78":{},"83":{},"117":{},"118":{},"119":{},"126":{},"128":{},"129":{},"135":{},"143":{},"167":{},"177":{},"196":{},"209":{},"223":{},"224":{},"230":{},"234":{},"236":{},"238":{},"249":{},"257":{},"258":{},"261":{},"266":{},"269":{},"274":{},"284":{},"288":{},"293":{},"294":{},"295":{},"296":{},"298":{},"306":{},"313":{},"329":{},"340":{},"341":{},"348":{},"363":{},"378":{},"379":{},"380":{},"381":{},"392":{},"402":{},"415":{},"417":{},"429":{},"430":{},"480":{},"507":{},"514":{},"523":{},"528":{},"534":{},"546":{},"555":{},"556":{},"563":{},"566":{},"567":{},"573":{},"577":{},"578":{},"587":{},"589":{},"591":{},"595":{},"596":{},"597":{},"608":{},"609":{},"613":{},"616":{},"620":{},"621":{},"643":{},"644":{},"645":{},"646":{},"648":{},"679":{}}}],["usag",{"_index":272,"title":{"71":{},"72":{},"234":{},"236":{},"238":{},"314":{},"388":{},"534":{}},"description":{"71":{},"72":{},"314":{},"388":{}}}],["user",{"_index":64,"title":{"16":{},"21":{},"87":{},"88":{},"89":{},"90":{},"91":{},"92":{},"93":{},"94":{},"95":{},"96":{},"97":{},"98":{},"99":{},"100":{},"101":{},"102":{},"103":{},"104":{},"144":{},"147":{},"148":{},"379":{},"381":{},"450":{},"451":{},"452":{},"454":{},"455":{},"457":{},"458":{},"459":{},"460":{},"486":{},"522":{},"524":{},"525":{},"526":{},"527":{},"529":{},"530":{},"564":{}},"description":{"8":{},"9":{},"16":{},"24":{},"34":{},"38":{},"72":{},"78":{},"87":{},"88":{},"89":{},"90":{},"91":{},"92":{},"95":{},"96":{},"97":{},"98":{},"99":{},"101":{},"102":{},"103":{},"104":{},"113":{},"144":{},"147":{},"148":{},"204":{},"207":{},"208":{},"209":{},"210":{},"222":{},"293":{},"306":{},"309":{},"344":{},"378":{},"379":{},"380":{},"381":{},"424":{},"431":{},"436":{},"444":{},"450":{},"451":{},"452":{},"455":{},"456":{},"469":{},"480":{},"486":{},"487":{},"488":{},"509":{},"511":{},"514":{},"518":{},"522":{},"523":{},"524":{},"525":{},"526":{},"527":{},"528":{},"529":{},"531":{},"542":{},"561":{},"564":{},"620":{},"621":{},"672":{},"678":{},"679":{}}}],["user'",{"_index":135,"title":{"122":{},"222":{},"327":{},"328":{},"621":{},"643":{},"645":{},"646":{}},"description":{"22":{},"53":{},"66":{},"108":{},"112":{},"122":{},"133":{},"293":{},"294":{},"295":{},"296":{},"307":{},"311":{},"329":{},"411":{},"454":{},"457":{},"458":{},"459":{},"460":{},"485":{},"487":{},"488":{},"530":{},"555":{},"556":{},"643":{},"644":{},"645":{},"646":{},"654":{},"665":{},"667":{},"674":{},"676":{},"678":{},"679":{}}}],["user's](https://go.cpanel.net/manage-team",{"_index":133,"title":{},"description":{"21":{}}}],["user+newmailbox@example.com",{"_index":834,"title":{},"description":{"283":{},"284":{}}}],["user-ent",{"_index":1672,"title":{},"description":{"679":{}}}],["userdata",{"_index":139,"title":{},"description":{"24":{}}}],["usermanager/change_password",{"_index":227,"title":{},"description":{"55":{}}}],["usermanager/check_account_conflict",{"_index":291,"title":{},"description":{"77":{}}}],["usermanager/create_us",{"_index":277,"title":{},"description":{"75":{}}}],["usermanager/delete_us",{"_index":286,"title":{},"description":{"76":{}}}],["usermanager/dismiss_merg",{"_index":303,"title":{},"description":{"78":{}}}],["usermanager/edit_us",{"_index":306,"title":{},"description":{"80":{}}}],["usermanager/list_us",{"_index":320,"title":{},"description":{"84":{}}}],["usermanager/lookup_service_account",{"_index":304,"title":{},"description":{"79":{}}}],["usermanager/lookup_us",{"_index":309,"title":{},"description":{"81":{}}}],["usermanager/merge_service_account",{"_index":319,"title":{},"description":{"83":{}}}],["usermanager/unlink_service_account",{"_index":312,"title":{},"description":{"82":{}}}],["usermanager::create_us",{"_index":686,"title":{},"description":{"224":{}}}],["usernam",{"_index":280,"title":{"456":{},"528":{},"531":{}},"description":{"76":{},"77":{},"83":{},"207":{},"208":{},"209":{},"210":{},"453":{},"678":{},"679":{}}}],["username/databas",{"_index":1223,"title":{"444":{}},"description":{}}],["usertasks/delet",{"_index":87,"title":{},"description":{"8":{}}}],["usertasks/retriev",{"_index":89,"title":{},"description":{"9":{}}}],["user’",{"_index":581,"title":{},"description":{"181":{},"184":{},"585":{}}}],["usr/local/cpanel/3rdparty/share/site_templ",{"_index":1667,"title":{},"description":{"678":{},"679":{}}}],["usr/local/cpanel/logs/error_log",{"_index":1678,"title":{},"description":{"679":{}}}],["usr/local/cpanel/scripts/modify_account",{"_index":474,"title":{},"description":{"136":{},"137":{}}}],["utf-8",{"_index":900,"title":{"306":{},"307":{}},"description":{"306":{},"412":{}}}],["utf-8-encod",{"_index":903,"title":{},"description":{"307":{}}}],["val1",{"_index":796,"title":{},"description":{"269":{}}}],["val2",{"_index":803,"title":{},"description":{"269":{}}}],["valid",{"_index":177,"title":{"35":{},"50":{},"62":{},"191":{},"194":{},"198":{},"199":{},"201":{},"252":{},"437":{},"462":{},"540":{}},"description":{"35":{},"38":{},"41":{},"191":{},"194":{},"199":{},"381":{},"412":{},"424":{},"426":{},"462":{},"584":{},"600":{},"611":{},"612":{},"613":{}}}],["valu",{"_index":263,"title":{"171":{},"348":{}},"description":{"69":{},"70":{},"77":{},"153":{},"161":{},"171":{},"208":{},"222":{},"224":{},"348":{},"378":{},"379":{},"380":{},"429":{},"477":{},"655":{}}}],["var",{"_index":1187,"title":{},"description":{"431":{}}}],["var/cpanel/customizations/site_templ",{"_index":1665,"title":{},"description":{"678":{},"679":{}}}],["var/cpanel/userdata/user/domain",{"_index":644,"title":{},"description":{"207":{},"209":{},"210":{}}}],["var/cpanel/userdata/username/main",{"_index":649,"title":{},"description":{"208":{}}}],["vari",{"_index":190,"title":{},"description":{"38":{}}}],["variabl",{"_index":1058,"title":{},"description":{"381":{}}}],["variables/get_server_inform",{"_index":1431,"title":{},"description":{"546":{}}}],["variables/get_session_inform",{"_index":1426,"title":{},"description":{"543":{}}}],["variables/get_user_inform",{"_index":225,"title":{},"description":{"53":{}}}],["verifi",{"_index":749,"title":{"513":{},"610":{},"611":{},"612":{},"613":{}},"description":{"252":{},"507":{},"513":{},"546":{},"561":{},"610":{}}}],["version",{"_index":73,"title":{"433":{},"508":{},"650":{},"652":{},"657":{},"658":{}},"description":{"8":{},"9":{},"129":{},"428":{},"429":{},"430":{},"431":{},"508":{},"523":{},"626":{},"649":{},"650":{},"652":{},"657":{},"658":{},"672":{}}}],["version'",{"_index":1621,"title":{"648":{}},"description":{"648":{}}}],["versioncontrol/cr",{"_index":1169,"title":{},"description":{"428":{}}}],["versioncontrol/delet",{"_index":1179,"title":{},"description":{"430":{}}}],["versioncontrol/retriev",{"_index":1191,"title":{},"description":{"431":{}}}],["versioncontrol/upd",{"_index":1173,"title":{},"description":{"429":{}}}],["versioncontrol::cr",{"_index":81,"title":{},"description":{"8":{},"9":{}}}],["versioncontroldeployment/cr",{"_index":1159,"title":{},"description":{"424":{}}}],["versioncontroldeployment/delet",{"_index":1160,"title":{},"description":{"425":{}}}],["versioncontroldeployment/retriev",{"_index":1161,"title":{},"description":{"426":{}}}],["vhost",{"_index":1445,"title":{},"description":{"555":{},"556":{},"658":{}}}],["via",{"_index":80,"title":{"106":{},"107":{},"109":{},"611":{},"612":{}},"description":{"8":{},"9":{},"106":{},"107":{},"109":{},"257":{},"258":{},"381":{},"412":{},"611":{},"612":{}}}],["view",{"_index":1343,"title":{},"description":{"507":{}}}],["virtual",{"_index":673,"title":{"218":{},"219":{},"651":{},"656":{},"657":{},"658":{}},"description":{"218":{},"219":{},"555":{},"556":{},"651":{},"653":{},"654":{},"656":{},"657":{},"658":{}}}],["viru",{"_index":1255,"title":{"465":{},"466":{},"468":{}},"description":{"465":{},"466":{},"467":{},"468":{},"469":{},"470":{}}}],["virus",{"_index":1278,"title":{"469":{}},"description":{}}],["visual",{"_index":442,"title":{},"description":{"126":{}}}],["want",{"_index":615,"title":{},"description":{"196":{},"465":{},"466":{},"467":{},"468":{},"469":{},"470":{},"523":{}}}],["warn",{"_index":567,"title":{},"description":{"175":{},"195":{},"430":{},"442":{},"528":{},"555":{},"556":{},"563":{},"587":{},"588":{},"589":{},"591":{},"592":{},"613":{},"616":{}}}],["web",{"_index":146,"title":{"128":{},"129":{},"419":{},"420":{},"421":{},"422":{},"543":{},"590":{},"660":{},"661":{},"662":{},"670":{},"671":{},"672":{}},"description":{"26":{},"27":{},"83":{},"129":{},"203":{},"205":{},"212":{},"213":{},"215":{},"217":{},"419":{},"420":{},"421":{},"422":{},"543":{},"555":{},"556":{},"558":{},"560":{},"561":{},"562":{},"563":{},"564":{},"567":{},"569":{},"570":{},"575":{},"579":{},"580":{},"581":{},"582":{},"587":{},"589":{},"590":{},"594":{},"595":{},"596":{},"597":{},"598":{},"599":{},"600":{},"601":{},"602":{},"603":{},"604":{},"605":{},"606":{},"607":{},"608":{},"609":{},"620":{},"621":{},"624":{},"627":{},"628":{},"629":{},"630":{},"631":{},"632":{},"633":{},"634":{},"640":{},"647":{},"652":{},"655":{},"658":{},"660":{},"663":{},"670":{},"672":{},"678":{},"680":{}}}],["webdisk",{"_index":1132,"title":{"418":{}},"description":{"418":{},"578":{}}}],["webdisk/delete_us",{"_index":1133,"title":{},"description":{"419":{}}}],["webdisk/set_homedir",{"_index":1136,"title":{},"description":{"421":{}}}],["webdisk/set_password",{"_index":1134,"title":{},"description":{"420":{}}}],["webdisk/set_permiss",{"_index":1137,"title":{},"description":{"422":{}}}],["weblog",{"_index":1579,"title":{"619":{},"620":{},"621":{}},"description":{"619":{}}}],["webmail",{"_index":681,"title":{"242":{},"307":{},"375":{},"376":{},"377":{},"378":{},"379":{},"380":{}},"description":{"222":{},"242":{},"307":{},"375":{},"376":{},"377":{},"378":{},"379":{},"380":{},"381":{},"472":{},"473":{},"474":{},"558":{},"560":{},"561":{},"562":{},"563":{},"564":{},"567":{},"569":{},"570":{},"573":{},"575":{},"578":{},"579":{},"580":{},"581":{},"582":{},"587":{},"589":{},"590":{},"591":{},"594":{},"595":{},"596":{},"597":{},"598":{},"599":{},"600":{},"601":{},"602":{},"603":{},"604":{},"605":{},"606":{},"607":{},"608":{},"609":{}}}],["webmail](https://go.cpanel.net/webmailinterfac",{"_index":1037,"title":{},"description":{"378":{},"379":{},"380":{}}}],["webmailapps/list_webmail_app",{"_index":1029,"title":{},"description":{"376":{}}}],["webserv",{"_index":641,"title":{},"description":{"204":{},"405":{},"406":{},"407":{},"408":{},"578":{},"600":{},"620":{},"621":{},"636":{},"637":{},"638":{},"639":{},"641":{},"648":{},"649":{},"650":{},"651":{},"653":{},"654":{},"656":{},"657":{},"661":{},"662":{},"671":{}}}],["websit",{"_index":1505,"title":{"604":{},"679":{},"680":{}},"description":{"578":{},"604":{},"659":{},"664":{},"669":{},"673":{},"675":{},"677":{},"679":{},"680":{}}}],["webvhosts/list_domain",{"_index":674,"title":{},"description":{"219":{}}}],["webvhosts/list_ssl_capable_domain",{"_index":679,"title":{},"description":{"220":{}}}],["welcom",{"_index":1067,"title":{"387":{},"393":{}},"description":{"387":{},"393":{}}}],["whether",{"_index":119,"title":{"47":{},"60":{},"143":{},"152":{},"158":{},"160":{},"165":{},"289":{},"331":{},"368":{},"385":{},"402":{},"473":{},"476":{},"477":{},"561":{},"566":{},"568":{},"589":{},"590":{}},"description":{"16":{},"47":{},"50":{},"60":{},"62":{},"143":{},"152":{},"153":{},"158":{},"160":{},"161":{},"165":{},"282":{},"288":{},"289":{},"306":{},"331":{},"368":{},"385":{},"395":{},"396":{},"402":{},"473":{},"476":{},"477":{},"502":{},"540":{},"561":{},"566":{},"568":{},"589":{},"590":{},"611":{},"612":{},"613":{},"640":{},"678":{},"679":{}}}],["whitelist",{"_index":1012,"title":{},"description":{"363":{}}}],["whm",{"_index":258,"title":{},"description":{"69":{},"70":{},"286":{},"381":{},"417":{},"428":{},"429":{},"430":{},"431":{},"442":{},"546":{},"655":{}}}],["whm'",{"_index":847,"title":{},"description":{"286":{},"465":{},"616":{}}}],["wildcard",{"_index":1390,"title":{},"description":{"523":{}}}],["wish",{"_index":1514,"title":{},"description":{"584":{}}}],["within",{"_index":289,"title":{},"description":{"77":{},"222":{},"430":{},"679":{}}}],["without",{"_index":997,"title":{"528":{}},"description":{"354":{},"359":{},"444":{}}}],["wordpress",{"_index":1322,"title":{"494":{},"495":{},"496":{},"497":{},"498":{},"499":{},"500":{},"501":{},"502":{},"503":{},"504":{},"505":{},"507":{},"508":{},"509":{},"511":{},"512":{},"513":{},"514":{},"515":{},"674":{},"676":{}},"description":{"494":{},"495":{},"496":{},"497":{},"498":{},"499":{},"500":{},"501":{},"502":{},"503":{},"504":{},"505":{},"506":{},"507":{},"508":{},"509":{},"510":{},"511":{},"512":{},"513":{},"514":{},"515":{},"674":{},"676":{}}}],["wordpress.org",{"_index":1353,"title":{"510":{}},"description":{"510":{}}}],["wordpressbackup/any_run",{"_index":1325,"title":{},"description":{"496":{}}}],["wordpressbackup/cancel",{"_index":1324,"title":{},"description":{"495":{}}}],["wordpressbackup/cleanup",{"_index":1327,"title":{},"description":{"497":{}}}],["wordpressbackup/get_available_backup",{"_index":1328,"title":{},"description":{"498":{}}}],["wordpressbackup/is_run",{"_index":1329,"title":{},"description":{"499":{}}}],["wordpressbackup/start",{"_index":1330,"title":{},"description":{"500":{}}}],["wordpressinstancemanager/cancel_scan",{"_index":1377,"title":{},"description":{"515":{}}}],["wordpressinstancemanager/change_admin_password",{"_index":1336,"title":{},"description":{"505":{}}}],["wordpressinstancemanager/cleanup_scan",{"_index":1338,"title":{},"description":{"506":{}}}],["wordpressinstancemanager/configure_autoupd",{"_index":1345,"title":{},"description":{"507":{}}}],["wordpressinstancemanager/get_api_vers",{"_index":1347,"title":{},"description":{"508":{}}}],["wordpressinstancemanager/get_inst",{"_index":1351,"title":{},"description":{"509":{}}}],["wordpressinstancemanager/get_instance_by_id",{"_index":1355,"title":{},"description":{"511":{}}}],["wordpressinstancemanager/get_latest_wordpress_version_from_wordpress_org",{"_index":1354,"title":{},"description":{"510":{}}}],["wordpressinstancemanager/get_scan_result",{"_index":1356,"title":{},"description":{"512":{}}}],["wordpressinstancemanager/is_installable_addon_avail",{"_index":1357,"title":{},"description":{"513":{}}}],["wordpressinstancemanager/start_scan",{"_index":1376,"title":{},"description":{"514":{}}}],["wordpressinstancemanager::start_scan",{"_index":1337,"title":{},"description":{"506":{},"512":{},"515":{}}}],["wordpressrestore/any_run",{"_index":1333,"title":{},"description":{"502":{}}}],["wordpressrestore/cleanup",{"_index":1335,"title":{},"description":{"503":{}}}],["wordpressrestore/start",{"_index":1331,"title":{},"description":{"501":{}}}],["wordpresssite/cr",{"_index":1662,"title":{},"description":{"676":{}}}],["wordpresssite/retriev",{"_index":1661,"title":{},"description":{"674":{}}}],["work",{"_index":452,"title":{},"description":{"128":{},"222":{},"378":{},"424":{},"426":{}}}],["wp-config.php",{"_index":1341,"title":{},"description":{"507":{}}}],["yaml.gz",{"_index":784,"title":{},"description":{"267":{}}}],["zone",{"_index":515,"title":{"155":{},"156":{},"157":{},"163":{},"164":{}},"description":{"154":{},"155":{},"156":{},"157":{},"162":{},"163":{},"164":{},"176":{}}}]],"pipeline":[]}},"options":{"labels":{"enum":"Possible Values"},"theme":{"spacing":{"unit":3},"colors":{"tonalOffset":0.5,"primary":{"main":"black"},"http":{"get":"#85B655","post":"#179BD7"},"success":{"main":"#85B655"}},"typography":{"fontSize":"16px","fontFamily":"Open Sans Light, open sans, sans-serif","headings":{"fontFamily":"Montserrat Medium, sans-serif"}},"logo":{"gutter":"10px"}},"requiredPropsFirst":true,"sortPropsAlphabetically":true,"expandResponses":"200","jsonSampleExpandLevel":"all","hideDownloadButton":true,"noAutoAuth":true,"showExtensions":false,"showConsole":false,"nativeScrollbars":true}};

var container = document.getElementById('redoc');
      Redoc.hydrate(__redoc_state, container);

</script>
</body>

</html>

Back to Directory File Manager